neulab/tldr huggingface dataset:
interface certbot.interfaces.IAuthenticator Extends: certbot.interfaces.IPlugin
Generic Certbot Authenticator.
Class represents all possible tools processes that have the ability to perform challenges and attain a certificate.
get_chall_pref(domain) Return collections.Iterable of challenge preferences.
Parameters domain (str) -- Domain for which challenge preferences are sought.
Returns collections.Iterable of challenge types (subclasses of acme.challenges.Challenge) with the most preferred challenges first. If a type is not specified, it means the Authenticator cannot perform the challenge.
Return type collections.Iterable
perform(achalls) Perform the given challenge.
Parameters achalls (list) -- Non-empty (guaranteed) list of AnnotatedChallenge instances, such that it contains types found within get_chall_pref() only.
Returns collections.Iterable of ACME ChallengeResponse instances corresponding to each provided Challenge.
Return type collections.Iterable of acme.challenges.ChallengeResponse, where responses are required to be returned in the same order as corresponding input challenges
Raises PluginError -- If some or all challenges cannot be performed
cleanup(achalls) Revert changes and shutdown after challenges complete.
This method should be able to revert all changes made by perform, even if perform exited abnormally.
Parameters achalls (list) -- Non-empty (guaranteed) list of AnnotatedChallenge instances, a subset of those previously passed to perform().
Raises PluginError -- if original configuration cannot be restored
interface certbot.interfaces.IConfig Certbot user-supplied configuration.
WARNING: The values stored in the configuration have not been filtered, stripped or sanitized.
server ACME Directory Resource URI.
email  Email used for registration and recovery contact. Use comma to register multiple emails, ex: u1@example.com,u2@example.com. (default: Ask).
rsa_key_size Size of the RSA key.
elliptic_curve The SECG elliptic curve name to use. Please see RFC 8446 for supported values.
key_type Type of generated private key(Only ONE per invocation can be provided at this time)
must_staple Adds the OCSP Must Staple extension to the certificate. Autoconfigures OCSP Stapling for supported setups (Apache version >= 2.3.3 ).
config_dir Configuration directory.
work_dir Working directory.
accounts_dir Directory where all account information is stored.
backup_dir Configuration backups directory.
csr_dir Directory where newly generated Certificate Signing Requests (CSRs) are saved.
in_progress_dir Directory used before a permanent checkpoint is finalized.
key_dir Keys storage.
temp_checkpoint_dir Temporary checkpoint directory.
no_verify_ssl Disable verification of the ACME server's certificate.
http01_port Port used in the http-01 challenge. This only affects the port Certbot listens on. A conforming ACME server will still attempt to connect on port 80.
http01_address The address the server listens to during http-01 challenge.
https_port Port used to serve HTTPS. This affects which port Nginx will listen on after a LE certificate is installed.
pref_challs Sorted user specified preferred challengestype strings with the most preferred challenge listed first
allow_subset_of_names When performing domain validation, do not consider it a failure if authorizations can not be obtained for a strict subset of the requested domains. This may be useful for allowing renewals for multiple domains to succeed even if some domains no longer point at this system. This is a boolean
strict_permissions Require that all configuration files are owned by the current user; only needed if your config is somewhere unsafe like /tmp/.This is a boolean
disable_renew_updates If updates provided by installer enhancements when Certbot is being run with "renew" verb should be disabled.
preferred_chain If the CA offers multiple certificate chains, prefer the chain with an issuer matching this Subject Common Name. If no match, the default offered chain will be used.
interface certbot.interfaces.IInstaller Extends: certbot.interfaces.IPlugin
Generic Certbot Installer Interface.
Represents any server that an X509 certificate can be placed.
It is assumed that save() is the only method that finalizes a checkpoint. This is important to ensure that checkpoints are restored in a consistent manner if requested by the user or in case of an error.
Using certbot.reverter.Reverter to implement checkpoints, rollback, and recovery can dramatically simplify plugin development.
get_all_names() Returns all names that may be authenticated.
Return type collections.Iterable of str
deploy_cert(domain, cert_path, key_path, chain_path, fullchain_path) Deploy certificate.
• domain (str) -- domain to deploy certificate file
• cert_path (str) -- absolute path to the certificate file
• key_path (str) -- absolute path to the private key file
• chain_path (str) -- absolute path to the certificate chain file
• fullchain_path (str) -- absolute path to the certificate fullchain file (cert plus chain)
Raises PluginError -- when cert cannot be deployed
enhance(domain, enhancement, options=None) Perform a configuration enhancement.
• domain (str) -- domain for which to provide enhancement
• enhancement (str) -- An enhancement as defined in ENHANCEMENTS
• options -- Flexible options parameter for enhancement.  Check documentation of ENHANCEMENTS for expected options for each enhancement.
Raises PluginError -- If Enhancement is not supported, or if an error occurs during the enhancement.
supported_enhancements() Returns a collections.Iterable of supported enhancements.
Returns supported enhancements which should be a subset of ENHANCEMENTS
save(title=None, temporary=False) Saves all changes to the configuration files.
Both title and temporary are needed because a save may be intended to be permanent, but the save is not ready to be a full checkpoint.
It is assumed that at most one checkpoint is finalized by this method. Additionally, if an exception is raised, it is assumed a new checkpoint was not finalized.
• title (str) -- The title of the save. If a title is given, the configuration will be saved as a new checkpoint and put in a timestamped directory. title has no effect if temporary is true.
• temporary (bool) -- Indicates whether the changes made will be quickly reversed in the future (challenges)
Raises PluginError -- when save is unsuccessful
rollback_checkpoints(rollback=1) Revert rollback number of configuration checkpoints.
Raises PluginError -- when configuration cannot be fully reverted
recovery_routine() Revert configuration to most recent finalized checkpoint.
Remove all changes (temporary and permanent) that have not been finalized. This is useful to protect against crashes and other execution interruptions.
config_test() Make sure the configuration is valid.
Raises MisconfigurationError -- when the config is not in a usable state
restart() Restart or refresh the server content.
Raises PluginError -- when server cannot be restarted
interface certbot.interfaces.IDisplay Generic display.
notification(message, pause, wrap=True, force_interactive=False) Displays a string message
• pause (bool) -- Whether or not the application should pause for confirmation (if available)
menu(message, choices, ok_label=None, cancel_label=None, help_label=None, default=None, cli_flag=None, force_interactive=False) Displays a generic menu.
When not setting force_interactive=True, you must provide a default value.
• message (str) -- message to display
• choices (list of tuple() or str) -- choices
• ok_label (str) -- label for OK button (UNUSED)
• cancel_label (str) -- label for Cancel button (UNUSED)
• help_label (str) -- label for Help button (UNUSED)
• default (int) -- default (non-interactive) choice from the menu
• cli_flag (str) -- to automate choice from the menu, eg "--keep"
Raises errors.MissingCommandlineFlag -- if called in non-interactive mode without a default set
input(message, default=None, cli_args=None, force_interactive=False) Accept input from the user.
• default (str) -- default (non-interactive) response to prompt
yesno(message, yes_label='Yes', no_label='No', default=None, cli_args=None, force_interactive=False) Query the user with a yes/no question.
Yes and No label must begin with different letters.
• default (str) -- default (non-interactive) choice from the menu
• cli_flag (str) -- to automate choice from the menu, eg "--redirect / --no-redirect"
checklist(message, tags, default=None, cli_args=None, force_interactive=False) Allow for multiple selections from a menu.
• tags (list) -- where each is of type str len(tags) > 0
• default (str) -- default (non-interactive) state of the checklist
• cli_flag (str) -- to automate choice from the menu, eg "--domains"
Returns tuple of the form (code, list_tags) where code - int display exit code list_tags - list of str tags selected by the user
directory_select(self, message, default=None, cli_flag=None, force_interactive=False) Display a directory selection screen.
• default -- the default value to return, if one exists, when using the NoninteractiveDisplay
• cli_flag (str) -- option used to set this value with the CLI, if one exists, to be included in error messages given by NoninteractiveDisplay
interface certbot.interfaces.IReporter Interface to collect and display information to the user.
HIGH_PRIORITY Used to denote high priority messages
MEDIUM_PRIORITY Used to denote medium priority messages
LOW_PRIORITY Used to denote low priority messages
add_message(self, msg, priority, on_crash=True) Adds msg to the list of messages to be printed.
• msg (str) -- Message to be displayed to the user.
• priority (int) -- One of HIGH_PRIORITY, MEDIUM_PRIORITY, or LOW_PRIORITY.
• on_crash (bool) -- Whether or not the message should be printed if the program exits abnormally.
print_messages(self) Prints messages to the user and clears the message queue.
class certbot.interfaces.RenewableCert Bases: object
Interface to a certificate lineage.
abstract property cert_path Path to the certificate file.
abstract property key_path Path to the private key file.
abstract property chain_path Path to the certificate chain file.
abstract property fullchain_path Path to the full chain file.
The full chain is the certificate file plus the chain file.
abstract property lineagename Name given to the certificate lineage.
abstract names() What are the subject names of this certificate?
Returns the subject names
Raises CertStorageError -- if could not find cert file.
class certbot.interfaces.GenericUpdater Bases: object
Interface for update types not currently specified by Certbot.
This class allows plugins to perform types of updates that Certbot hasn't defined (yet).
To make use of this interface, the installer should implement the interface methods, and interfaces.GenericUpdater.register(InstallerClass) should be called from the installer code.
The plugins implementing this enhancement are responsible of handling the saving of configuration checkpoints as well as other calls to interface methods of interfaces.IInstaller such as prepare() and restart()
abstract generic_updates(lineage, *args, **kwargs) Perform any update types defined by the installer.
If an installer is a subclass of the class containing this method, this function will always be called when "certbot renew" is run. If the update defined by the installer should be run conditionally, the installer needs to handle checking the conditions itself.
This method is called once for each lineage.
Parameters lineage (RenewableCert) -- Certificate lineage object
class certbot.interfaces.RenewDeployer Bases: object
Interface for update types run when a lineage is renewed
This class allows plugins to perform types of updates that need to run at lineage renewal that Certbot hasn't defined (yet).
To make use of this interface, the installer should implement the interface methods, and interfaces.RenewDeployer.register(InstallerClass) should be called from the installer code.
abstract renew_deploy(lineage, *args, **kwargs) Perform updates defined by installer when a certificate has been renewed
If an installer is a subclass of the class containing this method, this function will always be called when a certficate has been renewed by running "certbot renew". For example if a plugin needs to copy a certificate over, or change configuration based on the new certificate.
This method is called once for each lineage renewed
certbot.main module Certbot main public entry point.
certbot.main.main(cli_args=None) Run Certbot.
Parameters cli_args (list of str) -- command line to Certbot, defaults to sys.argv[1:]
Returns value for sys.exit about the exit status of Certbot
Return type str or int or None
certbot.ocsp package Tools for checking certificate revocation.
class certbot.ocsp.RevocationChecker(enforce_openssl_binary_usage=False) Bases: object
This class figures out OCSP checking on this system, and performs it.
ocsp_revoked(cert) Get revoked status for a particular cert version.
Parameters cert (interfaces.RenewableCert) -- Certificate object
Returns True if revoked; False if valid or the check failed or cert is expired.
ocsp_revoked_by_paths(cert_path, chain_path, timeout=10) Performs the OCSP revocation check
• cert_path (str) -- Certificate filepath
• chain_path (str) -- Certificate chain
• timeout (int) -- Timeout (in seconds) for the OCSP query
certbot.reverter module Reverter class saves configuration checkpoints and allows for recovery.
class certbot.reverter.Reverter(config) Bases: object
Reverter Class - save and revert configuration checkpoints.
This class can be used by the plugins, especially Installers, to undo changes made to the user's system. Modifications to files and commands to do undo actions taken by the plugin should be registered with this class before the action is taken.
Once a change has been registered with this class, there are three states the change can be in. First, the change can be a temporary change. This should be used for changes that will soon be reverted, such as config changes for the purpose of solving a challenge.  Changes are added to this state through calls to add_to_temp_checkpoint() and reverted when revert_temporary_config() or recovery_routine() is called.
The second state a change can be in is in progress. These changes are not temporary, however, they also have not been finalized in a checkpoint. A change must become in progress before it can be finalized. Changes are added to this state through calls to add_to_checkpoint() and reverted when recovery_routine() is called.
The last state a change can be in is finalized in a checkpoint. A change is put into this state by first becoming an in progress change and then calling finalize_checkpoint(). Changes in this state can be reverted through calls to rollback_checkpoints().
As a final note, creating new files and registering undo commands are handled specially and use the methods register_file_creation() and register_undo_command() respectively. Both of these methods can be used to create either temporary or in progress changes.
NOTE: Consider moving everything over to CSV format.
revert_temporary_config() Reload users original configuration files after a temporary save.
This function should reinstall the users original configuration files for all saves with temporary=True
Raises ReverterError -- when unable to revert config
rollback_checkpoints(rollback=1) Revert 'rollback' number of configuration checkpoints.
Parameters rollback (int) -- Number of checkpoints to reverse. A str num will be cast to an integer. So "2" is also acceptable.
Raises ReverterError -- if there is a problem with the input or if the function is unable to correctly revert the configuration checkpoints
add_to_temp_checkpoint(save_files, save_notes) Add files to temporary checkpoint.
add_to_checkpoint(save_files, save_notes) Add files to a permanent checkpoint.
register_file_creation(temporary, *files) Register the creation of all files during certbot execution.
Call this method before writing to the file to make sure that the file will be cleaned up if the program exits unexpectedly.  (Before a save occurs)
• temporary (bool) -- If the file creation registry is for a temp or permanent save.
• *files -- file paths (str) to be registered
Raises certbot.errors.ReverterError -- If call does not contain necessary parameters or if the file creation is unable to be registered.
register_undo_command(temporary, command) Register a command to be run to undo actions taken.
WARNING: This function does not enforce order of operations in terms of file modification vs. command registration. All undo commands are run first before all normal files are reverted to their previous state.  If you need to maintain strict order, you may create checkpoints before and after the the command registration. This function may be improved in the future based on demand.
• temporary (bool) -- Whether the command should be saved in the IN_PROGRESS or TEMPORARY checkpoints.
• command (list of str) -- Command to be run.
Raises errors.ReverterError -- If unable to recover the configuration
finalize_checkpoint(title) Finalize the checkpoint.
Timestamps and permanently saves all changes made through the use of add_to_checkpoint() and register_file_creation()
Raises certbot.errors.ReverterError -- when the checkpoint is not able to be finalized.
certbot.util module Utilities for all Certbot.
class certbot.util.Key(file, pem) Bases: tuple
property file Alias for field number 0
property pem Alias for field number 1
class certbot.util.CSR(file, data, form) Bases: tuple
property data Alias for field number 1
property form Alias for field number 2
certbot.util.env_no_snap_for_external_calls() When Certbot is run inside a Snap, certain environment variables are modified. But Certbot sometimes calls out to external programs, since it uses classic confinement. When we do that, we must modify the env to remove our modifications so it will use the system's libraries, since they may be incompatible with the versions of libraries included in the Snap. For example, apachectl, Nginx, and anything run from inside a hook should call this function and pass the results into the env argument of subprocess.Popen.
Returns A modified copy of os.environ ready to pass to Popen
Return type dict
certbot.util.run_script(params, log=<bound method Logger.error of <Logger certbot.util (WARNING)>>) Run the script with the given params.
• params (list) -- List of parameters to pass to Popen
• log (callable) -- Logger method to use for errors
certbot.util.exe_exists(exe) Determine whether path/name refers to an executable.
Parameters exe (str) -- Executable path or name
Returns If exe is a valid executable
certbot.util.lock_dir_until_exit(dir_path) Lock the directory at dir_path until program exit.
Parameters dir_path (str) -- path to directory
Raises errors.LockError -- if the lock is held by another process
certbot.util.set_up_core_dir(directory, mode, strict) Ensure directory exists with proper permissions and is locked.
• directory (str) -- Path to a directory.
• mode (int) -- Directory mode.
• strict (bool) -- require directory to be owned by current user
• errors.LockError -- if the directory cannot be locked
• errors.Error -- if the directory cannot be made or verified
certbot.util.make_or_verify_dir(directory, mode=493, strict=False) Make sure directory exists with proper permissions.
• errors.Error -- if a directory already exists, but has wrong permissions or owner
• OSError -- if invalid or inaccessible file names and paths, or other arguments that have the correct type, but are not accepted by the operating system.
certbot.util.safe_open(path, mode='w', chmod=None) Safely open a file.
• path (str) -- Path to a file.
• mode (str) -- Same os mode for open.
• chmod (int) -- Same as mode for filesystem.open, uses Python defaults if None.
certbot.util.unique_file(path, chmod=511, mode='w') Safely finds a unique file.
• path (str) -- path/filename.ext
• chmod (int) -- File mode
• mode (str) -- Open mode
Returns tuple of file object and file name
certbot.util.unique_lineage_name(path, filename, chmod=420, mode='w') Safely finds a unique file using lineage convention.
• path (str) -- directory path
• filename (str) -- proposed filename
• chmod (int) -- file mode
• mode (str) -- open mode
Returns tuple of file object and file name (which may be modified from the requested one by appending digits to ensure uniqueness)
Raises OSError -- if writing files fails for an unanticipated reason, such as a full disk or a lack of permission to write to specified location.
certbot.util.safely_remove(path) Remove a file that may not exist.
certbot.util.get_filtered_names(all_names) Removes names that aren't considered valid by Let's Encrypt.
Parameters all_names (set) -- all names found in the configuration
Returns all found names that are considered valid by LE
Return type set
certbot.util.get_os_info() Get OS name and version
Returns (os_name, os_version)
Return type tuple of str
certbot.util.get_os_info_ua() Get OS name and version string for User Agent
Returns os_ua
certbot.util.get_systemd_os_like() Get a list of strings that indicate the distribution likeness to other distributions.
Returns List of distribution acronyms
certbot.util.get_var_from_file(varname, filepath='/etc/os-release') Get single value from a file formatted like systemd /etc/os-release
• varname (str) -- Name of variable to fetch
• filepath (str) -- File path of os-release file
Returns requested value
certbot.util.get_python_os_info(pretty=False) Get Operating System type/distribution and major version using python platform module
Parameters pretty (bool) -- If the returned OS name should be in longer (pretty) form
certbot.util.safe_email(email) Scrub email address before using it.
class certbot.util.DeprecatedArgumentAction(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None) Bases: argparse.Action
Action to log a warning when an argument is used.
certbot.util.add_deprecated_argument(add_argument, argument_name, nargs) Adds a deprecated argument with the name argument_name.
Deprecated arguments are not shown in the help. If they are used on the command line, a warning is shown stating that the argument is deprecated and no other action is taken.
• add_argument (callable) -- Function that adds arguments to an argument parser/group.
• argument_name (str) -- Name of deprecated argument.
• nargs -- Value for nargs when adding the argument to argparse.
certbot.util.enforce_le_validity(domain) Checks that Let's Encrypt will consider domain to be valid.
Parameters domain (str or unicode) -- FQDN to check
Returns The domain cast to str, with ASCII-only contents
Raises ConfigurationError -- for invalid domains and cases where Let's Encrypt currently will not issue certificates
certbot.util.enforce_domain_sanity(domain) Method which validates domain value and errors out if the requirements are not met.
Parameters domain (str or unicode) -- Domain to check
certbot.util.is_wildcard_domain(domain) "Is domain a wildcard domain?
Parameters domain (bytes or str or unicode) -- domain to check
Returns True if domain is a wildcard, otherwise, False
certbot.util.get_strict_version(normalized) Converts a normalized version to a strict version.
Parameters normalized (str) -- normalized version string
Returns An equivalent strict version
Return type distutils.version.StrictVersion
certbot.util.is_staging(srv) Determine whether a given ACME server is a known test / staging server.
Parameters srv (str) -- the URI for the ACME server
Returns True iff srv is a known test / staging server
Rtype bool
certbot.util.atexit_register(func, *args, **kwargs) Sets func to be called before the program exits.
Special care is taken to ensure func is only called when the process that first imports this module exits rather than any child processes.
Parameters func (function) -- function to be called in case of an error
• genindex
convert(1)                   General Commands Manual                  convert(1)
convert - convert between image formats as well as resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample, and much more.
convert [input-options] input-file [output-options] output-file
The convert program is a member of the ImageMagick(1) suite of tools. Use it to convert between image formats as well as resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample, and much more.
For more information about the convert command, point your browser to file:///usr/share/doc/ImageMagick-7/www/convert.html or http://imagemagick.org/script/convert.php.
Image Channel Operators: -channel-fx expression exchange, extract, or transfer one or more image channels -separate            separate an image channel into a grayscale image
Image Sequence Operators: -append              append an image sequence top to bottom (use +append for left to right) -clut                apply a color lookup table to the image -coalesce            merge a sequence of images -combine             combine a sequence of images -compare             mathematically and visually annotate the difference between an image and its reconstruction -complex operator    perform complex mathematics on an image sequence -composite           composite image -copy geometry offset, copy pixels from one area of an image to another -crop geometry       cut out a rectangular region of the image -deconstruct         break down an image sequence into constituent parts -evaluate-sequence operator evaluate an arithmetic, relational, or logical expression -flatten             flatten a sequence of images -fx expression       apply mathematical expression to an image channel(s) -hald-clut           apply a Hald color lookup table to the image -morph value         morph an image sequence -mosaic              create a mosaic from an image sequence -poly terms          build a polynomial from the image sequence and the corresponding terms (coefficients and degree pairs) -process arguments   process the image with a custom image filter -smush geometry      smush an image sequence together -write filename      write images to this file
Image Stack Operators: -clone indexes       clone an image -delete indexes      delete the image from the image sequence -duplicate count,indexes duplicate an image one or more times -insert index        insert last image into the image sequence -reverse             reverse image sequence -swap indexes        swap two images in the image sequence
Miscellaneous Options: -debug events        display copious debugging information -distribute-cache port distributed pixel cache spanning one or more servers -help                print program options -log format          format of debugging information -list type           print a list of supported option arguments -version             print version information
Use any setting or operator as an output-option.  Only a limited number of setting are  input-option. They include: -antialias, -caption, -density, -define, -encoding, -font, -pointsize, -size, and -texture as well as any of the miscellaneous options.
HTOP(1)                           User Commands                          HTOP(1)
htop, pcp-htop - interactive process viewer
htop [-dCFhpustvH] pcp htop [-dCFhpustvH] [--host/-h host]
htop is a cross-platform ncurses-based process viewer.
It is similar to top, but allows you to scroll vertically and horizontally, and interact using a pointing device (mouse).  You can observe all processes running on the system, along with their command line arguments, as well as view them in a tree format, select multiple processes and act on them all at once.
Tasks related to processes (killing, renicing) can be done without entering their PIDs.
pcp-htop is a version of htop built using the Performance Co-Pilot (PCP) Metrics API (see PCPIntro(1), PMAPI(3)), allowing to extend htop to display values from arbitrary metrics.  See the section below titled CONFIG FILES for further details.
COMMAND-LINE OPTIONS Mandatory arguments to long options are mandatory for short options too.
-d --delay=DELAY Delay between updates, in tenths of a second. If the delay value is less than 1, it is increased to 1, i.e. 1/10 second. If the delay value is greater than 100, it is decreased to 100, i.e. 10 seconds.
-C --no-color --no-colour Start htop in monochrome mode
-F --filter=FILTER Filter processes by command
-h --help Display a help message and exit
-p --pid=PID,PID... Show only the given PIDs
-s --sort-key COLUMN Sort by this column (use --sort-key help for a column list).  This will force a list view unless you specify -t at the same time.
-u --user=USERNAME|UID Show only the processes of a given user
-U --no-unicode Do not use unicode but ASCII characters for graph meters
-M --no-mouse Disable support of mouse control
--readonly Disable all system and process changing features
-V --version Output version information and exit
-t --tree Show processes in tree view. This can be used to force a tree view when requesting a sort order with -s.
-H --highlight-changes=DELAY Highlight new and old processes
--drop-capabilities[=off|basic|strict] Linux only; requires libcap support. Drop unneeded Linux capabilities.  In strict mode features like killing, changing process priorities, and reading process delay accounting information will not work, due to less capabilities held.
The following commands are supported while in htop:
Up, Alt-k Select (highlight) the previous process in the process list. Scroll the list if necessary.
Down, Alt-j Select (highlight) the next process in the process list. Scroll the list if necessary.
Left, Alt-h Scroll the process list left.
Right, Alt-l Scroll the process list right.
PgUp, PgDn Scroll the process list up or down one window.
Home Scroll to the top of the process list and select the first process.
End  Scroll to the bottom of the process list and select the last process.
Ctrl-A, ^ Scroll left to the beginning of the process entry (i.e. beginning of line).
Ctrl-E, $ Scroll right to the end of the process entry (i.e. end of line).
Space Tag or untag a process. Commands that can operate on multiple processes, like "kill", will then apply over the list of tagged processes, instead of the currently highlighted one.
c    Tag the current process and its children. Commands that can operate on multiple processes, like "kill", will then apply over the list of tagged processes, instead of the currently highlighted one.
U    Untag all processes (remove all tags added with the Space or c keys).
s    Trace process system calls: if strace(1) is installed, pressing this key will attach it to the currently selected process, presenting a live update of system calls issued by the process.
l    Display open files for a process: if lsof(1) is installed, pressing this key will display the list of file descriptors opened by the process.
w    Display the command line of the selected process in a separate screen, wrapped onto multiple lines as needed.
x    Display the active file locks of the selected process in a separate screen.
F1, h, ? Go to the help screen
F2, S Go to the setup screen, where you can configure the meters displayed at the top of the screen, set various display options, choose among color schemes, and select which columns are displayed, in which order.
F3, / Incrementally search the command lines of all the displayed processes. The currently selected (highlighted) command will update as you type. While in search mode, pressing F3 will cycle through matching occurrences.  Pressing Shift-F3 will cycle backwards.
Alternatively the search can be started by simply typing the command you are looking for, although for the first character normal key bindings take precedence.
F4, \ Incremental process filtering: type in part of a process command line and only processes whose names match will be shown. To cancel filtering, enter the Filter option again and press Esc.
F5, t Tree view: organize processes by parenthood, and layout the relations between them as a tree. Toggling the key will switch between tree and your previously selected sort view. Selecting a sort view will exit tree view.
F6, <, > Selects a field for sorting, also accessible through < and >.  The current sort field is indicated by a highlight in the header.
F7, ] Increase the selected process's priority (subtract from 'nice' value).  This can only be done by the superuser.
F8, [ Decrease the selected process's priority (add to 'nice' value)
Shift-F7, } Increase the selected process's autogroup priority (subtract from autogroup 'nice' value).  This can only be done by the superuser.
Shift-F8, { Decrease the selected process's autogroup priority (add to autogroup 'nice' value)
F9, k "Kill" process: sends a signal which is selected in a menu, to one or a group of processes. If processes were tagged, sends the signal to all tagged processes.  If none is tagged, sends to the currently selected process.
F10, q Quit
I    Invert the sort order: if sort order is increasing, switch to decreasing, and vice-versa.
+, -, * When in tree view mode, expand or collapse subtree. When a subtree is collapsed a "+" sign shows to the left of the process name. Pressing "*" will expand or collapse all children of PIDs without parents, so typically PID 1 (init) and PID 2 (kthreadd on Linux, if kernel threads are shown).
a (on multiprocessor machines) Set CPU affinity: mark which CPUs a process is allowed to use.
u    Show only processes owned by a specified user.
N    Sort by PID.
M    Sort by memory usage (top compatibility key).
P    Sort by processor usage (top compatibility key).
T    Sort by time (top compatibility key).
F    "Follow" process: if the sort order causes the currently selected process to move in the list, make the selection bar follow it. This is useful for monitoring a process: this way, you can keep a process always visible on screen. When a movement key is used, "follow" loses effect.
K    Hide kernel threads: prevent the threads belonging the kernel to be displayed in the process list. (This is a toggle key.)
H    Hide user threads: on systems that represent them differently than ordinary processes (such as recent NPTL-based systems), this can hide threads from userspace processes in the process list. (This is a toggle key.)
p    Show full paths to running programs, where applicable. (This is a toggle key.)
Z    Pause/resume process updates.
m    Merge exe, comm and cmdline, where applicable. (This is a toggle key.)
Ctrl-L Refresh: redraw screen and recalculate values.
Numbers PID search: type in process ID and the selection highlight will be moved to it.
The following columns can display data about each process. A value of '-' in all the rows indicates that a column is unsupported on your system, or currently unimplemented in htop.  The names below are the ones used in the "Available Columns" section of the setup screen. If a different name is shown in htop's main screen, it is shown below in parenthesis.
Command The full command line of the process (i.e. program name and arguments).
If the option 'Merge exe, comm and cmdline in Command' (toggled by the 'm' key) is active, the executable path (/proc/[pid]/exe) and the command name (/proc/[pid]/comm) are also shown merged with the command line, if available.
The program basename is highlighted if set in the configuration. Additional highlighting can be configured for stale executables (cf. EXE column below).
COMM The command name of the process obtained from /proc/[pid]/comm, if readable.
EXE  The abbreviated basename of the executable of the process, obtained from /proc/[pid]/exe, if readable. htop is able to read this file on linux for ALL the processes only if it has the capability CAP_SYS_PTRACE or root privileges.
The basename is marked in red if the executable used to run the process has been replaced or deleted on disk since the process started. The information is obtained by processing the contents of /proc/[pid]/exe.
Furthermore the basename is marked in yellow if any library is reported as having been replaced or deleted on disk since it was last loaded. The information is obtained by processing the contents of /proc/[pid]/maps.
When deciding the color the replacement of the main executable always takes precedence over replacement of any other library. If only the memory map indicates a replacement of the main executable, this will show as if any other library had been replaced or deleted.
This additional color markup can be configured in the "Display Options" section of the setup screen.
PID  The process ID.
STATE (S) The state of the process: S for sleeping (idle) R for running D for disk sleep (uninterruptible) Z for zombie (waiting for parent to read its exit status) T for traced or suspended (e.g by SIGTSTP) W for paging
PPID The parent process ID.
PGRP The process's group ID.
SESSION (SID) The process's session ID.
TTY  The controlling terminal of the process.
TPGID The process ID of the foreground process group of the controlling terminal.
MINFLT The number of page faults happening in the main memory.
CMINFLT The number of minor faults for the process's waited-for children (see MINFLT above).
MAJFLT The number of page faults happening out of the main memory.
CMAJFLT The number of major faults for the process's waited-for children (see MAJFLT above).
UTIME (UTIME+) The user CPU time, which is the amount of time the process has spent executing on the CPU in user mode (i.e. everything but system calls), measured in clock ticks.
STIME (STIME+) The system CPU time, which is the amount of time the kernel has spent executing system calls on behalf of the process, measured in clock ticks.
CUTIME (CUTIME+) The children's user CPU time, which is the amount of time the process's waited-for children have spent executing in user mode (see UTIME above).
CSTIME (CSTIME+) The children's system CPU time, which is the amount of time the kernel has spent executing system calls on behalf of all the process's waited-for children (see STIME above).
PRIORITY (PRI) The kernel's internal priority for the process, usually just its nice value plus twenty. Different for real-time processes.
NICE (NI) The nice value of a process, from 19 (low priority) to -20 (high priority). A high value means the process is being nice, letting others have a higher relative priority. The usual OS permission restrictions for adjusting priority apply.
STARTTIME (START) The time the process was started.
PROCESSOR (CPU) The ID of the CPU the process last executed on.
M_VIRT (VIRT) The size of the virtual memory of the process.
M_RESIDENT (RES) The resident set size (text + data + stack) of the process (i.e. the size of the process's used physical memory).
M_SHARE (SHR) The size of the process's shared pages.
M_TRS (CODE) The text resident set size of the process (i.e. the size of the process's executable instructions).
M_DRS (DATA) The data resident set size (data + stack) of the process (i.e. the size of anything except the process's executable instructions).
M_LRS (LIB) The library size of the process.
M_SWAP (SWAP) The size of the process's swapped pages.
M_PSS (PSS) The proportional set size, same as M_RESIDENT but each page is divided by the number of processes sharing it.
M_M_PSSWP (PSSWP) The proportional swap share of this mapping, unlike M_SWAP this does not take into account swapped out page of underlying shmem objects.
ST_UID (UID) The user ID of the process owner.
PERCENT_CPU (CPU%) The percentage of the CPU time that the process is currently using. This is the default way to represent CPU usage in Linux. Each process can consume up to 100% which means the full capacity of the core it is running on. This is sometimes called "Irix mode" e.g. in top(1).
PERCENT_NORM_CPU (NCPU%) The percentage of the CPU time that the process is currently using normalized by CPU count. This is sometimes called "Solaris mode" e.g. in top(1).
PERCENT_MEM (MEM%) The percentage of memory the process is currently using (based on the process's resident memory size, see M_RESIDENT above).
USER The username of the process owner, or the user ID if the name can't be determined.
TIME (TIME+) The time, measured in clock ticks that the process has spent in user and system time (see UTIME, STIME above).
NLWP The number of Light-Weight Processes (=threads) in the process.
TGID The thread group ID.
CTID OpenVZ container ID, a.k.a virtual environment ID.
VPID OpenVZ process ID.
VXID VServer process ID.
RCHAR (RD_CHAR) The number of bytes the process has read.
WCHAR (WR_CHAR) The number of bytes the process has written.
SYSCR (RD_SYSC) The number of read(2) syscalls for the process.
SYSCW (WR_SYSC) The number of write(2) syscalls for the process.
RBYTES (IO_RBYTES) Bytes of read(2) I/O for the process.
WBYTES (IO_WBYTES) Bytes of write(2) I/O for the process.
CNCLWB (IO_CANCEL) Bytes of cancelled write(2) I/O.
IO_READ_RATE (DISK READ) The I/O rate of read(2) in bytes per second, for the process.
IO_WRITE_RATE (DISK WRITE) The I/O rate of write(2) in bytes per second, for the process.
IO_RATE (DISK R/W) The I/O rate, IO_READ_RATE + IO_WRITE_RATE (see above).
CGROUP Which cgroup the process is in. For a shortened view see the CCGROUP column below.
CCGROUP Shortened view of the cgroup name that the process is in.  This performs some pattern-based replacements to shorten the displayed string and thus condense the information. /*.slice is shortened to /[*] (exceptions below) /system.slice is shortened to /[S] /user.slice is shortened to /[U] /user-*.slice is shortened to /[U:*] (directly preceeding /[U] before dropped) /machine.slice is shortened to /[M] /machine-*.scope is shortened to /[SNC:*] (SNC: systemd nspawn container), uppercase for the monitor /lxc.monitor.* is shortened to /[LXC:*] /lxc.payload.* is shortened to /[lxc:*] /*.scope is shortened to /!* /*.service is shortened to /* (suffix removed)
Encountered escape sequences (e.g. from systemd) inside the cgroup name are not decoded.
OOM  OOM killer score.
CTXT Incremental sum of voluntary and nonvoluntary context switches.
IO_PRIORITY (IO) The I/O scheduling class followed by the priority if the class supports it: R for Realtime B for Best-effort id for Idle
PERCENT_CPU_DELAY (CPUD%) The percentage of time spent waiting for a CPU (while runnable). Requires CAP_NET_ADMIN.
PERCENT_IO_DELAY (IOD%) The percentage of time spent waiting for the completion of synchronous block I/O. Requires CAP_NET_ADMIN.
PERCENT_SWAP_DELAY (SWAPD%) The percentage of time spent swapping in pages. Requires CAP_NET_ADMIN.
COMM The command name for the process. Requires Linux kernel 2.6.33 or newer.
EXE  The executable file of the process as reported by the kernel. Requires CAP_SYS_PTRACE and PTRACE_MODE_READ_FSCRED.
AGRP The autogroup identifier for the process. Requires Linux CFS to be enabled.
ANI  The autogroup nice value for the process autogroup. Requires Linux CFS to be enabled.
All other flags Currently unsupported (always displays '-').
While htop depends on most of the libraries it uses at build time there are two noteworthy exceptions to this rule. These exceptions both relate to data displayed in meters displayed in the header of htop and were intentionally created as optional runtime dependencies instead.  These exceptions are described below:
libsystemd The bindings for libsystemd are used in the SystemD meter to determine the number of active services and the overall system state. Looking for the functions to determine these information at runtime allows for builds to support these meters without forcing the package manager to install these libraries on systems that otherwise don't use systemd.
Summary: no build time dependency, optional runtime dependency on libsystemd via dynamic loading, with systemctl(1) fallback.
libsensors The bindings for libsensors are used for the CPU temperature readings in the CPU usage meters if displaying the temperature is enabled through the setup screen. In order for htop to show these temperatures correctly though, a proper configuration of libsensors through its usual configuration files is assumed and that all CPU cores correspond to temperature sensors from the coretemp driver with core 0 corresponding to a sensor labelled "Core 0". The package temperature may be given as "Package id 0". If missing it is inferred as the maximum value from the available per-core readings.
Summary: build time dependency on libsensors(3) C header files, optional runtime dependency on libsensors(3) via dynamic loading.
By default htop reads its configuration from the XDG-compliant path ~/.config/htop/htoprc.  The configuration file is overwritten by htop's in-program Setup configuration, so it should not be hand-edited.  If no user configuration exists htop tries to read the system-wide configuration from /etc/htoprc and as a last resort, falls back to its hard coded defaults.
You may override the location of the configuration file using the $HTOPRC environment variable (so you can have multiple configurations for different machines that share the same home directory, for example).
The pcp-htop utility makes use of htoprc in exactly the same way.  In addition, it supports additional configuration files allowing new meters and columns to be added to the display via the usual Setup function, which will display additional Available Meters and Available Column entries for each runtime configured meter or column.
These pcp-htop configuration files are read once at startup.  The format of these files is described in detail in the pcp-htop(5) manual page.
This functionality makes available many thousands of Performance Co-Pilot metrics for display by pcp-htop, as well as the ability to display custom metrics added at individual sites.  Applications and services instrumented using the OpenMetrics format https://openmetrics.io can also be displayed by pcp-htop if the pmdaopenmetrics(1) component is configured.
Memory sizes in htop are displayed in a human-readable form.  Sizes are printed in powers of 1024. (e.g., 1023M = 1072693248 Bytes)
The decision to use this convention was made in order to conserve screen space and make memory size representations consistent throughout htop.
proc(5), top(1), free(1), ps(1), uptime(1) and limits.conf(5).
pmdaopenmetrics(1), PCPIntro(1), PMAPI(3), and pcp-htop(5).
htop was originally developed by Hisham Muhammad.  Nowadays it is maintained by the community at <htop@groups.io>.
pcp-htop is maintained as a collaboration between the <htop@groups.io> and <pcp@groups.io> communities, and forms part of the Performance Co- Pilot suite of tools.
Copyright © 2004-2019 Hisham Muhammad. Copyright © 2020-2021 htop dev team.
License GPLv2+: GNU General Public License version 2 or, at your option, any later version.
This is free software: you are free to change and redistribute it.  There is NO WARRANTY, to the extent permitted by law.
goaccess(1)                       User Manuals                       goaccess(1)
goaccess - fast web log analyzer and interactive viewer.
goaccess [filename] [options...] [-c][-M][-H][-q][-d][...]
goaccess GoAccess is an open source real-time web log analyzer and interactive viewer that runs in a terminal in *nix systems or through your browser.
It provides fast and valuable HTTP statistics for system administrators that require a visual server report on the fly.
GoAccess parses the specified web log file and outputs the data to the X terminal. Features include:
General Statistics: This panel gives a summary of several metrics, such as the number of valid and invalid requests, time taken to analyze the dataset, unique visitors, requested files, static files (CSS, ICO, JPG, etc) HTTP referrers, 404s, size of the parsed log file and bandwidth consumption.
Unique visitors This panel shows metrics such as hits, unique visitors and cumulative bandwidth per date. HTTP requests containing the same IP, the same date, and the same user agent are considered a unique visitor. By default, it includes web crawlers/spiders.
Optionally, date specificity can be set to the hour level using --date-spec=hr which will display dates such as 05/Jun/2016:16. This is great if you want to track your daily traffic at the hour level.
Requested files This panel displays the most requested (non-static) files on your web server.  It shows hits, unique visitors, and percentage, along with the cumulative bandwidth, protocol, and the request method used.
Requested static files Lists the most frequently static files such as: JPG, CSS, SWF, JS, GIF, and PNG file types, along with the same metrics as the last panel. Additional static files can be added to the configuration file.