command
stringlengths 1
42
| description
stringlengths 29
182k
β | name
stringlengths 7
64.9k
β | synopsis
stringlengths 4
85.3k
β | options
stringclasses 593
values | examples
stringclasses 455
values |
|---|---|---|---|---|---|
ssl_server
| null | null | null | null | null |
tor-gencert
|
tor-gencert generates certificates and private keys for use by Tor directory authorities running the v3 Tor directory protocol, as used by Tor 0.2.0 and later. If you are not running a directory authority, you donβt need to use tor-gencert. Every directory authority has a long term authority identity key (which is distinct from the identity key it uses as a Tor server); this key should be kept offline in a secure location. It is used to certify shorter-lived signing keys, which are kept online and used by the directory authority to sign votes and consensus documents. After you use this program to generate a signing key and a certificate, copy those files to the keys subdirectory of your Tor process, and send Tor a SIGHUP signal. DO NOT COPY THE IDENTITY KEY.
|
tor-gencert - Generate certs and keys for Tor directory authorities
|
tor-gencert [-h|--help] [-v] [-r|--reuse] [--create-identity-key] [-i id_file] [-c cert_file] [-m num] [-a address:port]
|
-v Display verbose output. -h or --help Display help text and exit. -r or --reuse Generate a new certificate, but not a new signing key. This can be used to change the address or lifetime associated with a given key. --create-identity-key Generate a new identity key. You should only use this option the first time you run tor-gencert; in the future, you should use the identity key thatβs already there. -i FILENAME Read the identity key from the specified file. If the file is not present and --create-identity-key is provided, create the identity key in the specified file. Default: "./authority_identity_key" -s FILENAME Write the signing key to the specified file. Default: "./authority_signing_key" -c FILENAME Write the certificate to the specified file. Default: "./authority_certificate" -m NUM Number of months that the certificate should be valid. Default: 12. --passphrase-fd FILEDES Filedescriptor to read the passphrase from. Ends at the first NUL or newline. Default: read from the terminal. -a address:port If provided, advertise the address:port combination as this authorityβs preferred directory port in its certificate. If the address is a hostname, the hostname is resolved to an IP before itβs published. BUGS This probably doesnβt run on Windows. Thatβs not a big issue, since we donβt really want authorities to be running on Windows anyway. SEE ALSO tor(1) See also the "dir-spec.txt" file, distributed with Tor. AUTHOR Tor Project, Inc. Author. Tor 12/08/2023 TOR-GENCERT(1)
| null |
ptardiff
|
ptardiff is a small program that diffs an extracted archive against an unextracted one, using the perl module Archive::Tar. This effectively lets you view changes made to an archives contents. Provide the progam with an ARCHIVE_FILE and it will look up all the files with in the archive, scan the current working directory for a file with the name and diff it against the contents of the archive.
|
ptardiff - program that diffs an extracted archive against an unextracted one
|
ptardiff ARCHIVE_FILE ptardiff -h $ tar -xzf Acme-Buffy-1.3.tar.gz $ vi Acme-Buffy-1.3/README [...] $ ptardiff Acme-Buffy-1.3.tar.gz > README.patch
|
h Prints this help message SEE ALSO tar(1), Archive::Tar. perl v5.38.2 2023-11-28 PTARDIFF(1)
| null |
mysqld_multi
|
mysqld_multi is designed to manage several mysqld processes that listen for connections on different Unix socket files and TCP/IP ports. It can start or stop servers, or report their current status. Note For some Linux platforms, MySQL installation from RPM or Debian packages includes systemd support for managing MySQL server startup and shutdown. On these platforms, mysqld_multi is not installed because it is unnecessary. For information about using systemd to handle multiple MySQL instances, see Section 2.5.9, βManaging MySQL Server with systemdβ. mysqld_multi searches for groups named [mysqldN] in my.cnf (or in the file named by the --defaults-file option). N can be any positive integer. This number is referred to in the following discussion as the option group number, or GNR. Group numbers distinguish option groups from one another and are used as arguments to mysqld_multi to specify which servers you want to start, stop, or obtain a status report for. Options listed in these groups are the same that you would use in the [mysqld] group used for starting mysqld. (See, for example, Section 2.9.5, βStarting and Stopping MySQL Automaticallyβ.) However, when using multiple servers, it is necessary that each one use its own value for options such as the Unix socket file and TCP/IP port number. For more information on which options must be unique per server in a multiple-server environment, see Section 5.8, βRunning Multiple MySQL Instances on One Machineβ. To invoke mysqld_multi, use the following syntax: mysqld_multi [options] {start|stop|reload|report} [GNR[,GNR] ...] start, stop, reload (stop and restart), and report indicate which operation to perform. You can perform the designated operation for a single server or multiple servers, depending on the GNR list that follows the option name. If there is no list, mysqld_multi performs the operation for all servers in the option file. Each GNR value represents an option group number or range of group numbers. The value should be the number at the end of the group name in the option file. For example, the GNR for a group named [mysqld17] is 17. To specify a range of numbers, separate the first and last numbers by a dash. The GNR value 10-13 represents groups [mysqld10] through [mysqld13]. Multiple groups or group ranges can be specified on the command line, separated by commas. There must be no whitespace characters (spaces or tabs) in the GNR list; anything after a whitespace character is ignored. This command starts a single server using option group [mysqld17]: mysqld_multi start 17 This command stops several servers, using option groups [mysqld8] and [mysqld10] through [mysqld13]: mysqld_multi stop 8,10-13 For an example of how you might set up an option file, use this command: mysqld_multi --example mysqld_multi searches for option files as follows: β’ With --no-defaults, no option files are read. ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --no-defaults β ββββββββββββββββββββββΌββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββ€ βDefault Value β false β ββββββββββββββββββββββ΄ββββββββββββββββ β’ With --defaults-file=file_name, only the named file is read. ββββββββββββββββββββββ¬βββββββββββββββββββββββββββ βCommand-Line Format β --defaults-file=filename β ββββββββββββββββββββββΌβββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββ€ βDefault Value β [none] β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββ β’ Otherwise, option files in the standard list of locations are read, including any file named by the --defaults-extra-file=file_name option, if one is given. (If the option is given multiple times, the last value is used.) ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ βCommand-Line Format β --defaults-extra-file=filename β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βDefault Value β [none] β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ For additional information about these and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. Option files read are searched for [mysqld_multi] and [mysqldN] option groups. The [mysqld_multi] group can be used for options to mysqld_multi itself. [mysqldN] groups can be used for options passed to specific mysqld instances. The [mysqld] or [mysqld_safe] groups can be used for common options read by all instances of mysqld or mysqld_safe. You can specify a --defaults-file=file_name option to use a different configuration file for that instance, in which case the [mysqld] or [mysqld_safe] groups from that file are used for that instance. mysqld_multi supports the following options. β’ --help ββββββββββββββββββββββ¬ββββββββββ βCommand-Line Format β --help β ββββββββββββββββββββββΌββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββ€ βDefault Value β false β ββββββββββββββββββββββ΄ββββββββββ Display a help message and exit. β’ --example ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --example β ββββββββββββββββββββββΌββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββ€ βDefault Value β false β ββββββββββββββββββββββ΄ββββββββββββ Display a sample option file. β’ --log=file_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --log=path β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βDefault Value β /var/log/mysqld_multi.log β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ Specify the name of the log file. If the file exists, log output is appended to it. β’ --mysqladmin=prog_name ββββββββββββββββββββββ¬ββββββββββββββββββββ βCommand-Line Format β --mysqladmin=file β ββββββββββββββββββββββΌββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββΌββββββββββββββββββββ€ βDefault Value β [none] β ββββββββββββββββββββββ΄ββββββββββββββββββββ The mysqladmin binary to be used to stop servers. β’ --mysqld=prog_name ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --mysqld=file β ββββββββββββββββββββββΌββββββββββββββββ€ βType β File name β ββββββββββββββββββββββΌββββββββββββββββ€ βDefault Value β [none] β ββββββββββββββββββββββ΄ββββββββββββββββ The mysqld binary to be used. Note that you can specify mysqld_safe as the value for this option also. If you use mysqld_safe to start the server, you can include the mysqld or ledir options in the corresponding [mysqldN] option group. These options indicate the name of the server that mysqld_safe should start and the path name of the directory where the server is located. (See the descriptions for these options in mysqld_safe(1).) Example: [mysqld38] mysqld = mysqld-debug ledir = /opt/local/mysql/libexec β’ --no-log ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --no-log β ββββββββββββββββββββββΌβββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββ€ βDefault Value β false β ββββββββββββββββββββββ΄βββββββββββ Print log information to stdout rather than to the log file. By default, output goes to the log file. β’ --password=password ββββββββββββββββββββββ¬ββββββββββββββββββββ βCommand-Line Format β --password=string β ββββββββββββββββββββββΌββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌββββββββββββββββββββ€ βDefault Value β [none] β ββββββββββββββββββββββ΄ββββββββββββββββββββ The password of the MySQL account to use when invoking mysqladmin. Note that the password value is not optional for this option, unlike for other MySQL programs. β’ --silent ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --silent β ββββββββββββββββββββββΌβββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββ€ βDefault Value β false β ββββββββββββββββββββββ΄βββββββββββ Silent mode; disable warnings. β’ --tcp-ip ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --tcp-ip β ββββββββββββββββββββββΌβββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββ€ βDefault Value β false β ββββββββββββββββββββββ΄βββββββββββ Connect to each MySQL server through the TCP/IP port instead of the Unix socket file. (If a socket file is missing, the server might still be running, but accessible only through the TCP/IP port.) By default, connections are made using the Unix socket file. This option affects stop and report operations. β’ --user=user_name ββββββββββββββββββββββ¬ββββββββββββββ βCommand-Line Format β --user=name β ββββββββββββββββββββββΌββββββββββββββ€ βType β String β ββββββββββββββββββββββΌββββββββββββββ€ βDefault Value β root β ββββββββββββββββββββββ΄ββββββββββββββ The user name of the MySQL account to use when invoking mysqladmin. β’ --verbose ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --verbose β ββββββββββββββββββββββΌββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββ€ βDefault Value β false β ββββββββββββββββββββββ΄ββββββββββββ Be more verbose. β’ --version ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --version β ββββββββββββββββββββββΌββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββ€ βDefault Value β false β ββββββββββββββββββββββ΄ββββββββββββ Display version information and exit. Some notes about mysqld_multi: β’ Most important: Before using mysqld_multi be sure that you understand the meanings of the options that are passed to the mysqld servers and why you would want to have separate mysqld processes. Beware of the dangers of using multiple mysqld servers with the same data directory. Use separate data directories, unless you know what you are doing. Starting multiple servers with the same data directory does not give you extra performance in a threaded system. See Section 5.8, βRunning Multiple MySQL Instances on One Machineβ. Important Make sure that the data directory for each server is fully accessible to the Unix account that the specific mysqld process is started as. Do not use the Unix root account for this, unless you know what you are doing. See Section 6.1.5, βHow to Run MySQL as a Normal Userβ. β’ Make sure that the MySQL account used for stopping the mysqld servers (with the mysqladmin program) has the same user name and password for each server. Also, make sure that the account has the SHUTDOWN privilege. If the servers that you want to manage have different user names or passwords for the administrative accounts, you might want to create an account on each server that has the same user name and password. For example, you might set up a common multi_admin account by executing the following commands for each server: $> mysql -u root -S /tmp/mysql.sock -p Enter password: mysql> CREATE USER 'multi_admin'@'localhost' IDENTIFIED BY 'multipass'; mysql> GRANT SHUTDOWN ON *.* TO 'multi_admin'@'localhost'; See Section 6.2, βAccess Control and Account Managementβ. You have to do this for each mysqld server. Change the connection parameters appropriately when connecting to each one. Note that the host name part of the account name must permit you to connect as multi_admin from the host where you want to run mysqld_multi. β’ The Unix socket file and the TCP/IP port number must be different for every mysqld. (Alternatively, if the host has multiple network addresses, you can set the bind_address system variable to cause different servers to listen to different interfaces.) β’ The --pid-file option is very important if you are using mysqld_safe to start mysqld (for example, --mysqld=mysqld_safe) Every mysqld should have its own process ID file. The advantage of using mysqld_safe instead of mysqld is that mysqld_safe monitors its mysqld process and restarts it if the process terminates due to a signal sent using kill -9 or for other reasons, such as a segmentation fault. β’ You might want to use the --user option for mysqld, but to do this you need to run the mysqld_multi script as the Unix superuser (root). Having the option in the option file doesn't matter; you just get a warning if you are not the superuser and the mysqld processes are started under your own Unix account. The following example shows how you might set up an option file for use with mysqld_multi. The order in which the mysqld programs are started or stopped depends on the order in which they appear in the option file. Group numbers need not form an unbroken sequence. The first and fifth [mysqldN] groups were intentionally omitted from the example to illustrate that you can have βgapsβ in the option file. This gives you more flexibility. # This is an example of a my.cnf file for mysqld_multi. # Usually this file is located in home dir ~/.my.cnf or /etc/my.cnf [mysqld_multi] mysqld = /usr/local/mysql/bin/mysqld_safe mysqladmin = /usr/local/mysql/bin/mysqladmin user = multi_admin password = my_password [mysqld2] socket = /tmp/mysql.sock2 port = 3307 pid-file = /usr/local/mysql/data2/hostname.pid2 datadir = /usr/local/mysql/data2 language = /usr/local/mysql/share/mysql/english user = unix_user1 [mysqld3] mysqld = /path/to/mysqld_safe ledir = /path/to/mysqld-binary/ mysqladmin = /path/to/mysqladmin socket = /tmp/mysql.sock3 port = 3308 pid-file = /usr/local/mysql/data3/hostname.pid3 datadir = /usr/local/mysql/data3 language = /usr/local/mysql/share/mysql/swedish user = unix_user2 [mysqld4] socket = /tmp/mysql.sock4 port = 3309 pid-file = /usr/local/mysql/data4/hostname.pid4 datadir = /usr/local/mysql/data4 language = /usr/local/mysql/share/mysql/estonia user = unix_user3 [mysqld6] socket = /tmp/mysql.sock6 port = 3311 pid-file = /usr/local/mysql/data6/hostname.pid6 datadir = /usr/local/mysql/data6 language = /usr/local/mysql/share/mysql/japanese user = unix_user4 See Section 4.2.2.2, βUsing Option Filesβ. COPYRIGHT Copyright Β© 1997, 2023, Oracle and/or its affiliates. This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/. SEE ALSO For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/. AUTHOR Oracle Corporation (http://dev.mysql.com/). MySQL 8.3 11/23/2023 MYSQLD_MULTI(1)
|
mysqld_multi - manage multiple MySQL servers
|
mysqld_multi [options] {start|stop|report} [GNR[,GNR] ...]
| null | null |
gpt-engineer
| null | null | null | null | null |
gwho
|
Print information about users who are currently logged in. -a, --all same as -b -d --login -p -r -t -T -u -b, --boot time of last system boot -d, --dead print dead processes -H, --heading print line of column headings -l, --login print system login processes --lookup attempt to canonicalize hostnames via DNS -m only hostname and user associated with stdin -p, --process print active processes spawned by init -q, --count all login names and number of users logged on -r, --runlevel print current runlevel -s, --short print only name, line, and time (default) -t, --time print last system clock change -T, -w, --mesg add user's message status as +, - or ? -u, --users list users logged in --message same as -T --writable same as -T --help display this help and exit --version output version information and exit If FILE is not specified, use /var/run/utmpx. /var/log/wtmp as FILE is common. If ARG1 ARG2 given, -m presumed: 'am i' or 'mom likes' are usual. AUTHOR Written by Joseph Arceneaux, David MacKenzie, and Michael Stone. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO Full documentation <https://www.gnu.org/software/coreutils/who> or available locally via: info '(coreutils) who invocation' GNU coreutils 9.3 April 2023 WHO(1)
|
who - show who is logged on
|
who [OPTION]... [ FILE | ARG1 ARG2 ]
| null | null |
classifier_tester
| null | null | null | null | null |
gcut
|
Print selected parts of lines from each FILE to standard output. With no FILE, or when FILE is -, read standard input. Mandatory arguments to long options are mandatory for short options too. -b, --bytes=LIST select only these bytes -c, --characters=LIST select only these characters -d, --delimiter=DELIM use DELIM instead of TAB for field delimiter -f, --fields=LIST select only these fields; also print any line that contains no delimiter character, unless the -s option is specified -n (ignored) --complement complement the set of selected bytes, characters or fields -s, --only-delimited do not print lines not containing delimiters --output-delimiter=STRING use STRING as the output delimiter the default is to use the input delimiter -z, --zero-terminated line delimiter is NUL, not newline --help display this help and exit --version output version information and exit Use one, and only one of -b, -c or -f. Each LIST is made up of one range, or many ranges separated by commas. Selected input is written in the same order that it is read, and is written exactly once. Each range is one of: N N'th byte, character or field, counted from 1 N- from N'th byte, character or field, to end of line N-M from N'th to M'th (included) byte, character or field -M from first to M'th (included) byte, character or field AUTHOR Written by David M. Ihnat, David MacKenzie, and Jim Meyering. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO Full documentation <https://www.gnu.org/software/coreutils/cut> or available locally via: info '(coreutils) cut invocation' GNU coreutils 9.3 April 2023 CUT(1)
|
cut - remove sections from each line of files
|
cut OPTION... [FILE]...
| null | null |
exr2aces
| null | null | null | null | null |
pk11mode
| null | null | null | null | null |
req_app
| null | null | null | null | null |
xtractprotos
| null | null | null | null | null |
unlzma
|
xz is a general-purpose data compression tool with command line syntax similar to gzip(1) and bzip2(1). The native file format is the .xz format, but the legacy .lzma format used by LZMA Utils and raw compressed streams with no container format headers are also supported. In addition, decompression of the .lz format used by lzip is supported. xz compresses or decompresses each file according to the selected operation mode. If no files are given or file is -, xz reads from standard input and writes the processed data to standard output. xz will refuse (display an error and skip the file) to write compressed data to standard output if it is a terminal. Similarly, xz will refuse to read compressed data from standard input if it is a terminal. Unless --stdout is specified, files other than - are written to a new file whose name is derived from the source file name: β’ When compressing, the suffix of the target file format (.xz or .lzma) is appended to the source filename to get the target filename. β’ When decompressing, the .xz, .lzma, or .lz suffix is removed from the filename to get the target filename. xz also recognizes the suffixes .txz and .tlz, and replaces them with the .tar suffix. If the target file already exists, an error is displayed and the file is skipped. Unless writing to standard output, xz will display a warning and skip the file if any of the following applies: β’ File is not a regular file. Symbolic links are not followed, and thus they are not considered to be regular files. β’ File has more than one hard link. β’ File has setuid, setgid, or sticky bit set. β’ The operation mode is set to compress and the file already has a suffix of the target file format (.xz or .txz when compressing to the .xz format, and .lzma or .tlz when compressing to the .lzma format). β’ The operation mode is set to decompress and the file doesn't have a suffix of any of the supported file formats (.xz, .txz, .lzma, .tlz, or .lz). After successfully compressing or decompressing the file, xz copies the owner, group, permissions, access time, and modification time from the source file to the target file. If copying the group fails, the permissions are modified so that the target file doesn't become accessible to users who didn't have permission to access the source file. xz doesn't support copying other metadata like access control lists or extended attributes yet. Once the target file has been successfully closed, the source file is removed unless --keep was specified. The source file is never removed if the output is written to standard output or if an error occurs. Sending SIGINFO or SIGUSR1 to the xz process makes it print progress information to standard error. This has only limited use since when standard error is a terminal, using --verbose will display an automatically updating progress indicator. Memory usage The memory usage of xz varies from a few hundred kilobytes to several gigabytes depending on the compression settings. The settings used when compressing a file determine the memory requirements of the decompressor. Typically the decompressor needs 5 % to 20 % of the amount of memory that the compressor needed when creating the file. For example, decompressing a file created with xz -9 currently requires 65 MiB of memory. Still, it is possible to have .xz files that require several gigabytes of memory to decompress. Especially users of older systems may find the possibility of very large memory usage annoying. To prevent uncomfortable surprises, xz has a built-in memory usage limiter, which is disabled by default. While some operating systems provide ways to limit the memory usage of processes, relying on it wasn't deemed to be flexible enough (for example, using ulimit(1) to limit virtual memory tends to cripple mmap(2)). The memory usage limiter can be enabled with the command line option --memlimit=limit. Often it is more convenient to enable the limiter by default by setting the environment variable XZ_DEFAULTS, for example, XZ_DEFAULTS=--memlimit=150MiB. It is possible to set the limits separately for compression and decompression by using --memlimit-compress=limit and --memlimit-decompress=limit. Using these two options outside XZ_DEFAULTS is rarely useful because a single run of xz cannot do both compression and decompression and --memlimit=limit (or -M limit) is shorter to type on the command line. If the specified memory usage limit is exceeded when decompressing, xz will display an error and decompressing the file will fail. If the limit is exceeded when compressing, xz will try to scale the settings down so that the limit is no longer exceeded (except when using --format=raw or --no-adjust). This way the operation won't fail unless the limit is very small. The scaling of the settings is done in steps that don't match the compression level presets, for example, if the limit is only slightly less than the amount required for xz -9, the settings will be scaled down only a little, not all the way down to xz -8. Concatenation and padding with .xz files It is possible to concatenate .xz files as is. xz will decompress such files as if they were a single .xz file. It is possible to insert padding between the concatenated parts or after the last part. The padding must consist of null bytes and the size of the padding must be a multiple of four bytes. This can be useful, for example, if the .xz file is stored on a medium that measures file sizes in 512-byte blocks. Concatenation and padding are not allowed with .lzma files or raw streams.
|
xz, unxz, xzcat, lzma, unlzma, lzcat - Compress or decompress .xz and .lzma files
|
xz [option...] [file...] COMMAND ALIASES unxz is equivalent to xz --decompress. xzcat is equivalent to xz --decompress --stdout. lzma is equivalent to xz --format=lzma. unlzma is equivalent to xz --format=lzma --decompress. lzcat is equivalent to xz --format=lzma --decompress --stdout. When writing scripts that need to decompress files, it is recommended to always use the name xz with appropriate arguments (xz -d or xz -dc) instead of the names unxz and xzcat.
|
Integer suffixes and special values In most places where an integer argument is expected, an optional suffix is supported to easily indicate large integers. There must be no space between the integer and the suffix. KiB Multiply the integer by 1,024 (2^10). Ki, k, kB, K, and KB are accepted as synonyms for KiB. MiB Multiply the integer by 1,048,576 (2^20). Mi, m, M, and MB are accepted as synonyms for MiB. GiB Multiply the integer by 1,073,741,824 (2^30). Gi, g, G, and GB are accepted as synonyms for GiB. The special value max can be used to indicate the maximum integer value supported by the option. Operation mode If multiple operation mode options are given, the last one takes effect. -z, --compress Compress. This is the default operation mode when no operation mode option is specified and no other operation mode is implied from the command name (for example, unxz implies --decompress). -d, --decompress, --uncompress Decompress. -t, --test Test the integrity of compressed files. This option is equivalent to --decompress --stdout except that the decompressed data is discarded instead of being written to standard output. No files are created or removed. -l, --list Print information about compressed files. No uncompressed output is produced, and no files are created or removed. In list mode, the program cannot read the compressed data from standard input or from other unseekable sources. The default listing shows basic information about files, one file per line. To get more detailed information, use also the --verbose option. For even more information, use --verbose twice, but note that this may be slow, because getting all the extra information requires many seeks. The width of verbose output exceeds 80 characters, so piping the output to, for example, less -S may be convenient if the terminal isn't wide enough. The exact output may vary between xz versions and different locales. For machine-readable output, --robot --list should be used. Operation modifiers -k, --keep Don't delete the input files. Since xz 5.2.6, this option also makes xz compress or decompress even if the input is a symbolic link to a regular file, has more than one hard link, or has the setuid, setgid, or sticky bit set. The setuid, setgid, and sticky bits are not copied to the target file. In earlier versions this was only done with --force. -f, --force This option has several effects: β’ If the target file already exists, delete it before compressing or decompressing. β’ Compress or decompress even if the input is a symbolic link to a regular file, has more than one hard link, or has the setuid, setgid, or sticky bit set. The setuid, setgid, and sticky bits are not copied to the target file. β’ When used with --decompress --stdout and xz cannot recognize the type of the source file, copy the source file as is to standard output. This allows xzcat --force to be used like cat(1) for files that have not been compressed with xz. Note that in future, xz might support new compressed file formats, which may make xz decompress more types of files instead of copying them as is to standard output. --format=format can be used to restrict xz to decompress only a single file format. -c, --stdout, --to-stdout Write the compressed or decompressed data to standard output instead of a file. This implies --keep. --single-stream Decompress only the first .xz stream, and silently ignore possible remaining input data following the stream. Normally such trailing garbage makes xz display an error. xz never decompresses more than one stream from .lzma files or raw streams, but this option still makes xz ignore the possible trailing data after the .lzma file or raw stream. This option has no effect if the operation mode is not --decompress or --test. --no-sparse Disable creation of sparse files. By default, if decompressing into a regular file, xz tries to make the file sparse if the decompressed data contains long sequences of binary zeros. It also works when writing to standard output as long as standard output is connected to a regular file and certain additional conditions are met to make it safe. Creating sparse files may save disk space and speed up the decompression by reducing the amount of disk I/O. -S .suf, --suffix=.suf When compressing, use .suf as the suffix for the target file instead of .xz or .lzma. If not writing to standard output and the source file already has the suffix .suf, a warning is displayed and the file is skipped. When decompressing, recognize files with the suffix .suf in addition to files with the .xz, .txz, .lzma, .tlz, or .lz suffix. If the source file has the suffix .suf, the suffix is removed to get the target filename. When compressing or decompressing raw streams (--format=raw), the suffix must always be specified unless writing to standard output, because there is no default suffix for raw streams. --files[=file] Read the filenames to process from file; if file is omitted, filenames are read from standard input. Filenames must be terminated with the newline character. A dash (-) is taken as a regular filename; it doesn't mean standard input. If filenames are given also as command line arguments, they are processed before the filenames read from file. --files0[=file] This is identical to --files[=file] except that each filename must be terminated with the null character. Basic file format and compression options -F format, --format=format Specify the file format to compress or decompress: auto This is the default. When compressing, auto is equivalent to xz. When decompressing, the format of the input file is automatically detected. Note that raw streams (created with --format=raw) cannot be auto- detected. xz Compress to the .xz file format, or accept only .xz files when decompressing. lzma, alone Compress to the legacy .lzma file format, or accept only .lzma files when decompressing. The alternative name alone is provided for backwards compatibility with LZMA Utils. lzip Accept only .lz files when decompressing. Compression is not supported. The .lz format version 0 and the unextended version 1 are supported. Version 0 files were produced by lzip 1.3 and older. Such files aren't common but may be found from file archives as a few source packages were released in this format. People might have old personal files in this format too. Decompression support for the format version 0 was removed in lzip 1.18. lzip 1.4 and later create files in the format version 1. The sync flush marker extension to the format version 1 was added in lzip 1.6. This extension is rarely used and isn't supported by xz (diagnosed as corrupt input). raw Compress or uncompress a raw stream (no headers). This is meant for advanced users only. To decode raw streams, you need use --format=raw and explicitly specify the filter chain, which normally would have been stored in the container headers. -C check, --check=check Specify the type of the integrity check. The check is calculated from the uncompressed data and stored in the .xz file. This option has an effect only when compressing into the .xz format; the .lzma format doesn't support integrity checks. The integrity check (if any) is verified when the .xz file is decompressed. Supported check types: none Don't calculate an integrity check at all. This is usually a bad idea. This can be useful when integrity of the data is verified by other means anyway. crc32 Calculate CRC32 using the polynomial from IEEE-802.3 (Ethernet). crc64 Calculate CRC64 using the polynomial from ECMA-182. This is the default, since it is slightly better than CRC32 at detecting damaged files and the speed difference is negligible. sha256 Calculate SHA-256. This is somewhat slower than CRC32 and CRC64. Integrity of the .xz headers is always verified with CRC32. It is not possible to change or disable it. --ignore-check Don't verify the integrity check of the compressed data when decompressing. The CRC32 values in the .xz headers will still be verified normally. Do not use this option unless you know what you are doing. Possible reasons to use this option: β’ Trying to recover data from a corrupt .xz file. β’ Speeding up decompression. This matters mostly with SHA-256 or with files that have compressed extremely well. It's recommended to not use this option for this purpose unless the file integrity is verified externally in some other way. -0 ... -9 Select a compression preset level. The default is -6. If multiple preset levels are specified, the last one takes effect. If a custom filter chain was already specified, setting a compression preset level clears the custom filter chain. The differences between the presets are more significant than with gzip(1) and bzip2(1). The selected compression settings determine the memory requirements of the decompressor, thus using a too high preset level might make it painful to decompress the file on an old system with little RAM. Specifically, it's not a good idea to blindly use -9 for everything like it often is with gzip(1) and bzip2(1). -0 ... -3 These are somewhat fast presets. -0 is sometimes faster than gzip -9 while compressing much better. The higher ones often have speed comparable to bzip2(1) with comparable or better compression ratio, although the results depend a lot on the type of data being compressed. -4 ... -6 Good to very good compression while keeping decompressor memory usage reasonable even for old systems. -6 is the default, which is usually a good choice for distributing files that need to be decompressible even on systems with only 16 MiB RAM. (-5e or -6e may be worth considering too. See --extreme.) -7 ... -9 These are like -6 but with higher compressor and decompressor memory requirements. These are useful only when compressing files bigger than 8 MiB, 16 MiB, and 32 MiB, respectively. On the same hardware, the decompression speed is approximately a constant number of bytes of compressed data per second. In other words, the better the compression, the faster the decompression will usually be. This also means that the amount of uncompressed output produced per second can vary a lot. The following table summarises the features of the presets: Preset DictSize CompCPU CompMem DecMem -0 256 KiB 0 3 MiB 1 MiB -1 1 MiB 1 9 MiB 2 MiB -2 2 MiB 2 17 MiB 3 MiB -3 4 MiB 3 32 MiB 5 MiB -4 4 MiB 4 48 MiB 5 MiB -5 8 MiB 5 94 MiB 9 MiB -6 8 MiB 6 94 MiB 9 MiB -7 16 MiB 6 186 MiB 17 MiB -8 32 MiB 6 370 MiB 33 MiB -9 64 MiB 6 674 MiB 65 MiB Column descriptions: β’ DictSize is the LZMA2 dictionary size. It is waste of memory to use a dictionary bigger than the size of the uncompressed file. This is why it is good to avoid using the presets -7 ... -9 when there's no real need for them. At -6 and lower, the amount of memory wasted is usually low enough to not matter. β’ CompCPU is a simplified representation of the LZMA2 settings that affect compression speed. The dictionary size affects speed too, so while CompCPU is the same for levels -6 ... -9, higher levels still tend to be a little slower. To get even slower and thus possibly better compression, see --extreme. β’ CompMem contains the compressor memory requirements in the single-threaded mode. It may vary slightly between xz versions. β’ DecMem contains the decompressor memory requirements. That is, the compression settings determine the memory requirements of the decompressor. The exact decompressor memory usage is slightly more than the LZMA2 dictionary size, but the values in the table have been rounded up to the next full MiB. Memory requirements of the multi-threaded mode are significantly higher than that of the single-threaded mode. With the default value of --block-size, each thread needs 3*3*DictSize plus CompMem or DecMem. For example, four threads with preset -6 needs 660β670 MiB of memory. -e, --extreme Use a slower variant of the selected compression preset level (-0 ... -9) to hopefully get a little bit better compression ratio, but with bad luck this can also make it worse. Decompressor memory usage is not affected, but compressor memory usage increases a little at preset levels -0 ... -3. Since there are two presets with dictionary sizes 4 MiB and 8 MiB, the presets -3e and -5e use slightly faster settings (lower CompCPU) than -4e and -6e, respectively. That way no two presets are identical. Preset DictSize CompCPU CompMem DecMem -0e 256 KiB 8 4 MiB 1 MiB -1e 1 MiB 8 13 MiB 2 MiB -2e 2 MiB 8 25 MiB 3 MiB -3e 4 MiB 7 48 MiB 5 MiB -4e 4 MiB 8 48 MiB 5 MiB -5e 8 MiB 7 94 MiB 9 MiB -6e 8 MiB 8 94 MiB 9 MiB -7e 16 MiB 8 186 MiB 17 MiB -8e 32 MiB 8 370 MiB 33 MiB -9e 64 MiB 8 674 MiB 65 MiB For example, there are a total of four presets that use 8 MiB dictionary, whose order from the fastest to the slowest is -5, -6, -5e, and -6e. --fast --best These are somewhat misleading aliases for -0 and -9, respectively. These are provided only for backwards compatibility with LZMA Utils. Avoid using these options. --block-size=size When compressing to the .xz format, split the input data into blocks of size bytes. The blocks are compressed independently from each other, which helps with multi-threading and makes limited random-access decompression possible. This option is typically used to override the default block size in multi- threaded mode, but this option can be used in single-threaded mode too. In multi-threaded mode about three times size bytes will be allocated in each thread for buffering input and output. The default size is three times the LZMA2 dictionary size or 1 MiB, whichever is more. Typically a good value is 2β4 times the size of the LZMA2 dictionary or at least 1 MiB. Using size less than the LZMA2 dictionary size is waste of RAM because then the LZMA2 dictionary buffer will never get fully used. In multi-threaded mode, the sizes of the blocks are stored in the block headers. This size information is required for multi-threaded decompression. In single-threaded mode no block splitting is done by default. Setting this option doesn't affect memory usage. No size information is stored in block headers, thus files created in single-threaded mode won't be identical to files created in multi-threaded mode. The lack of size information also means that xz won't be able decompress the files in multi-threaded mode. --block-list=items When compressing to the .xz format, start a new block with an optional custom filter chain after the given intervals of uncompressed data. The items are a comma-separated list. Each item consists of an optional filter chain number between 0 and 9 followed by a colon (:) and a required size of uncompressed data. Omitting an item (two or more consecutive commas) is a shorthand to use the size and filters of the previous item. If the input file is bigger than the sum of the sizes in items, the last item is repeated until the end of the file. A special value of 0 may be used as the last size to indicate that the rest of the file should be encoded as a single block. An alternative filter chain for each block can be specified in combination with the --filters1=filters ... --filters9=filters options. These options define filter chains with an identifier between 1β9. Filter chain 0 can be used to refer to the default filter chain, which is the same as not specifying a filter chain. The filter chain identifier can be used before the uncompressed size, followed by a colon (:). For example, if one specifies --block-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB then blocks will be created using: β’ The filter chain specified by --filters1 and 2 MiB input β’ The filter chain specified by --filters3 and 2 MiB input β’ The filter chain specified by --filters2 and 4 MiB input β’ The filter chain specified by --filters2 and 4 MiB input β’ The default filter chain and 2 MiB input β’ The default filter chain and 4 MiB input for every block until end of input. If one specifies a size that exceeds the encoder's block size (either the default value in threaded mode or the value specified with --block-size=size), the encoder will create additional blocks while keeping the boundaries specified in items. For example, if one specifies --block-size=10MiB --block-list=5MiB,10MiB,8MiB,12MiB,24MiB and the input file is 80 MiB, one will get 11 blocks: 5, 10, 8, 10, 2, 10, 10, 4, 10, 10, and 1 MiB. In multi-threaded mode the sizes of the blocks are stored in the block headers. This isn't done in single-threaded mode, so the encoded output won't be identical to that of the multi-threaded mode. --flush-timeout=timeout When compressing, if more than timeout milliseconds (a positive integer) has passed since the previous flush and reading more input would block, all the pending input data is flushed from the encoder and made available in the output stream. This can be useful if xz is used to compress data that is streamed over a network. Small timeout values make the data available at the receiving end with a small delay, but large timeout values give better compression ratio. This feature is disabled by default. If this option is specified more than once, the last one takes effect. The special timeout value of 0 can be used to explicitly disable this feature. This feature is not available on non-POSIX systems. This feature is still experimental. Currently xz is unsuitable for decompressing the stream in real time due to how xz does buffering. --memlimit-compress=limit Set a memory usage limit for compression. If this option is specified multiple times, the last one takes effect. If the compression settings exceed the limit, xz will attempt to adjust the settings downwards so that the limit is no longer exceeded and display a notice that automatic adjustment was done. The adjustments are done in this order: reducing the number of threads, switching to single-threaded mode if even one thread in multi-threaded mode exceeds the limit, and finally reducing the LZMA2 dictionary size. When compressing with --format=raw or if --no-adjust has been specified, only the number of threads may be reduced since it can be done without affecting the compressed output. If the limit cannot be met even with the adjustments described above, an error is displayed and xz will exit with exit status 1. The limit can be specified in multiple ways: β’ The limit can be an absolute value in bytes. Using an integer suffix like MiB can be useful. Example: --memlimit-compress=80MiB β’ The limit can be specified as a percentage of total physical memory (RAM). This can be useful especially when setting the XZ_DEFAULTS environment variable in a shell initialization script that is shared between different computers. That way the limit is automatically bigger on systems with more memory. Example: --memlimit-compress=70% β’ The limit can be reset back to its default value by setting it to 0. This is currently equivalent to setting the limit to max (no memory usage limit). For 32-bit xz there is a special case: if the limit would be over 4020 MiB, the limit is set to 4020 MiB. On MIPS32 2000 MiB is used instead. (The values 0 and max aren't affected by this. A similar feature doesn't exist for decompression.) This can be helpful when a 32-bit executable has access to 4 GiB address space (2 GiB on MIPS32) while hopefully doing no harm in other situations. See also the section Memory usage. --memlimit-decompress=limit Set a memory usage limit for decompression. This also affects the --list mode. If the operation is not possible without exceeding the limit, xz will display an error and decompressing the file will fail. See --memlimit-compress=limit for possible ways to specify the limit. --memlimit-mt-decompress=limit Set a memory usage limit for multi-threaded decompression. This can only affect the number of threads; this will never make xz refuse to decompress a file. If limit is too low to allow any multi-threading, the limit is ignored and xz will continue in single-threaded mode. Note that if also --memlimit-decompress is used, it will always apply to both single-threaded and multi- threaded modes, and so the effective limit for multi-threading will never be higher than the limit set with --memlimit-decompress. In contrast to the other memory usage limit options, --memlimit-mt-decompress=limit has a system-specific default limit. xz --info-memory can be used to see the current value. This option and its default value exist because without any limit the threaded decompressor could end up allocating an insane amount of memory with some input files. If the default limit is too low on your system, feel free to increase the limit but never set it to a value larger than the amount of usable RAM as with appropriate input files xz will attempt to use that amount of memory even with a low number of threads. Running out of memory or swapping will not improve decompression performance. See --memlimit-compress=limit for possible ways to specify the limit. Setting limit to 0 resets the limit to the default system-specific value. -M limit, --memlimit=limit, --memory=limit This is equivalent to specifying --memlimit-compress=limit --memlimit-decompress=limit --memlimit-mt-decompress=limit. --no-adjust Display an error and exit if the memory usage limit cannot be met without adjusting settings that affect the compressed output. That is, this prevents xz from switching the encoder from multi-threaded mode to single-threaded mode and from reducing the LZMA2 dictionary size. Even when this option is used the number of threads may be reduced to meet the memory usage limit as that won't affect the compressed output. Automatic adjusting is always disabled when creating raw streams (--format=raw). -T threads, --threads=threads Specify the number of worker threads to use. Setting threads to a special value 0 makes xz use up to as many threads as the processor(s) on the system support. The actual number of threads can be fewer than threads if the input file is not big enough for threading with the given settings or if using more threads would exceed the memory usage limit. The single-threaded and multi-threaded compressors produce different output. Single-threaded compressor will give the smallest file size but only the output from the multi-threaded compressor can be decompressed using multiple threads. Setting threads to 1 will use the single-threaded mode. Setting threads to any other value, including 0, will use the multi-threaded compressor even if the system supports only one hardware thread. (xz 5.2.x used single-threaded mode in this situation.) To use multi-threaded mode with only one thread, set threads to +1. The + prefix has no effect with values other than 1. A memory usage limit can still make xz switch to single-threaded mode unless --no-adjust is used. Support for the + prefix was added in xz 5.4.0. If an automatic number of threads has been requested and no memory usage limit has been specified, then a system-specific default soft limit will be used to possibly limit the number of threads. It is a soft limit in sense that it is ignored if the number of threads becomes one, thus a soft limit will never stop xz from compressing or decompressing. This default soft limit will not make xz switch from multi-threaded mode to single- threaded mode. The active limits can be seen with xz --info-memory. Currently the only threading method is to split the input into blocks and compress them independently from each other. The default block size depends on the compression level and can be overridden with the --block-size=size option. Threaded decompression only works on files that contain multiple blocks with size information in block headers. All large enough files compressed in multi-threaded mode meet this condition, but files compressed in single-threaded mode don't even if --block-size=size has been used. The default value for threads is 0. In xz 5.4.x and older the default is 1. Custom compressor filter chains A custom filter chain allows specifying the compression settings in detail instead of relying on the settings associated to the presets. When a custom filter chain is specified, preset options (-0 ... -9 and --extreme) earlier on the command line are forgotten. If a preset option is specified after one or more custom filter chain options, the new preset takes effect and the custom filter chain options specified earlier are forgotten. A filter chain is comparable to piping on the command line. When compressing, the uncompressed input goes to the first filter, whose output goes to the next filter (if any). The output of the last filter gets written to the compressed file. The maximum number of filters in the chain is four, but typically a filter chain has only one or two filters. Many filters have limitations on where they can be in the filter chain: some filters can work only as the last filter in the chain, some only as a non-last filter, and some work in any position in the chain. Depending on the filter, this limitation is either inherent to the filter design or exists to prevent security issues. A custom filter chain can be specified in two different ways. The options --filters=filters and --filters1=filters ... --filters9=filters allow specifying an entire filter chain in one option using the liblzma filter string syntax. Alternatively, a filter chain can be specified by using one or more individual filter options in the order they are wanted in the filter chain. That is, the order of the individual filter options is significant! When decoding raw streams (--format=raw), the filter chain must be specified in the same order as it was specified when compressing. Any individual filter or preset options specified before the full chain option (--filters=filters) will be forgotten. Individual filters specified after the full chain option will reset the filter chain. Both the full and individual filter options take filter-specific options as a comma-separated list. Extra commas in options are ignored. Every option has a default value, so specify those you want to change. To see the whole filter chain and options, use xz -vv (that is, use --verbose twice). This works also for viewing the filter chain options used by presets. --filters=filters Specify the full filter chain or a preset in a single option. Each filter can be separated by spaces or two dashes (--). filters may need to be quoted on the shell command line so it is parsed as a single option. To denote options, use : or =. A preset can be prefixed with a - and followed with zero or more flags. The only supported flag is e to apply the same options as --extreme. --filters1=filters ... --filters9=filters Specify up to nine additional filter chains that can be used with --block-list. For example, when compressing an archive with executable files followed by text files, the executable part could use a filter chain with a BCJ filter and the text part only the LZMA2 filter. --filters-help Display a help message describing how to specify presets and custom filter chains in the --filters and --filters1=filters ... --filters9=filters options, and exit successfully. --lzma1[=options] --lzma2[=options] Add LZMA1 or LZMA2 filter to the filter chain. These filters can be used only as the last filter in the chain. LZMA1 is a legacy filter, which is supported almost solely due to the legacy .lzma file format, which supports only LZMA1. LZMA2 is an updated version of LZMA1 to fix some practical issues of LZMA1. The .xz format uses LZMA2 and doesn't support LZMA1 at all. Compression speed and ratios of LZMA1 and LZMA2 are practically the same. LZMA1 and LZMA2 share the same set of options: preset=preset Reset all LZMA1 or LZMA2 options to preset. Preset consist of an integer, which may be followed by single- letter preset modifiers. The integer can be from 0 to 9, matching the command line options -0 ... -9. The only supported modifier is currently e, which matches --extreme. If no preset is specified, the default values of LZMA1 or LZMA2 options are taken from the preset 6. dict=size Dictionary (history buffer) size indicates how many bytes of the recently processed uncompressed data is kept in memory. The algorithm tries to find repeating byte sequences (matches) in the uncompressed data, and replace them with references to the data currently in the dictionary. The bigger the dictionary, the higher is the chance to find a match. Thus, increasing dictionary size usually improves compression ratio, but a dictionary bigger than the uncompressed file is waste of memory. Typical dictionary size is from 64 KiB to 64 MiB. The minimum is 4 KiB. The maximum for compression is currently 1.5 GiB (1536 MiB). The decompressor already supports dictionaries up to one byte less than 4 GiB, which is the maximum for the LZMA1 and LZMA2 stream formats. Dictionary size and match finder (mf) together determine the memory usage of the LZMA1 or LZMA2 encoder. The same (or bigger) dictionary size is required for decompressing that was used when compressing, thus the memory usage of the decoder is determined by the dictionary size used when compressing. The .xz headers store the dictionary size either as 2^n or 2^n + 2^(n-1), so these sizes are somewhat preferred for compression. Other sizes will get rounded up when stored in the .xz headers. lc=lc Specify the number of literal context bits. The minimum is 0 and the maximum is 4; the default is 3. In addition, the sum of lc and lp must not exceed 4. All bytes that cannot be encoded as matches are encoded as literals. That is, literals are simply 8-bit bytes that are encoded one at a time. The literal coding makes an assumption that the highest lc bits of the previous uncompressed byte correlate with the next byte. For example, in typical English text, an upper-case letter is often followed by a lower-case letter, and a lower-case letter is usually followed by another lower-case letter. In the US-ASCII character set, the highest three bits are 010 for upper-case letters and 011 for lower-case letters. When lc is at least 3, the literal coding can take advantage of this property in the uncompressed data. The default value (3) is usually good. If you want maximum compression, test lc=4. Sometimes it helps a little, and sometimes it makes compression worse. If it makes it worse, test lc=2 too. lp=lp Specify the number of literal position bits. The minimum is 0 and the maximum is 4; the default is 0. Lp affects what kind of alignment in the uncompressed data is assumed when encoding literals. See pb below for more information about alignment. pb=pb Specify the number of position bits. The minimum is 0 and the maximum is 4; the default is 2. Pb affects what kind of alignment in the uncompressed data is assumed in general. The default means four-byte alignment (2^pb=2^2=4), which is often a good choice when there's no better guess. When the alignment is known, setting pb accordingly may reduce the file size a little. For example, with text files having one-byte alignment (US-ASCII, ISO-8859-*, UTF-8), setting pb=0 can improve compression slightly. For UTF-16 text, pb=1 is a good choice. If the alignment is an odd number like 3 bytes, pb=0 might be the best choice. Even though the assumed alignment can be adjusted with pb and lp, LZMA1 and LZMA2 still slightly favor 16-byte alignment. It might be worth taking into account when designing file formats that are likely to be often compressed with LZMA1 or LZMA2. mf=mf Match finder has a major effect on encoder speed, memory usage, and compression ratio. Usually Hash Chain match finders are faster than Binary Tree match finders. The default depends on the preset: 0 uses hc3, 1β3 use hc4, and the rest use bt4. The following match finders are supported. The memory usage formulas below are rough approximations, which are closest to the reality when dict is a power of two. hc3 Hash Chain with 2- and 3-byte hashing Minimum value for nice: 3 Memory usage: dict * 7.5 (if dict <= 16 MiB); dict * 5.5 + 64 MiB (if dict > 16 MiB) hc4 Hash Chain with 2-, 3-, and 4-byte hashing Minimum value for nice: 4 Memory usage: dict * 7.5 (if dict <= 32 MiB); dict * 6.5 (if dict > 32 MiB) bt2 Binary Tree with 2-byte hashing Minimum value for nice: 2 Memory usage: dict * 9.5 bt3 Binary Tree with 2- and 3-byte hashing Minimum value for nice: 3 Memory usage: dict * 11.5 (if dict <= 16 MiB); dict * 9.5 + 64 MiB (if dict > 16 MiB) bt4 Binary Tree with 2-, 3-, and 4-byte hashing Minimum value for nice: 4 Memory usage: dict * 11.5 (if dict <= 32 MiB); dict * 10.5 (if dict > 32 MiB) mode=mode Compression mode specifies the method to analyze the data produced by the match finder. Supported modes are fast and normal. The default is fast for presets 0β3 and normal for presets 4β9. Usually fast is used with Hash Chain match finders and normal with Binary Tree match finders. This is also what the presets do. nice=nice Specify what is considered to be a nice length for a match. Once a match of at least nice bytes is found, the algorithm stops looking for possibly better matches. Nice can be 2β273 bytes. Higher values tend to give better compression ratio at the expense of speed. The default depends on the preset. depth=depth Specify the maximum search depth in the match finder. The default is the special value of 0, which makes the compressor determine a reasonable depth from mf and nice. Reasonable depth for Hash Chains is 4β100 and 16β1000 for Binary Trees. Using very high values for depth can make the encoder extremely slow with some files. Avoid setting the depth over 1000 unless you are prepared to interrupt the compression in case it is taking far too long. When decoding raw streams (--format=raw), LZMA2 needs only the dictionary size. LZMA1 needs also lc, lp, and pb. --x86[=options] --arm[=options] --armthumb[=options] --arm64[=options] --powerpc[=options] --ia64[=options] --sparc[=options] --riscv[=options] Add a branch/call/jump (BCJ) filter to the filter chain. These filters can be used only as a non-last filter in the filter chain. A BCJ filter converts relative addresses in the machine code to their absolute counterparts. This doesn't change the size of the data but it increases redundancy, which can help LZMA2 to produce 0β15 % smaller .xz file. The BCJ filters are always reversible, so using a BCJ filter for wrong type of data doesn't cause any data loss, although it may make the compression ratio slightly worse. The BCJ filters are very fast and use an insignificant amount of memory. These BCJ filters have known problems related to the compression ratio: β’ Some types of files containing executable code (for example, object files, static libraries, and Linux kernel modules) have the addresses in the instructions filled with filler values. These BCJ filters will still do the address conversion, which will make the compression worse with these files. β’ If a BCJ filter is applied on an archive, it is possible that it makes the compression ratio worse than not using a BCJ filter. For example, if there are similar or even identical executables then filtering will likely make the files less similar and thus compression is worse. The contents of non- executable files in the same archive can matter too. In practice one has to try with and without a BCJ filter to see which is better in each situation. Different instruction sets have different alignment: the executable file must be aligned to a multiple of this value in the input data to make the filter work. Filter Alignment Notes x86 1 32-bit or 64-bit x86 ARM 4 ARM-Thumb 2 ARM64 4 4096-byte alignment is best PowerPC 4 Big endian only IA-64 16 Itanium SPARC 4 RISC-V 2 Since the BCJ-filtered data is usually compressed with LZMA2, the compression ratio may be improved slightly if the LZMA2 options are set to match the alignment of the selected BCJ filter. Examples: β’ IA-64 filter has 16-byte alignment so pb=4,lp=4,lc=0 is good with LZMA2 (2^4=16). β’ RISC-V code has 2-byte or 4-byte alignment depending on whether the file contains 16-bit compressed instructions (the C extension). When 16-bit instructions are used, pb=2,lp=1,lc=3 or pb=1,lp=1,lc=3 is good. When 16-bit instructions aren't present, pb=2,lp=2,lc=2 is the best. readelf -h can be used to check if "RVC" appears on the "Flags" line. β’ ARM64 is always 4-byte aligned so pb=2,lp=2,lc=2 is the best. β’ The x86 filter is an exception. It's usually good to stick to LZMA2's defaults (pb=2,lp=0,lc=3) when compressing x86 executables. All BCJ filters support the same options: start=offset Specify the start offset that is used when converting between relative and absolute addresses. The offset must be a multiple of the alignment of the filter (see the table above). The default is zero. In practice, the default is good; specifying a custom offset is almost never useful. --delta[=options] Add the Delta filter to the filter chain. The Delta filter can be only used as a non-last filter in the filter chain. Currently only simple byte-wise delta calculation is supported. It can be useful when compressing, for example, uncompressed bitmap images or uncompressed PCM audio. However, special purpose algorithms may give significantly better results than Delta + LZMA2. This is true especially with audio, which compresses faster and better, for example, with flac(1). Supported options: dist=distance Specify the distance of the delta calculation in bytes. distance must be 1β256. The default is 1. For example, with dist=2 and eight-byte input A1 B1 A2 B3 A3 B5 A4 B7, the output will be A1 B1 01 02 01 02 01 02. Other options -q, --quiet Suppress warnings and notices. Specify this twice to suppress errors too. This option has no effect on the exit status. That is, even if a warning was suppressed, the exit status to indicate a warning is still used. -v, --verbose Be verbose. If standard error is connected to a terminal, xz will display a progress indicator. Specifying --verbose twice will give even more verbose output. The progress indicator shows the following information: β’ Completion percentage is shown if the size of the input file is known. That is, the percentage cannot be shown in pipes. β’ Amount of compressed data produced (compressing) or consumed (decompressing). β’ Amount of uncompressed data consumed (compressing) or produced (decompressing). β’ Compression ratio, which is calculated by dividing the amount of compressed data processed so far by the amount of uncompressed data processed so far. β’ Compression or decompression speed. This is measured as the amount of uncompressed data consumed (compression) or produced (decompression) per second. It is shown after a few seconds have passed since xz started processing the file. β’ Elapsed time in the format M:SS or H:MM:SS. β’ Estimated remaining time is shown only when the size of the input file is known and a couple of seconds have already passed since xz started processing the file. The time is shown in a less precise format which never has any colons, for example, 2 min 30 s. When standard error is not a terminal, --verbose will make xz print the filename, compressed size, uncompressed size, compression ratio, and possibly also the speed and elapsed time on a single line to standard error after compressing or decompressing the file. The speed and elapsed time are included only when the operation took at least a few seconds. If the operation didn't finish, for example, due to user interruption, also the completion percentage is printed if the size of the input file is known. -Q, --no-warn Don't set the exit status to 2 even if a condition worth a warning was detected. This option doesn't affect the verbosity level, thus both --quiet and --no-warn have to be used to not display warnings and to not alter the exit status. --robot Print messages in a machine-parsable format. This is intended to ease writing frontends that want to use xz instead of liblzma, which may be the case with various scripts. The output with this option enabled is meant to be stable across xz releases. See the section ROBOT MODE for details. --info-memory Display, in human-readable format, how much physical memory (RAM) and how many processor threads xz thinks the system has and the memory usage limits for compression and decompression, and exit successfully. -h, --help Display a help message describing the most commonly used options, and exit successfully. -H, --long-help Display a help message describing all features of xz, and exit successfully -V, --version Display the version number of xz and liblzma in human readable format. To get machine-parsable output, specify --robot before --version. ROBOT MODE The robot mode is activated with the --robot option. It makes the output of xz easier to parse by other programs. Currently --robot is supported only together with --list, --filters-help, --info-memory, and --version. It will be supported for compression and decompression in the future. List mode xz --robot --list uses tab-separated output. The first column of every line has a string that indicates the type of the information found on that line: name This is always the first line when starting to list a file. The second column on the line is the filename. file This line contains overall information about the .xz file. This line is always printed after the name line. stream This line type is used only when --verbose was specified. There are as many stream lines as there are streams in the .xz file. block This line type is used only when --verbose was specified. There are as many block lines as there are blocks in the .xz file. The block lines are shown after all the stream lines; different line types are not interleaved. summary This line type is used only when --verbose was specified twice. This line is printed after all block lines. Like the file line, the summary line contains overall information about the .xz file. totals This line is always the very last line of the list output. It shows the total counts and sizes. The columns of the file lines: 2. Number of streams in the file 3. Total number of blocks in the stream(s) 4. Compressed size of the file 5. Uncompressed size of the file 6. Compression ratio, for example, 0.123. If ratio is over 9.999, three dashes (---) are displayed instead of the ratio. 7. Comma-separated list of integrity check names. The following strings are used for the known check types: None, CRC32, CRC64, and SHA-256. For unknown check types, Unknown-N is used, where N is the Check ID as a decimal number (one or two digits). 8. Total size of stream padding in the file The columns of the stream lines: 2. Stream number (the first stream is 1) 3. Number of blocks in the stream 4. Compressed start offset 5. Uncompressed start offset 6. Compressed size (does not include stream padding) 7. Uncompressed size 8. Compression ratio 9. Name of the integrity check 10. Size of stream padding The columns of the block lines: 2. Number of the stream containing this block 3. Block number relative to the beginning of the stream (the first block is 1) 4. Block number relative to the beginning of the file 5. Compressed start offset relative to the beginning of the file 6. Uncompressed start offset relative to the beginning of the file 7. Total compressed size of the block (includes headers) 8. Uncompressed size 9. Compression ratio 10. Name of the integrity check If --verbose was specified twice, additional columns are included on the block lines. These are not displayed with a single --verbose, because getting this information requires many seeks and can thus be slow: 11. Value of the integrity check in hexadecimal 12. Block header size 13. Block flags: c indicates that compressed size is present, and u indicates that uncompressed size is present. If the flag is not set, a dash (-) is shown instead to keep the string length fixed. New flags may be added to the end of the string in the future. 14. Size of the actual compressed data in the block (this excludes the block header, block padding, and check fields) 15. Amount of memory (in bytes) required to decompress this block with this xz version 16. Filter chain. Note that most of the options used at compression time cannot be known, because only the options that are needed for decompression are stored in the .xz headers. The columns of the summary lines: 2. Amount of memory (in bytes) required to decompress this file with this xz version 3. yes or no indicating if all block headers have both compressed size and uncompressed size stored in them Since xz 5.1.2alpha: 4. Minimum xz version required to decompress the file The columns of the totals line: 2. Number of streams 3. Number of blocks 4. Compressed size 5. Uncompressed size 6. Average compression ratio 7. Comma-separated list of integrity check names that were present in the files 8. Stream padding size 9. Number of files. This is here to keep the order of the earlier columns the same as on file lines. If --verbose was specified twice, additional columns are included on the totals line: 10. Maximum amount of memory (in bytes) required to decompress the files with this xz version 11. yes or no indicating if all block headers have both compressed size and uncompressed size stored in them Since xz 5.1.2alpha: 12. Minimum xz version required to decompress the file Future versions may add new line types and new columns can be added to the existing line types, but the existing columns won't be changed. Filters help xz --robot --filters-help prints the supported filters in the following format: filter:option=<value>,option=<value>... filter Name of the filter option Name of a filter specific option value Numeric value ranges appear as <min-max>. String value choices are shown within < > and separated by a | character. Each filter is printed on its own line. Memory limit information xz --robot --info-memory prints a single line with multiple tab- separated columns: 1. Total amount of physical memory (RAM) in bytes. 2. Memory usage limit for compression in bytes (--memlimit-compress). A special value of 0 indicates the default setting which for single-threaded mode is the same as no limit. 3. Memory usage limit for decompression in bytes (--memlimit-decompress). A special value of 0 indicates the default setting which for single-threaded mode is the same as no limit. 4. Since xz 5.3.4alpha: Memory usage for multi-threaded decompression in bytes (--memlimit-mt-decompress). This is never zero because a system-specific default value shown in the column 5 is used if no limit has been specified explicitly. This is also never greater than the value in the column 3 even if a larger value has been specified with --memlimit-mt-decompress. 5. Since xz 5.3.4alpha: A system-specific default memory usage limit that is used to limit the number of threads when compressing with an automatic number of threads (--threads=0) and no memory usage limit has been specified (--memlimit-compress). This is also used as the default value for --memlimit-mt-decompress. 6. Since xz 5.3.4alpha: Number of available processor threads. In the future, the output of xz --robot --info-memory may have more columns, but never more than a single line. Version xz --robot --version prints the version number of xz and liblzma in the following format: XZ_VERSION=XYYYZZZS LIBLZMA_VERSION=XYYYZZZS X Major version. YYY Minor version. Even numbers are stable. Odd numbers are alpha or beta versions. ZZZ Patch level for stable releases or just a counter for development releases. S Stability. 0 is alpha, 1 is beta, and 2 is stable. S should be always 2 when YYY is even. XYYYZZZS are the same on both lines if xz and liblzma are from the same XZ Utils release. Examples: 4.999.9beta is 49990091 and 5.0.0 is 50000002. EXIT STATUS 0 All is good. 1 An error occurred. 2 Something worth a warning occurred, but no actual errors occurred. Notices (not warnings or errors) printed on standard error don't affect the exit status. ENVIRONMENT xz parses space-separated lists of options from the environment variables XZ_DEFAULTS and XZ_OPT, in this order, before parsing the options from the command line. Note that only options are parsed from the environment variables; all non-options are silently ignored. Parsing is done with getopt_long(3) which is used also for the command line arguments. XZ_DEFAULTS User-specific or system-wide default options. Typically this is set in a shell initialization script to enable xz's memory usage limiter by default. Excluding shell initialization scripts and similar special cases, scripts must never set or unset XZ_DEFAULTS. XZ_OPT This is for passing options to xz when it is not possible to set the options directly on the xz command line. This is the case when xz is run by a script or tool, for example, GNU tar(1): XZ_OPT=-2v tar caf foo.tar.xz foo Scripts may use XZ_OPT, for example, to set script-specific default compression options. It is still recommended to allow users to override XZ_OPT if that is reasonable. For example, in sh(1) scripts one may use something like this: XZ_OPT=${XZ_OPT-"-7e"} export XZ_OPT LZMA UTILS COMPATIBILITY The command line syntax of xz is practically a superset of lzma, unlzma, and lzcat as found from LZMA Utils 4.32.x. In most cases, it is possible to replace LZMA Utils with XZ Utils without breaking existing scripts. There are some incompatibilities though, which may sometimes cause problems. Compression preset levels The numbering of the compression level presets is not identical in xz and LZMA Utils. The most important difference is how dictionary sizes are mapped to different presets. Dictionary size is roughly equal to the decompressor memory usage. Level xz LZMA Utils -0 256 KiB N/A -1 1 MiB 64 KiB -2 2 MiB 1 MiB -3 4 MiB 512 KiB -4 4 MiB 1 MiB -5 8 MiB 2 MiB -6 8 MiB 4 MiB -7 16 MiB 8 MiB -8 32 MiB 16 MiB -9 64 MiB 32 MiB The dictionary size differences affect the compressor memory usage too, but there are some other differences between LZMA Utils and XZ Utils, which make the difference even bigger: Level xz LZMA Utils 4.32.x -0 3 MiB N/A -1 9 MiB 2 MiB -2 17 MiB 12 MiB -3 32 MiB 12 MiB -4 48 MiB 16 MiB -5 94 MiB 26 MiB -6 94 MiB 45 MiB -7 186 MiB 83 MiB -8 370 MiB 159 MiB -9 674 MiB 311 MiB The default preset level in LZMA Utils is -7 while in XZ Utils it is -6, so both use an 8 MiB dictionary by default. Streamed vs. non-streamed .lzma files The uncompressed size of the file can be stored in the .lzma header. LZMA Utils does that when compressing regular files. The alternative is to mark that uncompressed size is unknown and use end-of-payload marker to indicate where the decompressor should stop. LZMA Utils uses this method when uncompressed size isn't known, which is the case, for example, in pipes. xz supports decompressing .lzma files with or without end-of-payload marker, but all .lzma files created by xz will use end-of-payload marker and have uncompressed size marked as unknown in the .lzma header. This may be a problem in some uncommon situations. For example, a .lzma decompressor in an embedded device might work only with files that have known uncompressed size. If you hit this problem, you need to use LZMA Utils or LZMA SDK to create .lzma files with known uncompressed size. Unsupported .lzma files The .lzma format allows lc values up to 8, and lp values up to 4. LZMA Utils can decompress files with any lc and lp, but always creates files with lc=3 and lp=0. Creating files with other lc and lp is possible with xz and with LZMA SDK. The implementation of the LZMA1 filter in liblzma requires that the sum of lc and lp must not exceed 4. Thus, .lzma files, which exceed this limitation, cannot be decompressed with xz. LZMA Utils creates only .lzma files which have a dictionary size of 2^n (a power of 2) but accepts files with any dictionary size. liblzma accepts only .lzma files which have a dictionary size of 2^n or 2^n + 2^(n-1). This is to decrease false positives when detecting .lzma files. These limitations shouldn't be a problem in practice, since practically all .lzma files have been compressed with settings that liblzma will accept. Trailing garbage When decompressing, LZMA Utils silently ignore everything after the first .lzma stream. In most situations, this is a bug. This also means that LZMA Utils don't support decompressing concatenated .lzma files. If there is data left after the first .lzma stream, xz considers the file to be corrupt unless --single-stream was used. This may break obscure scripts which have assumed that trailing garbage is ignored. NOTES Compressed output may vary The exact compressed output produced from the same uncompressed input file may vary between XZ Utils versions even if compression options are identical. This is because the encoder can be improved (faster or better compression) without affecting the file format. The output can vary even between different builds of the same XZ Utils version, if different build options are used. The above means that once --rsyncable has been implemented, the resulting files won't necessarily be rsyncable unless both old and new files have been compressed with the same xz version. This problem can be fixed if a part of the encoder implementation is frozen to keep rsyncable output stable across xz versions. Embedded .xz decompressors Embedded .xz decompressor implementations like XZ Embedded don't necessarily support files created with integrity check types other than none and crc32. Since the default is --check=crc64, you must use --check=none or --check=crc32 when creating files for embedded systems. Outside embedded systems, all .xz format decompressors support all the check types, or at least are able to decompress the file without verifying the integrity check if the particular check is not supported. XZ Embedded supports BCJ filters, but only with the default start offset.
|
Basics Compress the file foo into foo.xz using the default compression level (-6), and remove foo if compression is successful: xz foo Decompress bar.xz into bar and don't remove bar.xz even if decompression is successful: xz -dk bar.xz Create baz.tar.xz with the preset -4e (-4 --extreme), which is slower than the default -6, but needs less memory for compression and decompression (48 MiB and 5 MiB, respectively): tar cf - baz | xz -4e > baz.tar.xz A mix of compressed and uncompressed files can be decompressed to standard output with a single command: xz -dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt Parallel compression of many files On GNU and *BSD, find(1) and xargs(1) can be used to parallelize compression of many files: find . -type f \! -name '*.xz' -print0 \ | xargs -0r -P4 -n16 xz -T1 The -P option to xargs(1) sets the number of parallel xz processes. The best value for the -n option depends on how many files there are to be compressed. If there are only a couple of files, the value should probably be 1; with tens of thousands of files, 100 or even more may be appropriate to reduce the number of xz processes that xargs(1) will eventually create. The option -T1 for xz is there to force it to single-threaded mode, because xargs(1) is used to control the amount of parallelization. Robot mode Calculate how many bytes have been saved in total after compressing multiple files: xz --robot --list *.xz | awk '/^totals/{print $5-$4}' A script may want to know that it is using new enough xz. The following sh(1) script checks that the version number of the xz tool is at least 5.0.0. This method is compatible with old beta versions, which didn't support the --robot option: if ! eval "$(xz --robot --version 2> /dev/null)" || [ "$XZ_VERSION" -lt 50000002 ]; then echo "Your xz is too old." fi unset XZ_VERSION LIBLZMA_VERSION Set a memory usage limit for decompression using XZ_OPT, but if a limit has already been set, don't increase it: NEWLIM=$((123 << 20)) # 123 MiB OLDLIM=$(xz --robot --info-memory | cut -f3) if [ $OLDLIM -eq 0 -o $OLDLIM -gt $NEWLIM ]; then XZ_OPT="$XZ_OPT --memlimit-decompress=$NEWLIM" export XZ_OPT fi Custom compressor filter chains The simplest use for custom filter chains is customizing a LZMA2 preset. This can be useful, because the presets cover only a subset of the potentially useful combinations of compression settings. The CompCPU columns of the tables from the descriptions of the options -0 ... -9 and --extreme are useful when customizing LZMA2 presets. Here are the relevant parts collected from those two tables: Preset CompCPU -0 0 -1 1 -2 2 -3 3 -4 4 -5 5 -6 6 -5e 7 -6e 8 If you know that a file requires somewhat big dictionary (for example, 32 MiB) to compress well, but you want to compress it quicker than xz -8 would do, a preset with a low CompCPU value (for example, 1) can be modified to use a bigger dictionary: xz --lzma2=preset=1,dict=32MiB foo.tar With certain files, the above command may be faster than xz -6 while compressing significantly better. However, it must be emphasized that only some files benefit from a big dictionary while keeping the CompCPU value low. The most obvious situation, where a big dictionary can help a lot, is an archive containing very similar files of at least a few megabytes each. The dictionary size has to be significantly bigger than any individual file to allow LZMA2 to take full advantage of the similarities between consecutive files. If very high compressor and decompressor memory usage is fine, and the file being compressed is at least several hundred megabytes, it may be useful to use an even bigger dictionary than the 64 MiB that xz -9 would use: xz -vv --lzma2=dict=192MiB big_foo.tar Using -vv (--verbose --verbose) like in the above example can be useful to see the memory requirements of the compressor and decompressor. Remember that using a dictionary bigger than the size of the uncompressed file is waste of memory, so the above command isn't useful for small files. Sometimes the compression time doesn't matter, but the decompressor memory usage has to be kept low, for example, to make it possible to decompress the file on an embedded system. The following command uses -6e (-6 --extreme) as a base and sets the dictionary to only 64 KiB. The resulting file can be decompressed with XZ Embedded (that's why there is --check=crc32) using about 100 KiB of memory. xz --check=crc32 --lzma2=preset=6e,dict=64KiB foo If you want to squeeze out as many bytes as possible, adjusting the number of literal context bits (lc) and number of position bits (pb) can sometimes help. Adjusting the number of literal position bits (lp) might help too, but usually lc and pb are more important. For example, a source code archive contains mostly US-ASCII text, so something like the following might give slightly (like 0.1 %) smaller file than xz -6e (try also without lc=4): xz --lzma2=preset=6e,pb=0,lc=4 source_code.tar Using another filter together with LZMA2 can improve compression with certain file types. For example, to compress a x86-32 or x86-64 shared library using the x86 BCJ filter: xz --x86 --lzma2 libfoo.so Note that the order of the filter options is significant. If --x86 is specified after --lzma2, xz will give an error, because there cannot be any filter after LZMA2, and also because the x86 BCJ filter cannot be used as the last filter in the chain. The Delta filter together with LZMA2 can give good results with bitmap images. It should usually beat PNG, which has a few more advanced filters than simple delta but uses Deflate for the actual compression. The image has to be saved in uncompressed format, for example, as uncompressed TIFF. The distance parameter of the Delta filter is set to match the number of bytes per pixel in the image. For example, 24-bit RGB bitmap needs dist=3, and it is also good to pass pb=0 to LZMA2 to accommodate the three-byte alignment: xz --delta=dist=3 --lzma2=pb=0 foo.tiff If multiple images have been put into a single archive (for example, .tar), the Delta filter will work on that too as long as all images have the same number of bytes per pixel. SEE ALSO xzdec(1), xzdiff(1), xzgrep(1), xzless(1), xzmore(1), gzip(1), bzip2(1), 7z(1) XZ Utils: <https://tukaani.org/xz/> XZ Embedded: <https://tukaani.org/xz/embedded.html> LZMA SDK: <https://7-zip.org/sdk.html> Tukaani 2024-04-08 XZ(1)
|
gvdir
|
List information about the FILEs (the current directory by default). Sort entries alphabetically if none of -cftuvSUX nor --sort is specified. Mandatory arguments to long options are mandatory for short options too. -a, --all do not ignore entries starting with . -A, --almost-all do not list implied . and .. --author with -l, print the author of each file -b, --escape print C-style escapes for nongraphic characters --block-size=SIZE with -l, scale sizes by SIZE when printing them; e.g., '--block-size=M'; see SIZE format below -B, --ignore-backups do not list implied entries ending with ~ -c with -lt: sort by, and show, ctime (time of last change of file status information); with -l: show ctime and sort by name; otherwise: sort by ctime, newest first -C list entries by columns --color[=WHEN] color the output WHEN; more info below -d, --directory list directories themselves, not their contents -D, --dired generate output designed for Emacs' dired mode -f list all entries in directory order -F, --classify[=WHEN] append indicator (one of */=>@|) to entries WHEN --file-type likewise, except do not append '*' --format=WORD across -x, commas -m, horizontal -x, long -l, single-column -1, verbose -l, vertical -C --full-time like -l --time-style=full-iso -g like -l, but do not list owner --group-directories-first group directories before files; can be augmented with a --sort option, but any use of --sort=none (-U) disables grouping -G, --no-group in a long listing, don't print group names -h, --human-readable with -l and -s, print sizes like 1K 234M 2G etc. --si likewise, but use powers of 1000 not 1024 -H, --dereference-command-line follow symbolic links listed on the command line --dereference-command-line-symlink-to-dir follow each command line symbolic link that points to a directory --hide=PATTERN do not list implied entries matching shell PATTERN (overridden by -a or -A) --hyperlink[=WHEN] hyperlink file names WHEN --indicator-style=WORD append indicator with style WORD to entry names: none (default), slash (-p), file-type (--file-type), classify (-F) -i, --inode print the index number of each file -I, --ignore=PATTERN do not list implied entries matching shell PATTERN -k, --kibibytes default to 1024-byte blocks for file system usage; used only with -s and per directory totals -l use a long listing format -L, --dereference when showing file information for a symbolic link, show information for the file the link references rather than for the link itself -m fill width with a comma separated list of entries -n, --numeric-uid-gid like -l, but list numeric user and group IDs -N, --literal print entry names without quoting -o like -l, but do not list group information -p, --indicator-style=slash append / indicator to directories -q, --hide-control-chars print ? instead of nongraphic characters --show-control-chars show nongraphic characters as-is (the default, unless program is 'ls' and output is a terminal) -Q, --quote-name enclose entry names in double quotes --quoting-style=WORD use quoting style WORD for entry names: literal, locale, shell, shell-always, shell-escape, shell-escape-always, c, escape (overrides QUOTING_STYLE environment variable) -r, --reverse reverse order while sorting -R, --recursive list subdirectories recursively -s, --size print the allocated size of each file, in blocks -S sort by file size, largest first --sort=WORD sort by WORD instead of name: none (-U), size (-S), time (-t), version (-v), extension (-X), width --time=WORD select which timestamp used to display or sort; access time (-u): atime, access, use; metadata change time (-c): ctime, status; modified time (default): mtime, modification; birth time: birth, creation; with -l, WORD determines which time to show; with --sort=time, sort by WORD (newest first) --time-style=TIME_STYLE time/date format with -l; see TIME_STYLE below -t sort by time, newest first; see --time -T, --tabsize=COLS assume tab stops at each COLS instead of 8 -u with -lt: sort by, and show, access time; with -l: show access time and sort by name; otherwise: sort by access time, newest first -U do not sort; list entries in directory order -v natural sort of (version) numbers within text -w, --width=COLS set output width to COLS. 0 means no limit -x list entries by lines instead of by columns -X sort alphabetically by entry extension -Z, --context print any security context of each file --zero end each output line with NUL, not newline -1 list one file per line --help display this help and exit --version output version information and exit The SIZE argument is an integer and optional unit (example: 10K is 10*1024). Units are K,M,G,T,P,E,Z,Y,R,Q (powers of 1024) or KB,MB,... (powers of 1000). Binary prefixes can be used, too: KiB=K, MiB=M, and so on. The TIME_STYLE argument can be full-iso, long-iso, iso, locale, or +FORMAT. FORMAT is interpreted like in date(1). If FORMAT is FORMAT1<newline>FORMAT2, then FORMAT1 applies to non-recent files and FORMAT2 to recent files. TIME_STYLE prefixed with 'posix-' takes effect only outside the POSIX locale. Also the TIME_STYLE environment variable sets the default style to use. The WHEN argument defaults to 'always' and can also be 'auto' or 'never'. Using color to distinguish file types is disabled both by default and with --color=never. With --color=auto, ls emits color codes only when standard output is connected to a terminal. The LS_COLORS environment variable can change the settings. Use the dircolors(1) command to set it. Exit status: 0 if OK, 1 if minor problems (e.g., cannot access subdirectory), 2 if serious trouble (e.g., cannot access command-line argument). AUTHOR Written by Richard M. Stallman and David MacKenzie. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO Full documentation <https://www.gnu.org/software/coreutils/vdir> or available locally via: info '(coreutils) vdir invocation' GNU coreutils 9.3 April 2023 VDIR(1)
|
vdir - list directory contents
|
vdir [OPTION]... [FILE]...
| null | null |
gdir
|
List information about the FILEs (the current directory by default). Sort entries alphabetically if none of -cftuvSUX nor --sort is specified. Mandatory arguments to long options are mandatory for short options too. -a, --all do not ignore entries starting with . -A, --almost-all do not list implied . and .. --author with -l, print the author of each file -b, --escape print C-style escapes for nongraphic characters --block-size=SIZE with -l, scale sizes by SIZE when printing them; e.g., '--block-size=M'; see SIZE format below -B, --ignore-backups do not list implied entries ending with ~ -c with -lt: sort by, and show, ctime (time of last change of file status information); with -l: show ctime and sort by name; otherwise: sort by ctime, newest first -C list entries by columns --color[=WHEN] color the output WHEN; more info below -d, --directory list directories themselves, not their contents -D, --dired generate output designed for Emacs' dired mode -f list all entries in directory order -F, --classify[=WHEN] append indicator (one of */=>@|) to entries WHEN --file-type likewise, except do not append '*' --format=WORD across -x, commas -m, horizontal -x, long -l, single-column -1, verbose -l, vertical -C --full-time like -l --time-style=full-iso -g like -l, but do not list owner --group-directories-first group directories before files; can be augmented with a --sort option, but any use of --sort=none (-U) disables grouping -G, --no-group in a long listing, don't print group names -h, --human-readable with -l and -s, print sizes like 1K 234M 2G etc. --si likewise, but use powers of 1000 not 1024 -H, --dereference-command-line follow symbolic links listed on the command line --dereference-command-line-symlink-to-dir follow each command line symbolic link that points to a directory --hide=PATTERN do not list implied entries matching shell PATTERN (overridden by -a or -A) --hyperlink[=WHEN] hyperlink file names WHEN --indicator-style=WORD append indicator with style WORD to entry names: none (default), slash (-p), file-type (--file-type), classify (-F) -i, --inode print the index number of each file -I, --ignore=PATTERN do not list implied entries matching shell PATTERN -k, --kibibytes default to 1024-byte blocks for file system usage; used only with -s and per directory totals -l use a long listing format -L, --dereference when showing file information for a symbolic link, show information for the file the link references rather than for the link itself -m fill width with a comma separated list of entries -n, --numeric-uid-gid like -l, but list numeric user and group IDs -N, --literal print entry names without quoting -o like -l, but do not list group information -p, --indicator-style=slash append / indicator to directories -q, --hide-control-chars print ? instead of nongraphic characters --show-control-chars show nongraphic characters as-is (the default, unless program is 'ls' and output is a terminal) -Q, --quote-name enclose entry names in double quotes --quoting-style=WORD use quoting style WORD for entry names: literal, locale, shell, shell-always, shell-escape, shell-escape-always, c, escape (overrides QUOTING_STYLE environment variable) -r, --reverse reverse order while sorting -R, --recursive list subdirectories recursively -s, --size print the allocated size of each file, in blocks -S sort by file size, largest first --sort=WORD sort by WORD instead of name: none (-U), size (-S), time (-t), version (-v), extension (-X), width --time=WORD select which timestamp used to display or sort; access time (-u): atime, access, use; metadata change time (-c): ctime, status; modified time (default): mtime, modification; birth time: birth, creation; with -l, WORD determines which time to show; with --sort=time, sort by WORD (newest first) --time-style=TIME_STYLE time/date format with -l; see TIME_STYLE below -t sort by time, newest first; see --time -T, --tabsize=COLS assume tab stops at each COLS instead of 8 -u with -lt: sort by, and show, access time; with -l: show access time and sort by name; otherwise: sort by access time, newest first -U do not sort; list entries in directory order -v natural sort of (version) numbers within text -w, --width=COLS set output width to COLS. 0 means no limit -x list entries by lines instead of by columns -X sort alphabetically by entry extension -Z, --context print any security context of each file --zero end each output line with NUL, not newline -1 list one file per line --help display this help and exit --version output version information and exit The SIZE argument is an integer and optional unit (example: 10K is 10*1024). Units are K,M,G,T,P,E,Z,Y,R,Q (powers of 1024) or KB,MB,... (powers of 1000). Binary prefixes can be used, too: KiB=K, MiB=M, and so on. The TIME_STYLE argument can be full-iso, long-iso, iso, locale, or +FORMAT. FORMAT is interpreted like in date(1). If FORMAT is FORMAT1<newline>FORMAT2, then FORMAT1 applies to non-recent files and FORMAT2 to recent files. TIME_STYLE prefixed with 'posix-' takes effect only outside the POSIX locale. Also the TIME_STYLE environment variable sets the default style to use. The WHEN argument defaults to 'always' and can also be 'auto' or 'never'. Using color to distinguish file types is disabled both by default and with --color=never. With --color=auto, ls emits color codes only when standard output is connected to a terminal. The LS_COLORS environment variable can change the settings. Use the dircolors(1) command to set it. Exit status: 0 if OK, 1 if minor problems (e.g., cannot access subdirectory), 2 if serious trouble (e.g., cannot access command-line argument). AUTHOR Written by Richard M. Stallman and David MacKenzie. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO Full documentation <https://www.gnu.org/software/coreutils/dir> or available locally via: info '(coreutils) dir invocation' GNU coreutils 9.3 April 2023 DIR(1)
|
dir - list directory contents
|
dir [OPTION]... [FILE]...
| null | null |
gchmod
|
This manual page documents the GNU version of chmod. chmod changes the file mode bits of each given file according to mode, which can be either a symbolic representation of changes to make, or an octal number representing the bit pattern for the new mode bits. The format of a symbolic mode is [ugoa...][[-+=][perms...]...], where perms is either zero or more letters from the set rwxXst, or a single letter from the set ugo. Multiple symbolic modes can be given, separated by commas. A combination of the letters ugoa controls which users' access to the file will be changed: the user who owns it (u), other users in the file's group (g), other users not in the file's group (o), or all users (a). If none of these are given, the effect is as if (a) were given, but bits that are set in the umask are not affected. The operator + causes the selected file mode bits to be added to the existing file mode bits of each file; - causes them to be removed; and = causes them to be added and causes unmentioned bits to be removed except that a directory's unmentioned set user and group ID bits are not affected. The letters rwxXst select file mode bits for the affected users: read (r), write (w), execute (or search for directories) (x), execute/search only if the file is a directory or already has execute permission for some user (X), set user or group ID on execution (s), restricted deletion flag or sticky bit (t). Instead of one or more of these letters, you can specify exactly one of the letters ugo: the permissions granted to the user who owns the file (u), the permissions granted to other users who are members of the file's group (g), and the permissions granted to users that are in neither of the two preceding categories (o). A numeric mode is from one to four octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. Omitted digits are assumed to be leading zeros. The first digit selects the set user ID (4) and set group ID (2) and restricted deletion or sticky (1) attributes. The second digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the third selects permissions for other users in the file's group, with the same values; and the fourth for other users not in the file's group, with the same values. chmod never changes the permissions of symbolic links; the chmod system call cannot change their permissions. This is not a problem since the permissions of symbolic links are never used. However, for each symbolic link listed on the command line, chmod changes the permissions of the pointed-to file. In contrast, chmod ignores symbolic links encountered during recursive directory traversals. SETUID AND SETGID BITS chmod clears the set-group-ID bit of a regular file if the file's group ID does not match the user's effective group ID or one of the user's supplementary group IDs, unless the user has appropriate privileges. Additional restrictions may cause the set-user-ID and set-group-ID bits of MODE or RFILE to be ignored. This behavior depends on the policy and functionality of the underlying chmod system call. When in doubt, check the underlying system behavior. For directories chmod preserves set-user-ID and set-group-ID bits unless you explicitly specify otherwise. You can set or clear the bits with symbolic modes like u+s and g-s. To clear these bits for directories with a numeric mode requires an additional leading zero like 00755, leading minus like -6000, or leading equals like =755. RESTRICTED DELETION FLAG OR STICKY BIT The restricted deletion flag or sticky bit is a single bit, whose interpretation depends on the file type. For directories, it prevents unprivileged users from removing or renaming a file in the directory unless they own the file or the directory; this is called the restricted deletion flag for the directory, and is commonly found on world-writable directories like /tmp. For regular files on some older systems, the bit saves the program's text image on the swap device so it will load more quickly when run; this is called the sticky bit.
|
chmod - change file mode bits
|
chmod [OPTION]... MODE[,MODE]... FILE... chmod [OPTION]... OCTAL-MODE FILE... chmod [OPTION]... --reference=RFILE FILE...
|
Change the mode of each FILE to MODE. With --reference, change the mode of each FILE to that of RFILE. -c, --changes like verbose but report only when a change is made -f, --silent, --quiet suppress most error messages -v, --verbose output a diagnostic for every file processed --no-preserve-root do not treat '/' specially (the default) --preserve-root fail to operate recursively on '/' --reference=RFILE use RFILE's mode instead of specifying MODE values. RFILE is always dereferenced if a symbolic link. -R, --recursive change files and directories recursively --help display this help and exit --version output version information and exit Each MODE is of the form '[ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+'. AUTHOR Written by David MacKenzie and Jim Meyering. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO chmod(2) Full documentation <https://www.gnu.org/software/coreutils/chmod> or available locally via: info '(coreutils) chmod invocation' GNU coreutils 9.3 April 2023 CHMOD(1)
| null |
luac-5.4
| null | null | null | null | null |
rbenv-uninstall
| null | null | null | null | null |
clippy-driver
| null | null | null | null | null |
gbase32
|
Base32 encode or decode FILE, or standard input, to standard output. With no FILE, or when FILE is -, read standard input. Mandatory arguments to long options are mandatory for short options too. -d, --decode decode data -i, --ignore-garbage when decoding, ignore non-alphabet characters -w, --wrap=COLS wrap encoded lines after COLS character (default 76). Use 0 to disable line wrapping --help display this help and exit --version output version information and exit The data are encoded as described for the base32 alphabet in RFC 4648. When decoding, the input may contain newlines in addition to the bytes of the formal base32 alphabet. Use --ignore-garbage to attempt to recover from any other non-alphabet bytes in the encoded stream. AUTHOR Written by Simon Josefsson. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO basenc(1) Full documentation <https://www.gnu.org/software/coreutils/base32> or available locally via: info '(coreutils) base32 invocation' GNU coreutils 9.3 April 2023 BASE32(1)
|
base32 - base32 encode/decode data and print to standard output
|
base32 [OPTION]... [FILE]
| null | null |
json_pp
|
json_pp converts between some input and output formats (one of them is JSON). This program was copied from json_xs and modified. The default input format is json and the default output format is json with pretty option.
|
json_pp - JSON::PP command utility
|
json_pp [-v] [-f from_format] [-t to_format] [-json_opt options_to_json1[,options_to_json2[,...]]]
|
-f -f from_format Reads a data in the given format from STDIN. Format types: json as JSON eval as Perl code -t Writes a data in the given format to STDOUT. null no action. json as JSON dumper as Data::Dumper -json_opt options to JSON::PP Acceptable options are: ascii latin1 utf8 pretty indent space_before space_after relaxed canonical allow_nonref allow_singlequote allow_barekey allow_bignum loose escape_slash indent_length Multiple options must be separated by commas: Right: -json_opt pretty,canonical Wrong: -json_opt pretty -json_opt canonical -v Verbose option, but currently no action in fact. -V Prints version and exits.
|
$ perl -e'print q|{"foo":"γγ","bar":1234567890000000000000000}|' |\ json_pp -f json -t dumper -json_opt pretty,utf8,allow_bignum $VAR1 = { 'bar' => bless( { 'value' => [ '0000000', '0000000', '5678900', '1234' ], 'sign' => '+' }, 'Math::BigInt' ), 'foo' => "\x{3042}\x{3044}" }; $ perl -e'print q|{"foo":"γγ","bar":1234567890000000000000000}|' |\ json_pp -f json -t dumper -json_opt pretty $VAR1 = { 'bar' => '1234567890000000000000000', 'foo' => "\x{e3}\x{81}\x{82}\x{e3}\x{81}\x{84}" }; SEE ALSO JSON::PP, json_xs AUTHOR Makamaka Hannyaharamitu, <makamaka[at]cpan.org> COPYRIGHT AND LICENSE Copyright 2010 by Makamaka Hannyaharamitu This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. perl v5.38.2 2023-11-28 JSON_PP(1)
|
lz4cat
|
lz4 is an extremely fast lossless compression algorithm, based on byte-aligned LZ77 family of compression scheme. lz4 offers compression speeds > 500 MB/s per core, linearly scalable with multi-core CPUs. It features an extremely fast decoder, offering speed in multiple GB/s per core, typically reaching RAM speed limit on multi-core systems. The native file format is the .lz4 format. Difference between lz4 and gzip lz4 supports a command line syntax similar but not identical to gzip(1). Differences are : β’ lz4 compresses a single file by default (see -m for multiple files) β’ lz4 file1 file2 means : compress file1 into file2 β’ lz4 file.lz4 will default to decompression (use -z to force compression) β’ lz4 preserves original files (see --rm to erase source file on completion) β’ lz4 shows real-time notification statistics during compression or decompression of a single file (use -q to silence them) β’ When no destination is specified, result is sent on implicit output, which depends on stdout status. When stdout is Not the console, it becomes the implicit output. Otherwise, if stdout is the console, the implicit output is filename.lz4. β’ It is considered bad practice to rely on implicit output in scripts. because the scriptΒ΄s environment may change. Always use explicit output in scripts. -c ensures that output will be stdout. Conversely, providing a destination name, or using -m ensures that the output will be either the specified name, or filename.lz4 respectively. Default behaviors can be modified by opt-in commands, detailed below. β’ lz4 -m makes it possible to provide multiple input filenames, which will be compressed into files using suffix .lz4. Progress notifications become disabled by default (use -v to enable them). This mode has a behavior which more closely mimics gzip command line, with the main remaining difference being that source files are preserved by default. β’ Similarly, lz4 -m -d can decompress multiple *.lz4 files. β’ ItΒ΄s possible to opt-in to erase source files on successful compression or decompression, using --rm command. β’ Consequently, lz4 -m --rm behaves the same as gzip. Concatenation of .lz4 files It is possible to concatenate .lz4 files as is. lz4 will decompress such files as if they were a single .lz4 file. For example: lz4 file1 > foo.lz4 lz4 file2 >> foo.lz4 Then lz4cat foo.lz4 is equivalent to cat file1 file2.
|
lz4 - lz4, unlz4, lz4cat - Compress or decompress .lz4 files
|
lz4 [OPTIONS] [-|INPUT-FILE] OUTPUT-FILE unlz4 is equivalent to lz4 -d lz4cat is equivalent to lz4 -dcfm When writing scripts that need to decompress files, it is recommended to always use the name lz4 with appropriate arguments (lz4 -d or lz4 -dc) instead of the names unlz4 and lz4cat.
|
Short commands concatenation In some cases, some options can be expressed using short command -x or long command --long-word. Short commands can be concatenated together. For example, -d -c is equivalent to -dc. Long commands cannot be concatenated. They must be clearly separated by a space. Multiple commands When multiple contradictory commands are issued on a same command line, only the latest one will be applied. Operation mode -z --compress Compress. This is the default operation mode when no operation mode option is specified, no other operation mode is implied from the command name (for example, unlz4 implies --decompress), nor from the input file name (for example, a file extension .lz4 implies --decompress by default). -z can also be used to force compression of an already compressed .lz4 file. -d --decompress --uncompress Decompress. --decompress is also the default operation when the input filename has an .lz4 extension. -t --test Test the integrity of compressed .lz4 files. The decompressed data is discarded. No files are created nor removed. -b# Benchmark mode, using # compression level. --list List information about .lz4 files. note : current implementation is limited to single-frame .lz4 files. Operation modifiers -# Compression level, with # being any value from 1 to 12. Higher values trade compression speed for compression ratio. Values above 12 are considered the same as 12. Recommended values are 1 for fast compression (default), and 9 for high compression. Speed/compression trade-off will vary depending on data to compress. Decompression speed remains fast at all settings. --fast[=#] Switch to ultra-fast compression levels. The higher the value, the faster the compression speed, at the cost of some compression ratio. If =# is not present, it defaults to 1. This setting overrides compression level if one was set previously. Similarly, if a compression level is set after --fast, it overrides it. --best Set highest compression level. Same as -12. --favor-decSpeed Generate compressed data optimized for decompression speed. Compressed data will be larger as a consequence (typically by ~0.5%), while decompression speed will be improved by 5-20%, depending on use cases. This option only works in combination with very high compression levels (>=10). -D dictionaryName Compress, decompress or benchmark using dictionary dictionaryName. Compression and decompression must use the same dictionary to be compatible. Using a different dictionary during decompression will either abort due to decompression error, or generate a checksum error. -f --[no-]force This option has several effects: If the target file already exists, overwrite it without prompting. When used with --decompress and lz4 cannot recognize the type of the source file, copy the source file as is to standard output. This allows lz4cat --force to be used like cat (1) for files that have not been compressed with lz4. -c --stdout --to-stdout Force write to standard output, even if it is the console. -m --multiple Multiple input files. Compressed file names will be appended a .lz4 suffix. This mode also reduces notification level. Can also be used to list multiple files. lz4 -m has a behavior equivalent to gzip -k (it preserves source files by default). -r operate recursively on directories. This mode also sets -m (multiple input files). -B# Block size [4-7](default : 7) -B4= 64KB ; -B5= 256KB ; -B6= 1MB ; -B7= 4MB -BI Produce independent blocks (default) -BD Blocks depend on predecessors (improves compression ratio, more noticeable on small blocks) -BX Generate block checksums (default:disabled) --[no-]frame-crc Select frame checksum (default:enabled) --no-crc Disable both frame and block checksums --[no-]content-size Header includes original size (default:not present) Note : this option can only be activated when the original size can be determined, hence for a file. It wonΒ΄t work with unknown source size, such as stdin or pipe. --[no-]sparse Sparse mode support (default:enabled on file, disabled on stdout) -l Use Legacy format (typically for Linux Kernel compression) Note : -l is not compatible with -m (--multiple) nor -r Other options -v --verbose Verbose mode -q --quiet Suppress warnings and real-time statistics; specify twice to suppress errors too -h -H --help Display help/long help and exit -V --version Display Version number and exit -k --keep Preserve source files (default behavior) --rm Delete source files on successful compression or decompression -- Treat all subsequent arguments as files Benchmark mode -b# Benchmark file(s), using # compression level -e# Benchmark multiple compression levels, from b# to e# (included) -i# Minimum evaluation time in seconds [1-9] (default : 3) BUGS Report bugs at: https://github.com/lz4/lz4/issues AUTHOR Yann Collet lz4 v1.9.4 August 2022 LZ4(1)
| null |
sha224sum
|
Print or check SHA224 (224-bit) checksums. With no FILE, or when FILE is -, read standard input. -b, --binary read in binary mode -c, --check read checksums from the FILEs and check them --tag create a BSD-style checksum -t, --text read in text mode (default) -z, --zero end each output line with NUL, not newline, and disable file name escaping The following five options are useful only when verifying checksums: --ignore-missing don't fail or report status for missing files --quiet don't print OK for each successfully verified file --status don't output anything, status code shows success --strict exit non-zero for improperly formatted checksum lines -w, --warn warn about improperly formatted checksum lines --help display this help and exit --version output version information and exit The sums are computed as described in RFC 3874. When checking, the input should be a former output of this program. The default mode is to print a line with: checksum, a space, a character indicating input mode ('*' for binary, ' ' for text or where binary is insignificant), and name for each FILE. Note: There is no difference between binary mode and text mode on GNU systems. AUTHOR Written by Ulrich Drepper, Scott Miller, and David Madore. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO cksum(1) Full documentation <https://www.gnu.org/software/coreutils/sha224sum> or available locally via: info '(coreutils) sha2 utilities' GNU coreutils 9.3 April 2023 SHA224SUM(1)
|
sha224sum - compute and check SHA224 message digest
|
sha224sum [OPTION]... [FILE]...
| null | null |
aspell-import
|
aspell-import is a command that will search for old personal dictionaries and will import them into GNU Aspell. It will look for both Ispell and Aspell dictionaries. To use it just run it from the command prompt.
|
aspell-import - import old personal dictionaries into GNU Aspell
|
aspell-import
|
This program does not accept any command-line options. SEE ALSO aspell(1), run-with-aspell(1), word-list-compress(1) The full documentation for Aspell is maintained as a Texinfo manual The `aspell' entry in info for more complete documentation. AUTHOR This manual page was written by Brian Nelson <pyro@debian.org>. GNU 2004-03-03 ASPELL-IMPORT(1)
| null |
remtest
| null | null | null | null | null |
normalize.py
| null | null | null | null | null |
sidxindex
| null | null | null | null | null |
composer
| null | null | null | null | null |
perl
|
Perl officially stands for Practical Extraction and Report Language, except when it doesn't. Perl was originally a language optimized for scanning arbitrary text files, extracting information from those text files, and printing reports based on that information. It quickly became a good language for many system management tasks. Over the years, Perl has grown into a general-purpose programming language. It's widely used for everything from quick "one-liners" to full-scale application development. The language is intended to be practical (easy to use, efficient, complete) rather than beautiful (tiny, elegant, minimal). It combines (in the author's opinion, anyway) some of the best features of sed, awk, and sh, making it familiar and easy to use for Unix users to whip up quick solutions to annoying problems. Its general-purpose programming facilities support procedural, functional, and object- oriented programming paradigms, making Perl a comfortable language for the long haul on major projects, whatever your bent. Perl's roots in text processing haven't been forgotten over the years. It still boasts some of the most powerful regular expressions to be found anywhere, and its support for Unicode text is world-class. It handles all kinds of structured text, too, through an extensive collection of extensions. Those libraries, collected in the CPAN, provide ready-made solutions to an astounding array of problems. When they haven't set the standard themselves, they steal from the best -- just like Perl itself. AVAILABILITY Perl is available for most operating systems, including virtually all Unix-like platforms. See "Supported Platforms" in perlport for a listing. ENVIRONMENT See "ENVIRONMENT" in perlrun. AUTHOR Larry Wall <larry@wall.org>, with the help of oodles of other folks. If your Perl success stories and testimonials may be of help to others who wish to advocate the use of Perl in their applications, or if you wish to simply express your gratitude to Larry and the Perl developers, please write to perl-thanks@perl.org . FILES "@INC" locations of perl libraries "@INC" above is a reference to the built-in variable of the same name; see perlvar for more information. SEE ALSO https://www.perl.org/ the Perl homepage https://www.perl.com/ Perl articles https://www.cpan.org/ the Comprehensive Perl Archive https://www.pm.org/ the Perl Mongers DIAGNOSTICS Using the "use strict" pragma ensures that all variables are properly declared and prevents other misuses of legacy Perl features. These are enabled by default within the scope of "use v5.12" (or higher). The "use warnings" pragma produces some lovely diagnostics. It is enabled by default when you say "use v5.35" (or higher). One can also use the -w flag, but its use is normally discouraged, because it gets applied to all executed Perl code, including that not under your control. See perldiag for explanations of all Perl's diagnostics. The "use diagnostics" pragma automatically turns Perl's normally terse warnings and errors into these longer forms. Compilation errors will tell you the line number of the error, with an indication of the next token or token type that was to be examined. (In a script passed to Perl via -e switches, each -e is counted as one line.) Setuid scripts have additional constraints that can produce error messages such as "Insecure dependency". See perlsec. Did we mention that you should definitely consider using the use warnings pragma? BUGS The behavior implied by the use warnings pragma is not mandatory. Perl is at the mercy of your machine's definitions of various operations such as type casting, atof(), and floating-point output with sprintf(). If your stdio requires a seek or eof between reads and writes on a particular stream, so does Perl. (This doesn't apply to sysread() and syswrite().) While none of the built-in data types have any arbitrary size limits (apart from memory size), there are still a few arbitrary limits: a given variable name may not be longer than 251 characters. Line numbers displayed by diagnostics are internally stored as short integers, so they are limited to a maximum of 65535 (higher numbers usually being affected by wraparound). You may submit your bug reports (be sure to include full configuration information as output by the myconfig program in the perl source tree, or by "perl -V") to <https://github.com/Perl/perl5/issues>. Perl actually stands for Pathologically Eclectic Rubbish Lister, but don't tell anyone I said that. NOTES The Perl motto is "There's more than one way to do it." Divining how many more is left as an exercise to the reader. The three principal virtues of a programmer are Laziness, Impatience, and Hubris. See the Camel Book for why. perl v5.38.2 2023-11-28 PERL(1)
|
perl - The Perl 5 language interpreter
|
perl [ -sTtuUWX ] [ -hv ] [ -V[:configvar] ] [ -cw ] [ -d[t][:debugger] ] [ -D[number/list] ] [ -pna ] [ -Fpattern ] [ -l[octal] ] [ -0[octal/hexadecimal] ] [ -Idir ] [ -m[-]module ] [ -M[-]'module...' ] [ -f ] [ -C [number/list] ] [ -S ] [ -x[dir] ] [ -i[extension] ] [ [-e|-E] 'command' ] [ -- ] [ programfile ] [ argument ]... For more information on these options, you can run "perldoc perlrun". GETTING HELP The perldoc program gives you access to all the documentation that comes with Perl. You can get more documentation, tutorials and community support online at <https://www.perl.org/>. If you're new to Perl, you should start by running "perldoc perlintro", which is a general intro for beginners and provides some background to help you navigate the rest of Perl's extensive documentation. Run "perldoc perldoc" to learn more things you can do with perldoc. For ease of access, the Perl manual has been split up into several sections. Overview perl Perl overview (this section) perlintro Perl introduction for beginners perlrun Perl execution and options perltoc Perl documentation table of contents Tutorials perlreftut Perl references short introduction perldsc Perl data structures intro perllol Perl data structures: arrays of arrays perlrequick Perl regular expressions quick start perlretut Perl regular expressions tutorial perlootut Perl OO tutorial for beginners perlperf Perl Performance and Optimization Techniques perlstyle Perl style guide perlcheat Perl cheat sheet perltrap Perl traps for the unwary perldebtut Perl debugging tutorial perlfaq Perl frequently asked questions perlfaq1 General Questions About Perl perlfaq2 Obtaining and Learning about Perl perlfaq3 Programming Tools perlfaq4 Data Manipulation perlfaq5 Files and Formats perlfaq6 Regexes perlfaq7 Perl Language Issues perlfaq8 System Interaction perlfaq9 Networking Reference Manual perlsyn Perl syntax perldata Perl data structures perlop Perl operators and precedence perlsub Perl subroutines perlfunc Perl built-in functions perlopentut Perl open() tutorial perlpacktut Perl pack() and unpack() tutorial perlpod Perl plain old documentation perlpodspec Perl plain old documentation format specification perldocstyle Perl style guide for core docs perlpodstyle Perl POD style guide perldiag Perl diagnostic messages perldeprecation Perl deprecations perllexwarn Perl warnings and their control perldebug Perl debugging perlvar Perl predefined variables perlre Perl regular expressions, the rest of the story perlrebackslash Perl regular expression backslash sequences perlrecharclass Perl regular expression character classes perlreref Perl regular expressions quick reference perlref Perl references, the rest of the story perlform Perl formats perlobj Perl objects perltie Perl objects hidden behind simple variables perlclass Perl class syntax perldbmfilter Perl DBM filters perlipc Perl interprocess communication perlfork Perl fork() information perlnumber Perl number semantics perlthrtut Perl threads tutorial perlport Perl portability guide perllocale Perl locale support perluniintro Perl Unicode introduction perlunicode Perl Unicode support perlunicook Perl Unicode cookbook perlunifaq Perl Unicode FAQ perluniprops Index of Unicode properties in Perl perlunitut Perl Unicode tutorial perlebcdic Considerations for running Perl on EBCDIC platforms perlsec Perl security perlsecpolicy Perl security report handling policy perlmod Perl modules: how they work perlmodlib Perl modules: how to write and use perlmodstyle Perl modules: how to write modules with style perlmodinstall Perl modules: how to install from CPAN perlnewmod Perl modules: preparing a new module for distribution perlpragma Perl modules: writing a user pragma perlutil utilities packaged with the Perl distribution perlfilter Perl source filters perldtrace Perl's support for DTrace perlglossary Perl Glossary Internals and C Language Interface perlembed Perl ways to embed perl in your C or C++ application perldebguts Perl debugging guts and tips perlxstut Perl XS tutorial perlxs Perl XS application programming interface perlxstypemap Perl XS C/Perl type conversion tools perlclib Internal replacements for standard C library functions perlguts Perl internal functions for those doing extensions perlcall Perl calling conventions from C perlmroapi Perl method resolution plugin interface perlreapi Perl regular expression plugin interface perlreguts Perl regular expression engine internals perlclassguts Internals of class syntax perlapi Perl API listing (autogenerated) perlintern Perl internal functions (autogenerated) perliol C API for Perl's implementation of IO in Layers perlapio Perl internal IO abstraction interface perlhack Perl hackers guide perlsource Guide to the Perl source tree perlinterp Overview of the Perl interpreter source and how it works perlhacktut Walk through the creation of a simple C code patch perlhacktips Tips for Perl core C code hacking perlpolicy Perl development policies perlgov Perl Rules of Governance perlgit Using git with the Perl repository History perlhist Perl history records perldelta Perl changes since previous version perl5381delta Perl changes in version 5.38.1 perl5380delta Perl changes in version 5.38.0 perl5363delta Perl changes in version 5.36.3 perl5362delta Perl changes in version 5.36.2 perl5361delta Perl changes in version 5.36.1 perl5360delta Perl changes in version 5.36.0 perl5343delta Perl changes in version 5.34.3 perl5342delta Perl changes in version 5.34.2 perl5341delta Perl changes in version 5.34.1 perl5340delta Perl changes in version 5.34.0 perl5321delta Perl changes in version 5.32.1 perl5320delta Perl changes in version 5.32.0 perl5303delta Perl changes in version 5.30.3 perl5302delta Perl changes in version 5.30.2 perl5301delta Perl changes in version 5.30.1 perl5300delta Perl changes in version 5.30.0 perl5283delta Perl changes in version 5.28.3 perl5282delta Perl changes in version 5.28.2 perl5281delta Perl changes in version 5.28.1 perl5280delta Perl changes in version 5.28.0 perl5263delta Perl changes in version 5.26.3 perl5262delta Perl changes in version 5.26.2 perl5261delta Perl changes in version 5.26.1 perl5260delta Perl changes in version 5.26.0 perl5244delta Perl changes in version 5.24.4 perl5243delta Perl changes in version 5.24.3 perl5242delta Perl changes in version 5.24.2 perl5241delta Perl changes in version 5.24.1 perl5240delta Perl changes in version 5.24.0 perl5224delta Perl changes in version 5.22.4 perl5223delta Perl changes in version 5.22.3 perl5222delta Perl changes in version 5.22.2 perl5221delta Perl changes in version 5.22.1 perl5220delta Perl changes in version 5.22.0 perl5203delta Perl changes in version 5.20.3 perl5202delta Perl changes in version 5.20.2 perl5201delta Perl changes in version 5.20.1 perl5200delta Perl changes in version 5.20.0 perl5184delta Perl changes in version 5.18.4 perl5182delta Perl changes in version 5.18.2 perl5181delta Perl changes in version 5.18.1 perl5180delta Perl changes in version 5.18.0 perl5163delta Perl changes in version 5.16.3 perl5162delta Perl changes in version 5.16.2 perl5161delta Perl changes in version 5.16.1 perl5160delta Perl changes in version 5.16.0 perl5144delta Perl changes in version 5.14.4 perl5143delta Perl changes in version 5.14.3 perl5142delta Perl changes in version 5.14.2 perl5141delta Perl changes in version 5.14.1 perl5140delta Perl changes in version 5.14.0 perl5125delta Perl changes in version 5.12.5 perl5124delta Perl changes in version 5.12.4 perl5123delta Perl changes in version 5.12.3 perl5122delta Perl changes in version 5.12.2 perl5121delta Perl changes in version 5.12.1 perl5120delta Perl changes in version 5.12.0 perl5101delta Perl changes in version 5.10.1 perl5100delta Perl changes in version 5.10.0 perl589delta Perl changes in version 5.8.9 perl588delta Perl changes in version 5.8.8 perl587delta Perl changes in version 5.8.7 perl586delta Perl changes in version 5.8.6 perl585delta Perl changes in version 5.8.5 perl584delta Perl changes in version 5.8.4 perl583delta Perl changes in version 5.8.3 perl582delta Perl changes in version 5.8.2 perl581delta Perl changes in version 5.8.1 perl58delta Perl changes in version 5.8.0 perl561delta Perl changes in version 5.6.1 perl56delta Perl changes in version 5.6 perl5005delta Perl changes in version 5.005 perl5004delta Perl changes in version 5.004 Miscellaneous perlbook Perl book information perlcommunity Perl community information perldoc Look up Perl documentation in Pod format perlexperiment A listing of experimental features in Perl perlartistic Perl Artistic License perlgpl GNU General Public License Language-Specific perlcn Perl for Simplified Chinese (in UTF-8) perljp Perl for Japanese (in EUC-JP) perlko Perl for Korean (in EUC-KR) perltw Perl for Traditional Chinese (in Big5) Platform-Specific perlaix Perl notes for AIX perlamiga Perl notes for AmigaOS perlandroid Perl notes for Android perlbs2000 Perl notes for POSIX-BC BS2000 perlcygwin Perl notes for Cygwin perlfreebsd Perl notes for FreeBSD perlhaiku Perl notes for Haiku perlhpux Perl notes for HP-UX perlhurd Perl notes for Hurd perlirix Perl notes for Irix perllinux Perl notes for Linux perlmacosx Perl notes for Mac OS X perlopenbsd Perl notes for OpenBSD perlos2 Perl notes for OS/2 perlos390 Perl notes for OS/390 perlos400 Perl notes for OS/400 perlplan9 Perl notes for Plan 9 perlqnx Perl notes for QNX perlriscos Perl notes for RISC OS perlsolaris Perl notes for Solaris perlsynology Perl notes for Synology perltru64 Perl notes for Tru64 perlvms Perl notes for VMS perlvos Perl notes for Stratus VOS perlwin32 Perl notes for Windows Stubs for Deleted Documents perlboot perlbot perlrepository perltodo perltooc perltoot On a Unix-like system, these documentation files will usually also be available as manpages for use with the man program. Some documentation is not available as man pages, so if a cross- reference is not found by man, try it with perldoc. Perldoc can also take you directly to documentation for functions (with the -f switch). See "perldoc --help" (or "perldoc perldoc" or "man perldoc") for other helpful options perldoc has to offer. In general, if something strange has gone wrong with your program and you're not sure where you should look for help, try making your code comply with use strict and use warnings. These will often point out exactly where the trouble is.
| null | null |
unicharset_extractor
| null | null | null | null | null |
digest
| null | null | null | null | null |
pdfsig
|
pdfsig verifies the digital signatures in a PDF document. It also displays the identity of each signer (commonName field and full distinguished name of the signer certificate), the time and date of the signature, the hash algorithm used for signing, the type of the signature as stated in the PDF and the signed ranges with a statement wether the total document is signed. It can also sign PDF documents (options -add-signature or -sign). pdfsig uses the trusted certificates stored in the Network Security Services (NSS) Database. pdfsig also uses the Online Certificate Status Protocol (OCSP) (refer to http://en.wikipedia.org/wiki/Online_Certificate_Status_Protocol) to look up the certificate online and check if it has been revoked (unless -no-ocsp has been specified). The NSS Database is searched for in the following locations: β’ If the -nssdir option is specified, the directory specified by this option. β’ The NSS Certificate database in the default Firefox profile. i.e. $HOME/.mozilla/firefox/*.default. β’ The NSS Certificate database in /etc/pki/nssdb.
|
pdfsig - Portable Document Format (PDF) digital signatures tool
|
pdfsig [options] [PDF-file] [Output-file]
|
-nssdir [prefix]directory Specify the database directory containing the certificate and key database files. See certutil(1) -d option for details of the prefix. If not specified the other search locations described in DESCRIPTION are used. -nss-pwd password Specify the password needed to access the NSS database (if any). -nocert Do not validate the certificate. -no-ocsp Do not perform online OCSP certificate revocation check (local Certificate Revocation Lists (CRL) are still used). -no-appearance Do not add appearance information when signing existing fields (signer name and date). -aia Enable the use of Authority Information Access (AIA) extension to fetch missing certificates to build the certificate chain. -dump Dump all signatures into current directory in their native format. Most likely it is either a unpadded or zero-padded CMS/PKCS7 bundle. -add-signature Add a new signature to the document. -new-signature-field-name name Specifies the field name to be used when adding a new signature. A random ID will be used by default. -sign field Sign the document in the specified signature field present in the document (must be unsigned). Field can be specified by field name (string) or the n-th signature field in the document (integer). -nick nickname Use the certificate with the given nickname for signing (NSS backend). If nickname starts with pkcs11:, it's treated as PKCS#11 URI (NSS backend). If the nickname is given as a fingerprint, it will be the certificate used (GPG backend) -backend backend Use the specified backeng for cryptographic signatures -kpw password Use the given password for the signing key (this might be missing if the key isn't password protected). -digest algorithm Use the given digest algorithm for signing (default: SHA256). -reason reason Set the given reason string for the signature (default: no reason set). -etsi Create a signature of type ETSI.CAdES.detached instead of adbe.pkcs7.detached. -list-nicks List available nicknames in the NSS database. -list-backends List available backends for cryptographic signatures -v Print copyright and version information. -h Print usage information. (-help and --help are equivalent.)
|
pdfsig signed_file.pdf Displays signature info for signed_file.pdf. pdfsig input.pdf output.pdf -add-signature -nss-pwd password -nick my- cert -reason 'for fun!' Creates a new pdf named output.pdf with the contents of input.pdf signed by the 'my-cert' certificate. pdfsig input.pdf output.pdf -add-signature -nss-pwd password -nick 'pkcs11:token=smartcard0;object=Second%20certificate;type=cert' Same, but uses a PKCS#11 URI as defined in IETF RFC 7512 to select the certificate to be used for signing. pdfsig input.pdf output.pdf -sign 0 -nss-pwd password -nick my-cert -reason 'for fun!' Creates a new pdf named output.pdf with the contents of input.pdf signed by the 'my-cert' certificate. input.pdf must have an already existing un-signed signature field. AUTHOR The pdfsig software and documentation are copyright 1996-2004 Glyph & Cog, LLC and copyright 2005-2015 The Poppler Developers - http://poppler.freedesktop.org SEE ALSO pdfdetach(1), pdffonts(1), pdfimages(1), pdfinfo(1), pdftocairo(1), pdftohtml(1), pdftoppm(1), pdftops(1), pdftotext(1) pdfseparate(1), pdfunite(1) certutil(1) 28 October 2015 pdfsig(1)
|
psktool
|
Program that generates random keys for use with TLS-PSK. The keys are stored in hexadecimal format in a key file.
|
psktool - GnuTLS PSK tool
|
psktool [-flags] [-flag [value]] [--option-name[[=| ]value]] All arguments must be options.
|
-d num, --debug=num Enable debugging. This option takes an integer number as its argument. The value of num is constrained to being: in the range 0 through 9999 Specifies the debug level. -s num, --keysize=num Specify the key size in bytes (default is 32-bytes or 256-bits). This option takes an integer number as its argument. The value of num is constrained to being: in the range 0 through 512 -u str, --username=str Specify the username to use. -p str, --pskfile=str Specify a pre-shared key file. This option will specify the pre-shared key file to store the generated keys. --passwd This is an alias for the --pskfile option. NOTE: THIS OPTION IS DEPRECATED -v arg, --version=arg Output version of program and exit. The default mode is `v', a simple version. The `c' mode will print copyright information and `n' will print the full copyright notice. -h, --help Display usage information and exit. -!, --more-help Pass the extended usage information through a pager.
|
To add a user 'psk_identity' in keys.psk for use with GnuTLS run: $ ./psktool -u psk_identity -p keys.psk Generating a random key for user 'psk_identity' Key stored to keys.psk $ cat keys.psk psk_identity:88f3824b3e5659f52d00e959bacab954b6540344 $ This command will create keys.psk if it does not exist and will add user 'psk_identity'. EXIT STATUS One of the following exit values will be returned: 0 (EXIT_SUCCESS) Successful program execution. 1 (EXIT_FAILURE) The operation failed or the command syntax was not valid. SEE ALSO gnutls-cli-debug (1), gnutls-serv (1), srptool (1), certtool (1) AUTHORS COPYRIGHT Copyright (C) 2020-2023 Free Software Foundation, and others all rights reserved. This program is released under the terms of the GNU General Public License, version 3 or later BUGS Please send bug reports to: bugs@gnutls.org 3.8.4 19 Mar 2024 psktool(1)
|
hwloc-calc
|
hwloc-calc generates and manipulates CPU mask strings or objects. Both input and output may be either objects (with physical or logical indexes), CPU lists (with physical or logical indexes), or CPU mask strings (always physically indexed). Input location specification is described in hwloc(7). If objects or CPU mask strings are given on the command-line, they are combined and a single output is printed. If no object or CPU mask strings are given on the command-line, the program will read the standard input. It will combine multiple objects or CPU mask strings that are given on the same line of the standard input line with spaces as separators. Different input lines will be processed separately. Command-line arguments and options are processed in order. First topology configuration options should be given. Then, for instance, changing the type of input indexes with --li or changing the input topology with -i only affects the processing the following arguments. NOTE: It is highly recommended that you read the hwloc(7) overview page before reading this man page. Most of the concepts described in hwloc(7) directly apply to the hwloc-calc utility.
|
hwloc-calc - Operate on cpu mask strings and objects
|
hwloc-calc [topology options] [options] <location1> [<location2> [...] ] Note that hwloc(7) provides a detailed explanation of the hwloc system and of valid <location> formats; it should be read before reading this man page. TOPOLOGY OPTIONS All topology options must be given before all other options. --no-smt, --no-smt=<N> Only keep the first PU per core in the input locations. If <N> is specified, keep the <N>-th instead, if any. PUs are ordered by physical index during this filtering. Note that this option is applied after searching locations. Hence --no-smt pu:2-5 will first select the PUs #2 to #5 in the machine before keeping one of them per core. To rather get PUs #2 to #5 after filtering one per core, you should combine invocations: hwloc-calc --restrict $(hwloc-calc --no-smt all) pu:2-5 --cpukind <n>, --cpukind <infoname>=<infovalue> Only keep PUs whose CPU kind match. Either a single CPU kind is specified as an index, or the info attribute name-value will select matching kinds. When specified by index, it corresponds to hwloc ranking of CPU kinds which returns energy-efficient cores first, and high-performance power-hungry cores last. The full list of CPU kinds may be seen with lstopo --cpukinds. Note that this option is applied after searching locations. Hence --cpukind 0 core:1 will return the second core of the machine if it is of kind 0, and nothing otherwise. To rather get the second core among those of kind 0, you should combine invocations: hwloc-calc --restrict $(hwloc-calc --cpukind 0 all) core:1 --restrict <cpuset> Restrict the topology to the given cpuset. This removes some PUs and their now-child-less parents. This is useful when combining invocations to filter some objects before selecting among them. Beware that restricting the PUs in a topology may change the logical indexes of many objects, including NUMA nodes. --restrict nodeset=<nodeset> Restrict the topology to the given nodeset (unless --restrict-flags specifies something different). This removes some NUMA nodes and their now-child-less parents. Beware that restricting the NUMA nodes in a topology may change the logical indexes of many objects, including PUs. --restrict-flags <flags> Enforce flags when restricting the topology. Flags may be given as numeric values or as a comma-separated list of flag names that are passed to hwloc_topology_restrict(). Those names may be substrings of actual flag names as long as a single one matches, for instance bynodeset,memless. The default is 0 (or none). --disallowed Include objects disallowed by administrative limitations. -i <path>, --input <path> Read the topology from <path> instead of discovering the topology of the local machine. If <path> is a file, it may be a XML file exported by a previous hwloc program. If <path> is "-", the standard input may be used as a XML file. On Linux, <path> may be a directory containing the topology files gathered from another machine topology with hwloc- gather-topology. On x86, <path> may be a directory containing a cpuid dump gathered with hwloc-gather-cpuid. When the archivemount program is available, <path> may also be a tarball containing such Linux or x86 topology files. -i <specification>, --input <specification> Simulate a fake hierarchy (instead of discovering the topology on the local machine). If <specification> is "node:2 pu:3", the topology will contain two NUMA nodes with 3 processing units in each of them. The <specification> string must end with a number of PUs. --if <format>, --input-format <format> Enforce the input in the given format, among xml, fsroot, cpuid and synthetic.
|
All these options must be given after all topology options above. -p --physical Use OS/physical indexes instead of logical indexes for both input and output. -l --logical Use logical indexes instead of physical/OS indexes for both input and output (default). --pi --physical-input Use OS/physical indexes instead of logical indexes for input. --li --logical-input Use logical indexes instead of physical/OS indexes for input (default). --po --physical-output Use OS/physical indexes instead of logical indexes for output. --lo --logical-output Use logical indexes instead of physical/OS indexes for output (default, except for cpusets which are always physical). -n --nodeset Interpret both input and output sets as nodesets instead of CPU sets. See --nodeset-output and --nodeset-input below for details. --no --nodeset-output Report nodesets instead of CPU sets. This output is more precise than the default CPU set output when memory locality matters because it properly describes CPU-less NUMA nodes, as well as NUMA-nodes that are local to multiple CPUs. --ni --nodeset-input Interpret input sets as nodesets instead of CPU sets. --oo --object-output When reporting object indexes (e.g. with -I or --local-memory), this option prefixes these indexes with types (e.g. Core:0 instead of 0). -N --number-of <type|depth> Report the number of objects of the given type or depth that intersect the CPU set. This is convenient for finding how many cores, NUMA nodes or PUs are available in a machine. When combined with --nodeset or --nodeset-output, the nodeset is considered instead of the CPU set for finding matching objects. This is useful when reporting the output as a number or set of NUMA nodes. <type may contain a filter to select specific objects among the type. For instance -N "numa[hbm]" counts NUMA nodes marked with subtype "HBM", while -N "numa[mcdram]" only counts MCDRAM NUMA nodes on KNL. If an OS device subtype such as gpu is given instead of osdev, only the os devices of that subtype will be counted. -I --intersect <type|depth> Find the list of objects of the given type or depth that intersect the CPU set and report the comma-separated list of their indexes instead of the cpu mask string. This may be used for determining the list of objects above or below the input objects. When combined with --physical, the list is convenient to pass to external tools such as taskset or numactl --physcpubind or --membind. This is different from --largest since the latter requires that all reported objects are strictly included inside the input objects. When combined with --nodeset or --nodeset-output, the nodeset is considered instead of the CPU set for finding matching objects. This is useful when reporting the output as a number or set of NUMA nodes. <type may contain a filter to select specific objects among the type. For instance -N "numa[hbm]" lists NUMA nodes marked with subtype "HBM", while -N "numa[mcdram]" only lists MCDRAM NUMA nodes on KNL. If an OS device subtype such as gpu is given instead of osdev, only the os devices of that subtype will be returned. If combined with --object-output, object indexes are prefixed with types (e.g. Core:0 instead of 0). -H --hierarchical <type1>.<type2>... Find the list of objects of type <type2> that intersect the CPU set and report the space-separated list of their hierarchical indexes with respect to <type1>, <type2>, etc. For instance, if package.core is given, the output would be Package:1.Core:2 Package:2.Core:3 if the input contains the third core of the second package and the fourth core of the third package. Only normal CPU-side object types should be used. NUMA nodes may be used but they may cause redundancy in the output on heterogeneous memory platform. For instance, on a platform with both DRAM and HBM memory on a package, the first core will be considered both as first core of first NUMA node (DRAM) and as first core of second NUMA node (HBM). --largest Report (in a human readable format) the list of largest objects which exactly include all input objects (by looking at their CPU sets). None of these output objects intersect each other, and the sum of them is exactly equivalent to the input. No larger object is included in the input. This is different from --intersect where reported objects may not be strictly included in the input. --local-memory Report the list of NUMA nodes that are local to the input objects. This option is similar to -I numa but the way nodes are selected is different: The selection performed by --local-memory may be precisely configured with --local-memory-flags, while -I numa just selects all nodes that are somehow local to any of the input objects. If combined with --object-output, object indexes are prefixed with types (e.g. NUMANode:0 instead of 0). --local-memory-flags Change the flags used to select local NUMA nodes. Flags may be given as numeric values or as a comma-separated list of flag names that are passed to hwloc_get_local_numanode_objs(). Those names may be substrings of actual flag names as long as a single one matches. The default is 3 (or smaller,larger) which means NUMA nodes are displayed if their locality either contains or is contained in the locality of the given object. This option enables --local-memory. --best-memattr <name> Enable the listing of local memory nodes with --local-memory, but only display the local node that has the best value for the memory attribute given by <name> (or as an index). If the memory attribute values depend on the initiator, the hwloc-calc input objects are used as the initiator. Standard attribute names are Capacity, Locality, Bandwidth, and Latency. All existing attributes in the current topology may be listed with $ lstopo --memattrs If combined with --object-output, the object index is prefixed with its type (e.g. NUMANode:0 instead of 0). --sep <sep> Change the field separator in the output. By default, a space is used to separate output objects (for instance when --hierarchical or --largest is given) while a comma is used to separate indexes (for instance when --intersect is given). --single Singlify the output to a single CPU. --taskset Display CPU set strings in the format recognized by the taskset command-line program instead of hwloc-specific CPU set string format. This option has no impact on the format of input CPU set strings, both formats are always accepted. -q --quiet Hide non-fatal error messages. It mostly includes locations pointing to non-existing objects. -v --verbose Verbose output. --version Report version and exit. -h --help Display help message and exit.
|
hwloc-calc's operation is best described through several examples. To display the (physical) CPU mask corresponding to the second package: $ hwloc-calc package:1 0x000000f0 To display the (physical) CPU mask corresponding to the third pacakge, excluding its even numbered logical processors: $ hwloc-calc package:2 ~PU:even 0x00000c00 To convert a cpu mask to human-readable output, the -H option can be used to emit a space-delimited list of locations: $ echo 0x000000f0 | hwloc-calc -H package.core Package:1.Core1 Package:1.Core:1 Package:1.Core:2 Package:1.Core:3 To use some other character (e.g., a comma) instead of spaces in output, use the --sep option: $ echo 0x000000f0 | hwloc-calc -H package.core --sep , Package:1.Core1,Package:1.Core:1,Package:1.Core:2,Package:1.Core:3 To combine two (physical) CPU masks: $ hwloc-calc 0x0000ffff 0xff000000 0xff00ffff To display the list of logical numbers of processors included in the second package: $ hwloc-calc --intersect PU package:1 4,5,6,7 To bind GNU OpenMP threads logically over the whole machine, we need to use physical number output instead: $ export GOMP_CPU_AFFINITY=`hwloc-calc --physical-output --intersect PU all` $ echo $GOMP_CPU_AFFINITY 0,4,1,5,2,6,3,7 To display the list of NUMA nodes, by physical indexes, that intersect a given (physical) CPU mask: $ hwloc-calc --physical --intersect NUMAnode 0xf0f0f0f0 0,2 To find how many cores are in the second CPU kind (those cores are likely higher-performance and more power-hungry than cores of the first kind): $ hwloc-calc --cpukind 1 -N core all 4 To display the list of NUMA nodes, by physical indexes, whose locality is exactly equal to a Package: $ hwloc-calc --local-memory-flags 0 --physical-output pack:1 4,7 To display the best-capacity NUMA node, by physical indexes, whose locality is exactly equal to a Package: $ hwloc-calc --local-memory-flags 0 --best-memattr capacity --physical-output pack:1 4 To find the number of NUMA nodes with subtype "HBM": $ hwloc-calc -N "numa[hbm]" all 4 To find the number of NUMA nodes in memory tier 1 (DRAM nodes on a server with HBM and DRAM): $ hwloc-calc -N "numa[tier=1]" all 4 To find the NUMA node of subtype MCDRAM (on KNL) near a PU: $ hwloc-calc -I "numa[mcdram]" pu:157 1 Converting object logical indexes (default) from/to physical/OS indexes may be performed with --intersect combined with either --physical- output (logical to physical conversion) or --physical-input (physical to logical): $ hwloc-calc --physical-output PU:2 --intersect PU 3 $ hwloc-calc --physical-input PU:3 --intersect PU 2 One should add --nodeset when converting indexes of memory objects to make sure a single NUMA node index is returned on platforms with heterogeneous memory: $ hwloc-calc --nodeset --physical-output node:2 --intersect node 3 $ hwloc-calc --nodeset --physical-input node:3 --intersect node 2 To display the set of CPUs near network interface eth0: $ hwloc-calc os=eth0 0x00005555 To display the indexes of packages near PCI device whose bus ID is 0000:01:02.0: $ hwloc-calc pci=0000:01:02.0 --intersect Package 1 To display the list of per-package cores that intersect the input: $ hwloc-calc 0x00003c00 --hierarchical package.core Package:2.Core:1 Package:3.Core:0 To display the (physical) CPU mask of the entire topology except the third package: $ hwloc-calc all ~package:3 0x0000f0ff To combine both physical and logical indexes as input: $ hwloc-calc PU:2 --physical-input PU:3 0x0000000c To synthetize a set of cores into largest objects on a 2-node 2-package 2-core machine: $ hwloc-calc core:0 --largest Core:0 $ hwloc-calc core:0-1 --largest Package:0 $ hwloc-calc core:4-7 --largest NUMANode:1 $ hwloc-calc core:2-6 --largest Package:1 Package:2 Core:6 $ hwloc-calc pack:2 --largest Package:2 $ hwloc-calc package:2-3 --largest NUMANode:1 To get the set of first threads of all cores: $ hwloc-calc core:all.pu:0 $ hwloc-calc --no-smt all This can also be very useful in order to make GNU OpenMP use exactly one thread per core, and in logical core order: $ export OMP_NUM_THREADS=`hwloc-calc --number-of core all` $ echo $OMP_NUM_THREADS 4 $ export GOMP_CPU_AFFINITY=`hwloc-calc --physical-output --intersect PU --no-smt all` $ echo $GOMP_CPU_AFFINITY 0,2,1,3 To export bitmask in a format that is acceptable by the resctrl Linux subsystem (for configuring cache partitioning, etc), apply a sed regexp to the output of hwloc-calc: $ hwloc-calc pack:all.core:7-9.pu:0 0x00000380,,0x00000380 <this format cannot be given to resctrl> $ hwloc-calc pack:all.core:7-9.pu:0 | sed -e 's/0x//g' -e 's/,,/,0,/g' -e 's/,,/,0,/g' 00000380,0,00000380 # echo 00000380,0,00000380 > /sys/fs/resctrl/test/cpus # cat /sys/fs/resctrl/test/cpus 00000000,00000380,00000000,00000380 <the modified bitmask was corrected parsed by resctrl> OS devices may also be filtered by subtype. In this example, there are 8 OS devices in the system, 4 of them are near NUMA node #1, and only 2 of these are CoProcessors: $ utils/hwloc/hwloc-calc -I osdev all 0,1,2,3,4,5,6,7,8 $ utils/hwloc/hwloc-calc -I osdev node:1 5,6,7,8 $ utils/hwloc/hwloc-calc -I coproc node:1 7,8 RETURN VALUE Upon successful execution, hwloc-calc displays the (physical) CPU mask string, (physical or logical) object list, or (physical or logical) object number list. The return value is 0. hwloc-calc will return nonzero if any kind of error occurs, such as (but not limited to): failure to parse the command line. SEE ALSO hwloc(7), lstopo(1), hwloc-info(1) 2.10.0 December 4, 2023 HWLOC-CALC(1)
|
ghostid
|
Print the numeric identifier (in hexadecimal) for the current host. --help display this help and exit --version output version information and exit AUTHOR Written by Jim Meyering. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO gethostid(3) Full documentation <https://www.gnu.org/software/coreutils/hostid> or available locally via: info '(coreutils) hostid invocation' GNU coreutils 9.3 April 2023 HOSTID(1)
|
hostid - print the numeric identifier for the current host
|
hostid [OPTION]
| null | null |
gnohup
|
Run COMMAND, ignoring hangup signals. --help display this help and exit --version output version information and exit If standard input is a terminal, redirect it from an unreadable file. If standard output is a terminal, append output to 'nohup.out' if possible, '$HOME/nohup.out' otherwise. If standard error is a terminal, redirect it to standard output. To save output to FILE, use 'nohup COMMAND > FILE'. NOTE: your shell may have its own version of nohup, which usually supersedes the version described here. Please refer to your shell's documentation for details about the options it supports. Exit status: 125 if the nohup command itself fails 126 if COMMAND is found but cannot be invoked 127 if COMMAND cannot be found - the exit status of COMMAND otherwise AUTHOR Written by Jim Meyering. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO Full documentation <https://www.gnu.org/software/coreutils/nohup> or available locally via: info '(coreutils) nohup invocation' GNU coreutils 9.3 April 2023 NOHUP(1)
|
nohup - run a command immune to hangups, with output to a non-tty
|
nohup COMMAND [ARG]... nohup OPTION
| null | null |
gtr
|
Translate, squeeze, and/or delete characters from standard input, writing to standard output. STRING1 and STRING2 specify arrays of characters ARRAY1 and ARRAY2 that control the action. -c, -C, --complement use the complement of ARRAY1 -d, --delete delete characters in ARRAY1, do not translate -s, --squeeze-repeats replace each sequence of a repeated character that is listed in the last specified ARRAY, with a single occurrence of that character -t, --truncate-set1 first truncate ARRAY1 to length of ARRAY2 --help display this help and exit --version output version information and exit ARRAYs are specified as strings of characters. Most represent themselves. Interpreted sequences are: \NNN character with octal value NNN (1 to 3 octal digits) \\ backslash \a audible BEL \b backspace \f form feed \n new line \r return \t horizontal tab \v vertical tab CHAR1-CHAR2 all characters from CHAR1 to CHAR2 in ascending order [CHAR*] in ARRAY2, copies of CHAR until length of ARRAY1 [CHAR*REPEAT] REPEAT copies of CHAR, REPEAT octal if starting with 0 [:alnum:] all letters and digits [:alpha:] all letters [:blank:] all horizontal whitespace [:cntrl:] all control characters [:digit:] all digits [:graph:] all printable characters, not including space [:lower:] all lower case letters [:print:] all printable characters, including space [:punct:] all punctuation characters [:space:] all horizontal or vertical whitespace [:upper:] all upper case letters [:xdigit:] all hexadecimal digits [=CHAR=] all characters which are equivalent to CHAR Translation occurs if -d is not given and both STRING1 and STRING2 appear. -t is only significant when translating. ARRAY2 is extended to length of ARRAY1 by repeating its last character as necessary. Excess characters of ARRAY2 are ignored. Character classes expand in unspecified order; while translating, [:lower:] and [:upper:] may be used in pairs to specify case conversion. Squeezing occurs after translation or deletion. BUGS Full support is available only for safe single-byte locales, in which every possible input byte represents a single character. The C locale is safe in GNU systems, so you can avoid this issue in the shell by running LC_ALL=C tr instead of plain tr. AUTHOR Written by Jim Meyering. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO Full documentation <https://www.gnu.org/software/coreutils/tr> or available locally via: info '(coreutils) tr invocation' GNU coreutils 9.3 April 2023 TR(1)
|
tr - translate or delete characters
|
tr [OPTION]... STRING1 [STRING2]
| null | null |
pyenv-uninstall
| null | null | null | null | null |
gen_entropy
| null | null | null | null | null |
ex
|
Vim is a text editor that is upwards compatible to Vi. It can be used to edit all kinds of plain text. It is especially useful for editing programs. There are a lot of enhancements above Vi: multi level undo, multi windows and buffers, syntax highlighting, command line editing, filename completion, on-line help, visual selection, etc.. See ":help vi_diff.txt" for a summary of the differences between Vim and Vi. While running Vim a lot of help can be obtained from the on-line help system, with the ":help" command. See the ON-LINE HELP section below. Most often Vim is started to edit a single file with the command vim file More generally Vim is started with: vim [options] [filelist] If the filelist is missing, the editor will start with an empty buffer. Otherwise exactly one out of the following four may be used to choose one or more files to be edited. file .. A list of filenames. The first one will be the current file and read into the buffer. The cursor will be positioned on the first line of the buffer. You can get to the other files with the ":next" command. To edit a file that starts with a dash, precede the filelist with "--". - The file to edit is read from stdin. Commands are read from stderr, which should be a tty. -t {tag} The file to edit and the initial cursor position depends on a "tag", a sort of goto label. {tag} is looked up in the tags file, the associated file becomes the current file and the associated command is executed. Mostly this is used for C programs, in which case {tag} could be a function name. The effect is that the file containing that function becomes the current file and the cursor is positioned on the start of the function. See ":help tag-commands". -q [errorfile] Start in quickFix mode. The file [errorfile] is read and the first error is displayed. If [errorfile] is omitted, the filename is obtained from the 'errorfile' option (defaults to "AztecC.Err" for the Amiga, "errors.err" on other systems). Further errors can be jumped to with the ":cn" command. See ":help quickfix". Vim behaves differently, depending on the name of the command (the executable may still be the same file). vim The "normal" way, everything is default. ex Start in Ex mode. Go to Normal mode with the ":vi" command. Can also be done with the "-e" argument. view Start in read-only mode. You will be protected from writing the files. Can also be done with the "-R" argument. gvim gview The GUI version. Starts a new window. Can also be done with the "-g" argument. evim eview The GUI version in easy mode. Starts a new window. Can also be done with the "-y" argument. rvim rview rgvim rgview Like the above, but with restrictions. It will not be possible to start shell commands, or suspend Vim. Can also be done with the "-Z" argument.
|
vim - Vi IMproved, a programmer's text editor
|
vim [options] [file ..] vim [options] - vim [options] -t tag vim [options] -q [errorfile] ex view gvim gview evim eview rvim rview rgvim rgview
|
The options may be given in any order, before or after filenames. Options without an argument can be combined after a single dash. +[num] For the first file the cursor will be positioned on line "num". If "num" is missing, the cursor will be positioned on the last line. +/{pat} For the first file the cursor will be positioned in the line with the first occurrence of {pat}. See ":help search-pattern" for the available search patterns. +{command} -c {command} {command} will be executed after the first file has been read. {command} is interpreted as an Ex command. If the {command} contains spaces it must be enclosed in double quotes (this depends on the shell that is used). Example: vim "+set si" main.c Note: You can use up to 10 "+" or "-c" commands. -S {file} {file} will be sourced after the first file has been read. This is equivalent to -c "source {file}". {file} cannot start with '-'. If {file} is omitted "Session.vim" is used (only works when -S is the last argument). --cmd {command} Like using "-c", but the command is executed just before processing any vimrc file. You can use up to 10 of these commands, independently from "-c" commands. -A If Vim has been compiled with ARABIC support for editing right-to-left oriented files and Arabic keyboard mapping, this option starts Vim in Arabic mode, i.e. 'arabic' is set. Otherwise an error message is given and Vim aborts. -b Binary mode. A few options will be set that makes it possible to edit a binary or executable file. -C Compatible. Set the 'compatible' option. This will make Vim behave mostly like Vi, even though a .vimrc file exists. -d Start in diff mode. There should between two to eight file name arguments. Vim will open all the files and show differences between them. Works like vimdiff(1). -d {device}, -dev {device} Open {device} for use as a terminal. Only on the Amiga. Example: "-d con:20/30/600/150". -D Debugging. Go to debugging mode when executing the first command from a script. -e Start Vim in Ex mode, just like the executable was called "ex". -E Start Vim in improved Ex mode, just like the executable was called "exim". -f Foreground. For the GUI version, Vim will not fork and detach from the shell it was started in. On the Amiga, Vim is not restarted to open a new window. This option should be used when Vim is executed by a program that will wait for the edit session to finish (e.g. mail). On the Amiga the ":sh" and ":!" commands will not work. --nofork Foreground. For the GUI version, Vim will not fork and detach from the shell it was started in. -F If Vim has been compiled with FKMAP support for editing right-to-left oriented files and Farsi keyboard mapping, this option starts Vim in Farsi mode, i.e. 'fkmap' and 'rightleft' are set. Otherwise an error message is given and Vim aborts. -g If Vim has been compiled with GUI support, this option enables the GUI. If no GUI support was compiled in, an error message is given and Vim aborts. --gui-dialog-file {name} When using the GUI, instead of showing a dialog, write the title and message of the dialog to file {name}. The file is created or appended to. Only useful for testing, to avoid that the test gets stuck on a dialog that can't be seen. Without the GUI the argument is ignored. --help, -h, -? Give a bit of help about the command line arguments and options. After this Vim exits. -H If Vim has been compiled with RIGHTLEFT support for editing right-to-left oriented files and Hebrew keyboard mapping, this option starts Vim in Hebrew mode, i.e. 'hkmap' and 'rightleft' are set. Otherwise an error message is given and Vim aborts. -i {viminfo} Specifies the filename to use when reading or writing the viminfo file, instead of the default "~/.viminfo". This can also be used to skip the use of the .viminfo file, by giving the name "NONE". -L Same as -r. -l Lisp mode. Sets the 'lisp' and 'showmatch' options on. -m Modifying files is disabled. Resets the 'write' option. You can still modify the buffer, but writing a file is not possible. -M Modifications not allowed. The 'modifiable' and 'write' options will be unset, so that changes are not allowed and files can not be written. Note that these options can be set to enable making modifications. -N No-compatible mode. Resets the 'compatible' option. This will make Vim behave a bit better, but less Vi compatible, even though a .vimrc file does not exist. -n No swap file will be used. Recovery after a crash will be impossible. Handy if you want to edit a file on a very slow medium (e.g. floppy). Can also be done with ":set uc=0". Can be undone with ":set uc=200". -nb Become an editor server for NetBeans. See the docs for details. -o[N] Open N windows stacked. When N is omitted, open one window for each file. -O[N] Open N windows side by side. When N is omitted, open one window for each file. -p[N] Open N tab pages. When N is omitted, open one tab page for each file. -P {parent-title} Win32 GUI only: Specify the title of the parent application. When possible, Vim will run in an MDI window inside the application. {parent-title} must appear in the window title of the parent application. Make sure that it is specific enough. Note that the implementation is still primitive. It won't work with all applications and the menu doesn't work. -R Read-only mode. The 'readonly' option will be set. You can still edit the buffer, but will be prevented from accidentally overwriting a file. If you do want to overwrite a file, add an exclamation mark to the Ex command, as in ":w!". The -R option also implies the -n option (see above). The 'readonly' option can be reset with ":set noro". See ":help 'readonly'". -r List swap files, with information about using them for recovery. -r {file} Recovery mode. The swap file is used to recover a crashed editing session. The swap file is a file with the same filename as the text file with ".swp" appended. See ":help recovery". -s Silent mode. Only when started as "Ex" or when the "-e" option was given before the "-s" option. -s {scriptin} The script file {scriptin} is read. The characters in the file are interpreted as if you had typed them. The same can be done with the command ":source! {scriptin}". If the end of the file is reached before the editor exits, further characters are read from the keyboard. -T {terminal} Tells Vim the name of the terminal you are using. Only required when the automatic way doesn't work. Should be a terminal known to Vim (builtin) or defined in the termcap or terminfo file. --not-a-term Tells Vim that the user knows that the input and/or output is not connected to a terminal. This will avoid the warning and the two second delay that would happen. --ttyfail When stdin or stdout is not a a terminal (tty) then exit right away. -u {vimrc} Use the commands in the file {vimrc} for initializations. All the other initializations are skipped. Use this to edit a special kind of files. It can also be used to skip all initializations by giving the name "NONE". See ":help initialization" within vim for more details. -U {gvimrc} Use the commands in the file {gvimrc} for GUI initializations. All the other GUI initializations are skipped. It can also be used to skip all GUI initializations by giving the name "NONE". See ":help gui-init" within vim for more details. -V[N] Verbose. Give messages about which files are sourced and for reading and writing a viminfo file. The optional number N is the value for 'verbose'. Default is 10. -V[N]{filename} Like -V and set 'verbosefile' to {filename}. The result is that messages are not displayed but written to the file {filename}. {filename} must not start with a digit. --log {filename} If Vim has been compiled with eval and channel feature, start logging and write entries to {filename}. This works like calling ch_logfile({filename}, 'ao') very early during startup. -v Start Vim in Vi mode, just like the executable was called "vi". This only has effect when the executable is called "ex". -w{number} Set the 'window' option to {number}. -w {scriptout} All the characters that you type are recorded in the file {scriptout}, until you exit Vim. This is useful if you want to create a script file to be used with "vim -s" or ":source!". If the {scriptout} file exists, characters are appended. -W {scriptout} Like -w, but an existing file is overwritten. -x Use encryption when writing files. Will prompt for a crypt key. -X Don't connect to the X server. Shortens startup time in a terminal, but the window title and clipboard will not be used. -y Start Vim in easy mode, just like the executable was called "evim" or "eview". Makes Vim behave like a click-and-type editor. -Z Restricted mode. Works like the executable starts with "r". -- Denotes the end of the options. Arguments after this will be handled as a file name. This can be used to edit a filename that starts with a '-'. --clean Do not use any personal configuration (vimrc, plugins, etc.). Useful to see if a problem reproduces with a clean Vim setup. --echo-wid GTK GUI only: Echo the Window ID on stdout. --literal Take file name arguments literally, do not expand wildcards. This has no effect on Unix where the shell expands wildcards. --noplugin Skip loading plugins. Implied by -u NONE. --remote Connect to a Vim server and make it edit the files given in the rest of the arguments. If no server is found a warning is given and the files are edited in the current Vim. --remote-expr {expr} Connect to a Vim server, evaluate {expr} in it and print the result on stdout. --remote-send {keys} Connect to a Vim server and send {keys} to it. --remote-silent As --remote, but without the warning when no server is found. --remote-wait As --remote, but Vim does not exit until the files have been edited. --remote-wait-silent As --remote-wait, but without the warning when no server is found. --serverlist List the names of all Vim servers that can be found. --servername {name} Use {name} as the server name. Used for the current Vim, unless used with a --remote argument, then it's the name of the server to connect to. --socketid {id} GTK GUI only: Use the GtkPlug mechanism to run gvim in another window. --startuptime {file} During startup write timing messages to the file {fname}. --version Print version information and exit. --windowid {id} Win32 GUI only: Make gvim try to use the window {id} as a parent, so that it runs inside that window. ON-LINE HELP Type ":help" in Vim to get started. Type ":help subject" to get help on a specific subject. For example: ":help ZZ" to get help for the "ZZ" command. Use <Tab> and CTRL-D to complete subjects (":help cmdline-completion"). Tags are present to jump from one place to another (sort of hypertext links, see ":help"). All documentation files can be viewed in this way, for example ":help syntax.txt". FILES /usr/local/share/vim/vim??/doc/*.txt The Vim documentation files. Use ":help doc-file-list" to get the complete list. vim?? is short version number, like vim91 for Vim 9.1 /usr/local/share/vim/vim??/doc/tags The tags file used for finding information in the documentation files. /usr/local/share/vim/vim??/syntax/syntax.vim System wide syntax initializations. /usr/local/share/vim/vim??/syntax/*.vim Syntax files for various languages. /usr/local/share/vim/vimrc System wide Vim initializations. ~/.vimrc, ~/.vim/vimrc, $XDG_CONFIG_HOME/vim/vimrc Your personal Vim initializations (first one found is used). /usr/local/share/vim/gvimrc System wide gvim initializations. ~/.gvimrc, ~/.vim/gvimrc, $XDG_CONFIG_HOME/vim/gvimrc Your personal gvim initializations (first one found is used). /usr/local/share/vim/vim??/optwin.vim Script used for the ":options" command, a nice way to view and set options. /usr/local/share/vim/vim??/menu.vim System wide menu initializations for gvim. /usr/local/share/vim/vim??/bugreport.vim Script to generate a bug report. See ":help bugs". /usr/local/share/vim/vim??/filetype.vim Script to detect the type of a file by its name. See ":help 'filetype'". /usr/local/share/vim/vim??/scripts.vim Script to detect the type of a file by its contents. See ":help 'filetype'". /usr/local/share/vim/vim??/print/*.ps Files used for PostScript printing. For recent info read the VIM home page: <URL:http://www.vim.org/> SEE ALSO vimtutor(1) AUTHOR Most of Vim was made by Bram Moolenaar, with a lot of help from others. See ":help credits" in Vim. Vim is based on Stevie, worked on by: Tim Thompson, Tony Andrews and G.R. (Fred) Walter. Although hardly any of the original code remains. BUGS Probably. See ":help todo" for a list of known problems. Note that a number of things that may be regarded as bugs by some, are in fact caused by a too-faithful reproduction of Vi's behaviour. And if you think other things are bugs "because Vi does it differently", you should take a closer look at the vi_diff.txt file (or type :help vi_diff.txt when in Vim). Also have a look at the 'compatible' and 'cpoptions' options. 2024 Jun 04 VIM(1)
| null |
gdirname
|
Output each NAME with its last non-slash component and trailing slashes removed; if NAME contains no /'s, output '.' (meaning the current directory). -z, --zero end each output line with NUL, not newline --help display this help and exit --version output version information and exit
|
dirname - strip last component from file name
|
dirname [OPTION] NAME...
| null |
dirname /usr/bin/ -> "/usr" dirname dir1/str dir2/str -> "dir1" followed by "dir2" dirname stdio.h -> "." AUTHOR Written by David MacKenzie and Jim Meyering. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO basename(1), readlink(1) Full documentation <https://www.gnu.org/software/coreutils/dirname> or available locally via: info '(coreutils) dirname invocation' GNU coreutils 9.3 April 2023 DIRNAME(1)
|
baddbdir
| null | null | null | null | null |
perlbug
|
This program is designed to help you generate bug reports (and thank- you notes) about perl5 and the modules which ship with it. In most cases, you can just run it interactively from a command line without any special arguments and follow the prompts. If you have found a bug with a non-standard port (one that was not part of the standard distribution), a binary distribution, or a non-core module (such as Tk, DBI, etc), then please see the documentation that came with that distribution to determine the correct place to report bugs. Bug reports should be submitted to the GitHub issue tracker at <https://github.com/Perl/perl5/issues>. The perlbug@perl.org address no longer automatically opens tickets. You can use this tool to compose your report and save it to a file which you can then submit to the issue tracker. In extreme cases, perlbug may not work well enough on your system to guide you through composing a bug report. In those cases, you may be able to use perlbug -d or perl -V to get system configuration information to include in your issue report. When reporting a bug, please run through this checklist: What version of Perl you are running? Type "perl -v" at the command line to find out. Are you running the latest released version of perl? Look at <http://www.perl.org/> to find out. If you are not using the latest released version, please try to replicate your bug on the latest stable release. Note that reports about bugs in old versions of Perl, especially those which indicate you haven't also tested the current stable release of Perl, are likely to receive less attention from the volunteers who build and maintain Perl than reports about bugs in the current release. Are you sure what you have is a bug? A significant number of the bug reports we get turn out to be documented features in Perl. Make sure the issue you've run into isn't intentional by glancing through the documentation that comes with the Perl distribution. Given the sheer volume of Perl documentation, this isn't a trivial undertaking, but if you can point to documentation that suggests the behaviour you're seeing is wrong, your issue is likely to receive more attention. You may want to start with perldoc perltrap for pointers to common traps that new (and experienced) Perl programmers run into. If you're unsure of the meaning of an error message you've run across, perldoc perldiag for an explanation. If the message isn't in perldiag, it probably isn't generated by Perl. You may have luck consulting your operating system documentation instead. If you are on a non-UNIX platform perldoc perlport, as some features may be unimplemented or work differently. You may be able to figure out what's going wrong using the Perl debugger. For information about how to use the debugger perldoc perldebug. Do you have a proper test case? The easier it is to reproduce your bug, the more likely it will be fixed -- if nobody can duplicate your problem, it probably won't be addressed. A good test case has most of these attributes: short, simple code; few dependencies on external commands, modules, or libraries; no platform-dependent code (unless it's a platform-specific bug); clear, simple documentation. A good test case is almost always a good candidate to be included in Perl's test suite. If you have the time, consider writing your test case so that it can be easily included into the standard test suite. Have you included all relevant information? Be sure to include the exact error messages, if any. "Perl gave an error" is not an exact error message. If you get a core dump (or equivalent), you may use a debugger (dbx, gdb, etc) to produce a stack trace to include in the bug report. NOTE: unless your Perl has been compiled with debug info (often -g), the stack trace is likely to be somewhat hard to use because it will most probably contain only the function names and not their arguments. If possible, recompile your Perl with debug info and reproduce the crash and the stack trace. Can you describe the bug in plain English? The easier it is to understand a reproducible bug, the more likely it will be fixed. Any insight you can provide into the problem will help a great deal. In other words, try to analyze the problem (to the extent you can) and report your discoveries. Can you fix the bug yourself? If so, that's great news; bug reports with patches are likely to receive significantly more attention and interest than those without patches. Please submit your patch via the GitHub Pull Request workflow as described in perldoc perlhack. You may also send patches to perl5-porters@perl.org. When sending a patch, create it using "git format-patch" if possible, though a unified diff created with "diff -pu" will do nearly as well. Your patch may be returned with requests for changes, or requests for more detailed explanations about your fix. Here are a few hints for creating high-quality patches: Make sure the patch is not reversed (the first argument to diff is typically the original file, the second argument your changed file). Make sure you test your patch by applying it with "git am" or the "patch" program before you send it on its way. Try to follow the same style as the code you are trying to patch. Make sure your patch really does work ("make test", if the thing you're patching is covered by Perl's test suite). Can you use "perlbug" to submit a thank-you note? Yes, you can do this by either using the "-T" option, or by invoking the program as "perlthanks". Thank-you notes are good. It makes people smile. Please make your issue title informative. "a bug" is not informative. Neither is "perl crashes" nor is "HELP!!!". These don't help. A compact description of what's wrong is fine. Having done your bit, please be prepared to wait, to be told the bug is in your code, or possibly to get no reply at all. The volunteers who maintain Perl are busy folks, so if your problem is an obvious bug in your own code, is difficult to understand or is a duplicate of an existing report, you may not receive a personal reply. If it is important to you that your bug be fixed, do monitor the issue tracker (you will be subscribed to notifications for issues you submit or comment on) and the commit logs to development versions of Perl, and encourage the maintainers with kind words or offers of frosty beverages. (Please do be kind to the maintainers. Harassing or flaming them is likely to have the opposite effect of the one you want.) Feel free to update the ticket about your bug on <https://github.com/Perl/perl5/issues> if a new version of Perl is released and your bug is still present.
|
perlbug - how to submit bug reports on Perl
|
perlbug perlbug [ -v ] [ -a address ] [ -s subject ] [ -b body | -f inputfile ] [ -F outputfile ] [ -r returnaddress ] [ -e editor ] [ -c adminaddress | -C ] [ -S ] [ -t ] [ -d ] [ -h ] [ -T ] perlbug [ -v ] [ -r returnaddress ] [ -ok | -okay | -nok | -nokay ] perlthanks
|
-a Address to send the report to instead of saving to a file. -b Body of the report. If not included on the command line, or in a file with -f, you will get a chance to edit the report. -C Don't send copy to administrator when sending report by mail. -c Address to send copy of report to when sending report by mail. Defaults to the address of the local perl administrator (recorded when perl was built). -d Data mode (the default if you redirect or pipe output). This prints out your configuration data, without saving or mailing anything. You can use this with -v to get more complete data. -e Editor to use. -f File containing the body of the report. Use this to quickly send a prepared report. -F File to output the results to. Defaults to perlbug.rep. -h Prints a brief summary of the options. -ok Report successful build on this system to perl porters. Forces -S and -C. Forces and supplies values for -s and -b. Only prompts for a return address if it cannot guess it (for use with make). Honors return address specified with -r. You can use this with -v to get more complete data. Only makes a report if this system is less than 60 days old. -okay As -ok except it will report on older systems. -nok Report unsuccessful build on this system. Forces -C. Forces and supplies a value for -s, then requires you to edit the report and say what went wrong. Alternatively, a prepared report may be supplied using -f. Only prompts for a return address if it cannot guess it (for use with make). Honors return address specified with -r. You can use this with -v to get more complete data. Only makes a report if this system is less than 60 days old. -nokay As -nok except it will report on older systems. -p The names of one or more patch files or other text attachments to be included with the report. Multiple files must be separated with commas. -r Your return address. The program will ask you to confirm its default if you don't use this option. -S Save or send the report without asking for confirmation. -s Subject to include with the report. You will be prompted if you don't supply one on the command line. -t Test mode. Makes it possible to command perlbug from a pipe or file, for testing purposes. -T Send a thank-you note instead of a bug report. -v Include verbose configuration data in the report. AUTHORS Kenneth Albanowski (<kjahds@kjahds.com>), subsequently doctored by Gurusamy Sarathy (<gsar@activestate.com>), Tom Christiansen (<tchrist@perl.com>), Nathan Torkington (<gnat@frii.com>), Charles F. Randall (<cfr@pobox.com>), Mike Guy (<mjtg@cam.ac.uk>), Dominic Dunlop (<domo@computer.org>), Hugo van der Sanden (<hv@crypt.org>), Jarkko Hietaniemi (<jhi@iki.fi>), Chris Nandor (<pudge@pobox.com>), Jon Orwant (<orwant@media.mit.edu>, Richard Foley (<richard.foley@rfi.net>), Jesse Vincent (<jesse@bestpractical.com>), and Craig A. Berry (<craigberry@mac.com>). SEE ALSO perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1), diff(1), patch(1), dbx(1), gdb(1) BUGS None known (guess what must have been used to report them?) perl v5.38.2 2023-11-28 PERLBUG(1)
| null |
xzfgrep
|
xzgrep invokes grep(1) on uncompressed contents of files. The formats of the files are determined from the filename suffixes. Any file with a suffix supported by xz(1), gzip(1), bzip2(1), lzop(1), zstd(1), or lz4(1) will be decompressed; all other files are assumed to be uncompressed. If no files are specified or file is - then standard input is read. When reading from standard input, only files supported by xz(1) are decompressed. Other files are assumed to be in uncompressed form already. Most options of grep(1) are supported. However, the following options are not supported: -r, --recursive -R, --dereference-recursive -d, --directories=action -Z, --null -z, --null-data --include=glob --exclude=glob --exclude-from=file --exclude-dir=glob xzegrep is an alias for xzgrep -E. xzfgrep is an alias for xzgrep -F. The commands lzgrep, lzegrep, and lzfgrep are provided for backward compatibility with LZMA Utils. EXIT STATUS 0 At least one match was found from at least one of the input files. No errors occurred. 1 No matches were found from any of the input files. No errors occurred. >1 One or more errors occurred. It is unknown if matches were found. ENVIRONMENT GREP If GREP is set to a non-empty value, it is used instead of grep, grep -E, or grep -F. SEE ALSO grep(1), xz(1), gzip(1), bzip2(1), lzop(1), zstd(1), lz4(1), zgrep(1) Tukaani 2024-02-13 XZGREP(1)
|
xzgrep - search possibly-compressed files for patterns
|
xzgrep [option...] [pattern_list] [file...] xzegrep ... xzfgrep ... lzgrep ... lzegrep ... lzfgrep ...
| null | null |
pasteurize
| null | null | null | null | null |
gsha384sum
|
Print or check SHA384 (384-bit) checksums. With no FILE, or when FILE is -, read standard input. -b, --binary read in binary mode -c, --check read checksums from the FILEs and check them --tag create a BSD-style checksum -t, --text read in text mode (default) -z, --zero end each output line with NUL, not newline, and disable file name escaping The following five options are useful only when verifying checksums: --ignore-missing don't fail or report status for missing files --quiet don't print OK for each successfully verified file --status don't output anything, status code shows success --strict exit non-zero for improperly formatted checksum lines -w, --warn warn about improperly formatted checksum lines --help display this help and exit --version output version information and exit The sums are computed as described in FIPS-180-2. When checking, the input should be a former output of this program. The default mode is to print a line with: checksum, a space, a character indicating input mode ('*' for binary, ' ' for text or where binary is insignificant), and name for each FILE. Note: There is no difference between binary mode and text mode on GNU systems. AUTHOR Written by Ulrich Drepper, Scott Miller, and David Madore. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO cksum(1) Full documentation <https://www.gnu.org/software/coreutils/sha384sum> or available locally via: info '(coreutils) sha2 utilities' GNU coreutils 9.3 April 2023 SHA384SUM(1)
|
sha384sum - compute and check SHA384 message digest
|
sha384sum [OPTION]... [FILE]...
| null | null |
gchroot
|
Run COMMAND with root directory set to NEWROOT. --groups=G_LIST specify supplementary groups as g1,g2,..,gN --userspec=USER:GROUP specify user and group (ID or name) to use --skip-chdir do not change working directory to '/' --help display this help and exit --version output version information and exit If no command is given, run '"$SHELL" -i' (default: '/bin/sh -i'). Exit status: 125 if the chroot command itself fails 126 if COMMAND is found but cannot be invoked 127 if COMMAND cannot be found - the exit status of COMMAND otherwise AUTHOR Written by Roland McGrath. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO chroot(2) Full documentation <https://www.gnu.org/software/coreutils/chroot> or available locally via: info '(coreutils) chroot invocation' GNU coreutils 9.3 April 2023 CHROOT(1)
|
chroot - run command or interactive shell with special root directory
|
chroot [OPTION] NEWROOT [COMMAND [ARG]...] chroot OPTION
| null | null |
slencheck
| null | null | null | null | null |
rust-gdbgui
| null | null | null | null | null |
webpinfo
|
This manual page documents the webpinfo command. webpinfo can be used to print out the chunk level structure and bitstream header information of WebP files. It can also check if the files are of valid WebP format.
|
webpinfo - print out the chunk level structure of WebP files along with basic integrity checks.
|
webpinfo OPTIONS INPUT webpinfo [-h|-help|-H|-longhelp]
|
-version Print the version number (as major.minor.revision) and exit. -quiet Do not show chunk parsing information. -diag Show parsing error diagnosis. -summary Show chunk stats summary. -bitstream_info Parse bitstream header. -h, -help A short usage summary. -H, -longhelp Detailed usage instructions. INPUT Input files in WebP format. Input files must come last, following options (if any). There can be multiple input files. BUGS Please report all bugs to the issue tracker: https://bugs.chromium.org/p/webp Patches welcome! See this page to get started: https://www.webmproject.org/code/contribute/submitting-patches/
|
webpinfo -h webpinfo -diag -summary input_file.webp webpinfo -bitstream_info input_file_1.webp input_file_2.webp webpinfo *.webp AUTHORS webpinfo is a part of libwebp and was written by the WebP team. The latest source tree is available at https://chromium.googlesource.com/webm/libwebp This manual page was written by Hui Su <huisu@google.com>, for the Debian project (and may be used by others). SEE ALSO webpmux(1) Please refer to https://developers.google.com/speed/webp/ for additional information. November 17, 2021 WEBPINFO(1)
|
shlibsign
| null | null | null | null | null |
piconv
|
piconv is perl version of iconv, a character encoding converter widely available for various Unixen today. This script was primarily a technology demonstrator for Perl 5.8.0, but you can use piconv in the place of iconv for virtually any case. piconv converts the character encoding of either STDIN or files specified in the argument and prints out to STDOUT. Here is the list of options. Some options can be in short format (-f) or long (--from) one. -f,--from from_encoding Specifies the encoding you are converting from. Unlike iconv, this option can be omitted. In such cases, the current locale is used. -t,--to to_encoding Specifies the encoding you are converting to. Unlike iconv, this option can be omitted. In such cases, the current locale is used. Therefore, when both -f and -t are omitted, piconv just acts like cat. -s,--string string uses string instead of file for the source of text. -l,--list Lists all available encodings, one per line, in case-insensitive order. Note that only the canonical names are listed; many aliases exist. For example, the names are case-insensitive, and many standard and common aliases work, such as "latin1" for "ISO-8859-1", or "ibm850" instead of "cp850", or "winlatin1" for "cp1252". See Encode::Supported for a full discussion. -r,--resolve encoding_alias Resolve encoding_alias to Encode canonical encoding name. -C,--check N Check the validity of the stream if N = 1. When N = -1, something interesting happens when it encounters an invalid character. -c Same as "-C 1". -p,--perlqq Transliterate characters missing in encoding to \x{HHHH} where HHHH is the hexadecimal Unicode code point. --htmlcref Transliterate characters missing in encoding to &#NNN; where NNN is the decimal Unicode code point. --xmlcref Transliterate characters missing in encoding to &#xHHHH; where HHHH is the hexadecimal Unicode code point. -h,--help Show usage. -D,--debug Invokes debugging mode. Primarily for Encode hackers. -S,--scheme scheme Selects which scheme is to be used for conversion. Available schemes are as follows: from_to Uses Encode::from_to for conversion. This is the default. decode_encode Input strings are decode()d then encode()d. A straight two- step implementation. perlio The new perlIO layer is used. NI-S' favorite. You should use this option if you are using UTF-16 and others which linefeed is not $/. Like the -D option, this is also for Encode hackers. SEE ALSO iconv(1) locale(3) Encode Encode::Supported Encode::Alias PerlIO perl v5.38.2 2023-11-28 PICONV(1)
|
piconv -- iconv(1), reinvented in perl
|
piconv [-f from_encoding] [-t to_encoding] [-p|--perlqq|--htmlcref|--xmlcref] [-C N|-c] [-D] [-S scheme] [-s string|file...] piconv -l piconv -r encoding_alias piconv -h
| null | null |
pk12util
| null | null | null | null | null |
gdtopng
| null | null | null | null | null |
hwloc-info
|
hwloc-info displays information about the specified object. It is intended to be used with tools such as grep for filtering certain attribute lines. When no object is specified, or when --topology is passed, hwloc-info prints a summary of the topology. When --support is passed, hwloc-info lists the supported features for the topology. Objects may be specified as location tuples, as explained in hwloc(7). However hexadecimal bitmasks are not accepted since they may correspond to multiple objects. NOTE: It is highly recommended that you read the hwloc(7) overview page before reading this man page. Most of the concepts described in hwloc(7) directly apply to the hwloc-calc utility.
|
hwloc-info - Show some information about some objects or about a topology or about support features
|
hwloc-info [ options ]... <object>... hwloc-info [ options ]... Note that hwloc(7) provides a detailed explanation of the hwloc system and of valid <object> formats; it should be read before reading this man page.
|
--objects Report information specific objects. This is the default if some objects are given on the command-line. --topology Report a summary of the topology instead of about some specific objects. This is the default if no object is given on the command-line. --support Report the features that are supported by hwloc on the topology. The features are those available through the hwloc_topology_get_support() function. This is useful for verifying which CPU or memory binding options are supported by the current hwloc installation. -i <path>, --input <path> Read the topology from <path> instead of discovering the topology of the local machine. If <path> is a file, it may be a XML file exported by a previous hwloc program. If <path> is "-", the standard input may be used as a XML file. On Linux, <path> may be a directory containing the topology files gathered from another machine topology with hwloc-gather- topology. On x86, <path> may be a directory containing a cpuid dump gathered with hwloc-gather-cpuid. When the archivemount program is available, <path> may also be a tarball containing such Linux or x86 topology files. -i <specification>, --input <specification> Simulate a fake hierarchy (instead of discovering the topology on the local machine). If <specification> is "node:2 pu:3", the topology will contain two NUMA nodes with 3 processing units in each of them. The <specification> string must end with a number of PUs. --if <format>, --input-format <format> Enforce the input in the given format, among xml, fsroot, cpuid and synthetic. -v --verbose Include additional detail. -q --quiet -s --silent Reduce the amount of details to show. A single summary line per object is displayed. --ancestors Display information about the object as well as about all its ancestors up to the root of the topology. This is identical to --ancestor all --ancestor <type> Only display the object ancestors that match the given type. Some special values matching multiple types may also be given: kind=normal (CPU objects, including caches), kind=cpu (CPU objects, excluding caches), kind=cache (all caches, including memory-side caches), kind=memory (NUMA nodes or memory-side caches), kind=io (IO objects), kind=all (all objects). See also Object Kind in Terms and Definitions in the documentation. The prefix kind= may be omitted if there is no ambiguity. If multiple ancestors match, they are reported from the deepest to the highest in the topology. Adding --first will only show the first one. --children Display information about the object children. --descendants <type> Display information about the object descendants that match the given type. Some special values matching multiple types may also be given: kind=normal (CPU objects, including caches), kind=cpu (CPU objects, excluding caches), kind=cache (all caches, including memory-side caches), kind=memory (NUMA nodes or memory-side caches), kind=io (IO objects), kind=all (all objects). See also Object Kind in Terms and Definitions in the documentation. The prefix kind= may be omitted if there is no ambiguity. If multiple objects match, they are reported in a depth-first order (first child, then its children, etc., then second child, etc.). Adding --first will only show the first one. --local-memory Display information about the NUMA nodes that are local to the given object. --local-memory-flags Change the flags used to select local NUMA nodes. Flags may be given as numeric values or as a comma-separated list of flag names that are passed to hwloc_get_local_numanode_objs(). Those names may be substrings of actual flag names as long as a single one matches. The default is 3 (or smaller,larger) which means NUMA nodes are displayed if their locality either contains or is contained in the locality of the given object. This option enables --local-memory. --best-memattr <name> Enable the listing local memory nodes with --local-memory, but only display the local node that has the best value for the memory attribute given by <name> (or as an index). If the memory attribute values depend on the initiator, the object given to hwloc-info is used as the initiator. --first For each input object, only report the first matching output object (first ancestor, first child, etc.). -n When outputting object information, prefix each line with the index of the considered object within the input. For instance, if three cores were given in input, the output lines will be prefixed with "0: ", "1: " or "2: ". If --ancestor is also used, the prefix will be "X.Y: " where X is the index of the considered object within the input, and Y is the parent index (0 for the object itself, increasing towards the root of the topology). --disallowed Include objects disallowed by administrative limitations. --restrict <cpuset> Restrict the topology to the given cpuset. This removes some PUs and their now-child-less parents. Beware that restricting the PUs in a topology may change the logical indexes of many objects, including NUMA nodes. --restrict nodeset=<nodeset> Restrict the topology to the given nodeset (unless --restrict-flags specifies something different). This removes some NUMA nodes and their now-child-less parents. Beware that restricting the NUMA nodes in a topology may change the logical indexes of many objects, including PUs. --restrict binding Restrict the topology to the current process binding. This option requires the use of the actual current machine topology (or any other topology with --thissystem or with HWLOC_THISSYSTEM set to 1 in the environment). Beware that restricting the topology may change the logical indexes of many objects, including PUs and NUMA nodes. --restrict-flags <flags> Enforce flags when restricting the topology. Flags may be given as numeric values or as a comma-separated list of flag names that are passed to hwloc_topology_restrict(). Those names may be substrings of actual flag names as long as a single one matches, for instance bynodeset,memless. The default is 0 (or none). --filter <type>:<kind>, --filter <type> Filter objects of type <type>, or of any type if <type> is "all". "io", "cache" and "icache" are also supported. <kind> specifies the filtering behavior. If "none" or not specified, all objects of the given type are removed. If "all", all objects are kept as usual. If "structure", objects are kept when they bring structure to the topology. If "important" (only applicable to I/O and Misc), only important objects are kept. See hwloc_topology_set_type_filter() for more details. --no-icaches Do not show Instruction caches, only Data and Unified caches are considered. This is identical to --filter icache:none. --no-io Do not show any I/O device or bridge. This is identical to --filter io:none. By default, common devices (GPUs, NICs, block devices, ...) and interesting bridges are shown. --no-bridges Do not show any I/O bridge except hostbridges. This is identical to --filter bridge:none. By default, common devices (GPUs, NICs, block devices, ...) and interesting bridges are shown. --whole-io Show all I/O devices and bridges. This is identical to --filter io:all. By default, only common devices (GPUs, NICs, block devices, ...) and interesting bridges are shown. --thissystem Assume that the selected backend provides the topology for the system on which we are running. This is useful when using --restrict binding and loading a custom topology such as an XML file. --pid <pid> Detect topology as seen by process <pid>, i.e. as if process <pid> did the discovery itself. Note that this can for instance change the set of allowed processors. Also show this process current CPU binding by marking the corresponding PUs (in Green in the graphical output, see the COLORS section below, or by appending (binding) to the verbose text output). If 0 is given as pid, the current binding for the lstopo process will be shown. -p --physical Use OS/physical indexes instead of logical indexes for input. -l --logical Use logical indexes instead of physical/OS indexes for input (default). --version Report version and exit. -h --help Display help message and exit.
|
To display information about each package: $ hwloc-info package:all Package L#0 logical index = 0 ... To display information about the core whose physical index is 2: $ hwloc-info -p core:2 Core L#1 logical index = 1 os index = 2 ... To list the OS devices that are of subtype OpenCL: $ hwloc-info -s "os[OpenCL]:all" CoProc:6 CoProc:8 To list the NUMA nodes that are local a PU: $ hwloc-info --local-memory pu:25 NUMANode L#6 = local memory #0 of PU L#25 type = NUMANode ... NUMANode L#7 = local memory #1 of PU L#25 type = NUMANode ... To show the best-bandwidth node among NUMA nodes local to a PU: $ hwloc-info --local-memory --best-memattr bandwidth pu:25 NUMANode L#7 = local memory #1 of PU L#25 type = NUMANode ... to find where a NUMA node is attached in the hierarchy of CPU cores: $ hwloc-info --ancestor kind=normal --first -s numa:1 Package:0 SEE ALSO hwloc(7), lstopo(1), hwloc-calc(1), hwloc-bind(1), hwloc-ps(1) 2.10.0 December 4, 2023 HWLOC-INFO(1)
|
libpng-config
| null | null | null | null | null |
pspell-config
|
pspell-config displays information about libpspell installation, mostly for use in build scripts. Note that this script is provided for backward compatibility with programs that use pspell. Do not use as it will eventually go away.
|
pspell-config - prints information about a libpspell installation
|
pspell-config [options]
|
--version outputs version information about the installed pspell --datadir displays the data directory --pkgdatadir displays the aspell package directory AUTHOR This manual page was written by Brian Nelson <pyro@debian.org>. GNU 2004-03-02 PSPELL-CONFIG(1)
| null |
exrinfo
| null | null | null | null | null |
gdbm_dump
|
The gdbm_dump utility creates a dump of the specified gdbm(3) database file. The name for the output dump file is supplied by the second argument (FILE). If not specified, the output goes to the standard error. The created dump can be given as argument to the gdbm_load(1) utility in order to re-create an exact copy of the DB_FILE.
|
gdbm_dump - dump a GDBM database to a file
|
gdbm_dump [-H FMT] [--format=FMT] DB_FILE [FILE] gdbm_dump [-Vh] [--help] [--usage] [--version]
|
-H, --format=FMT Select dump format. The value binary (or 0) instructs gdbm_dump to produce a binary dump, compatible with earlier gdbm versions (up to version 1.9). The value ascii (or 1) instructs it to create an ASCII dump (this is the default). The latter is preferred because, apart from the actual data, it also contains meta-information which will allow gdbm_load(1) to recreate an exact copy of the file. -h, --help Print a short usage summary. --usage Print a list of available options. -V, --version Print program version SEE ALSO gdbm_load(1), gdbmtool(1), gdbm(3). For a detailed description of gdbm_dump and other gdbm utilities, refer to the GDBM Manual available in Texinfo format. To access it, run: info gdbm REPORTING BUGS Report bugs to <bug-gdbm@gnu.org>. COPYRIGHT Copyright Β© 2013-2021 Free Software Foundation, Inc License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. GDBM May 8, 2013 GDBM_DUMP(1)
| null |
protoc-gen-upbdefs-27.1.0
| null | null | null | null | null |
SvtAv1EncApp
| null | null | null | null | null |
isympy
|
isympy is a Python shell for SymPy. It is just a normal python shell (ipython shell if you have the ipython package installed) that executes the following commands so that you don't have to: >>> from __future__ import division >>> from sympy import * >>> x, y, z = symbols("x,y,z") >>> k, m, n = symbols("k,m,n", integer=True) So starting isympy is equivalent to starting python (or ipython) and executing the above commands by hand. It is intended for easy and quick experimentation with SymPy. For more complicated programs, it is recommended to write a script and import things explicitly (using the "from sympy import sin, log, Symbol, ..." idiom).
|
isympy - interactive shell for SymPy
|
isympy [-c | --console] [-p ENCODING | --pretty ENCODING] [-t TYPE | --types TYPE] [-o ORDER | --order ORDER] [-q | --quiet] [-d | --doctest] [-C | --no-cache] [-a | --auto] [-D | --debug] [ -- | PYTHONOPTIONS] isympy [ {-h | --help} | {-v | --version} ]
|
-c SHELL, --console=SHELL Use the specified shell (python or ipython) as console backend instead of the default one (ipython if present or python otherwise). Example: isympy -c python SHELL could be either 'ipython' or 'python' -p ENCODING, --pretty=ENCODING Setup pretty printing in SymPy. By default, the most pretty, unicode printing is enabled (if the terminal supports it). You can use less pretty ASCII printing instead or no pretty printing at all. Example: isympy -p no ENCODING must be one of 'unicode', 'ascii' or 'no'. -t TYPE, --types=TYPE Setup the ground types for the polys. By default, gmpy ground types are used if gmpy2 or gmpy is installed, otherwise it falls back to python ground types, which are a little bit slower. You can manually choose python ground types even if gmpy is installed (e.g., for testing purposes). Note that sympy ground types are not supported, and should be used only for experimental purposes. Note that the gmpy1 ground type is primarily intended for testing; it the use of gmpy even if gmpy2 is available. This is the same as setting the environment variable SYMPY_GROUND_TYPES to the given ground type (e.g., SYMPY_GROUND_TYPES='gmpy') The ground types can be determined interactively from the variable sympy.polys.domains.GROUND_TYPES inside the isympy shell itself. Example: isympy -t python TYPE must be one of 'gmpy', 'gmpy1' or 'python'. -o ORDER, --order=ORDER Setup the ordering of terms for printing. The default is lex, which orders terms lexicographically (e.g., x**2 + x + 1). You can choose other orderings, such as rev-lex, which will use reverse lexicographic ordering (e.g., 1 + x + x**2). Note that for very large expressions, ORDER='none' may speed up printing considerably, with the tradeoff that the order of the terms in the printed expression will have no canonical order Example: isympy -o rev-lax ORDER must be one of 'lex', 'rev-lex', 'grlex', 'rev-grlex', 'grevlex', 'rev-grevlex', 'old', or 'none'. -q, --quiet Print only Python's and SymPy's versions to stdout at startup, and nothing else. -d, --doctest Use the same format that should be used for doctests. This is equivalent to 'isympy -c python -p no'. -C, --no-cache Disable the caching mechanism. Disabling the cache may slow certain operations down considerably. This is useful for testing the cache, or for benchmarking, as the cache can result in deceptive benchmark timings. This is the same as setting the environment variable SYMPY_USE_CACHE to 'no'. -a, --auto Automatically create missing symbols. Normally, typing a name of a Symbol that has not been instantiated first would raise NameError, but with this option enabled, any undefined name will be automatically created as a Symbol. This only works in IPython 0.11. Note that this is intended only for interactive, calculator style usage. In a script that uses SymPy, Symbols should be instantiated at the top, so that it's clear what they are. This will not override any names that are already defined, which includes the single character letters represented by the mnemonic QCOSINE (see the "Gotchas and Pitfalls" document in the documentation). You can delete existing names by executing "del name" in the shell itself. You can see if a name is defined by typing "'name' in globals()". The Symbols that are created using this have default assumptions. If you want to place assumptions on symbols, you should create them using symbols() or var(). Finally, this only works in the top level namespace. So, for example, if you define a function in isympy with an undefined Symbol, it will not work. -D, --debug Enable debugging output. This is the same as setting the environment variable SYMPY_DEBUG to 'True'. The debug status is set in the variable SYMPY_DEBUG within isympy. -- PYTHONOPTIONS These options will be passed on to ipython (1) shell. Only supported when ipython is being used (standard python shell not supported). Two dashes (--) are required to separate PYTHONOPTIONS from the other isympy options. For example, to run iSymPy without startup banner and colors: isympy -q -c ipython -- --colors=NoColor -h, --help Print help output and exit. -v, --version Print isympy version information and exit. FILES ${HOME}/.sympy-history Saves the history of commands when using the python shell as backend. BUGS The upstreams BTS can be found at β¨https://github.com/sympy/sympy/issuesβ© Please report all bugs that you find in there, this will help improve the overall quality of SymPy. SEE ALSO ipython(1), python(1) 2007-10-8 isympy(1)
| null |
ptargrep
|
This utility allows you to apply pattern matching to the contents of files contained in a tar archive. You might use this to identify all files in an archive which contain lines matching the specified pattern and either print out the pathnames or extract the files. The pattern will be used as a Perl regular expression (as opposed to a simple grep regex). Multiple tar archive filenames can be specified - they will each be processed in turn.
|
ptargrep - Apply pattern matching to the contents of files in a tar archive
|
ptargrep [options] <pattern> <tar file> ... Options: --basename|-b ignore directory paths from archive --ignore-case|-i do case-insensitive pattern matching --list-only|-l list matching filenames rather than extracting matches --verbose|-v write debugging message to STDERR --help|-? detailed help message
|
--basename (alias -b) When matching files are extracted, ignore the directory path from the archive and write to the current directory using the basename of the file from the archive. Beware: if two matching files in the archive have the same basename, the second file extracted will overwrite the first. --ignore-case (alias -i) Make pattern matching case-insensitive. --list-only (alias -l) Print the pathname of each matching file from the archive to STDOUT. Without this option, the default behaviour is to extract each matching file. --verbose (alias -v) Log debugging info to STDERR. --help (alias -?) Display this documentation. COPYRIGHT Copyright 2010 Grant McLean <grantm@cpan.org> This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. perl v5.38.2 2023-11-28 PTARGREP(1)
| null |
gpaste
|
Write lines consisting of the sequentially corresponding lines from each FILE, separated by TABs, to standard output. With no FILE, or when FILE is -, read standard input. Mandatory arguments to long options are mandatory for short options too. -d, --delimiters=LIST reuse characters from LIST instead of TABs -s, --serial paste one file at a time instead of in parallel -z, --zero-terminated line delimiter is NUL, not newline --help display this help and exit --version output version information and exit AUTHOR Written by David M. Ihnat and David MacKenzie. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO Full documentation <https://www.gnu.org/software/coreutils/paste> or available locally via: info '(coreutils) paste invocation' GNU coreutils 9.3 April 2023 PASTE(1)
|
paste - merge lines of files
|
paste [OPTION]... [FILE]...
| null | null |
h2ph
|
h2ph converts any C header files specified to the corresponding Perl header file format. It is most easily run while in /usr/include: cd /usr/include; h2ph * sys/* or cd /usr/include; h2ph * sys/* arpa/* netinet/* or cd /usr/include; h2ph -r -l . The output files are placed in the hierarchy rooted at Perl's architecture dependent library directory. You can specify a different hierarchy with a -d switch. If run with no arguments, filters standard input to standard output.
|
h2ph - convert .h C header files to .ph Perl header files
|
h2ph [-d destination directory] [-r | -a] [-l] [-h] [-e] [-D] [-Q] [headerfiles]
|
-d destination_dir Put the resulting .ph files beneath destination_dir, instead of beneath the default Perl library location ($Config{'installsitearch'}). -r Run recursively; if any of headerfiles are directories, then run h2ph on all files in those directories (and their subdirectories, etc.). -r and -a are mutually exclusive. -a Run automagically; convert headerfiles, as well as any .h files which they include. This option will search for .h files in all directories which your C compiler ordinarily uses. -a and -r are mutually exclusive. -l Symbolic links will be replicated in the destination directory. If -l is not specified, then links are skipped over. -h Put 'hints' in the .ph files which will help in locating problems with h2ph. In those cases when you require a .ph file containing syntax errors, instead of the cryptic [ some error condition ] at (eval mmm) line nnn you will see the slightly more helpful [ some error condition ] at filename.ph line nnn However, the .ph files almost double in size when built using -h. -e If an error is encountered during conversion, output file will be removed and a warning emitted instead of terminating the conversion immediately. -D Include the code from the .h file as a comment in the .ph file. This is primarily used for debugging h2ph. -Q 'Quiet' mode; don't print out the names of the files being converted. ENVIRONMENT No environment variables are used. FILES /usr/include/*.h /usr/include/sys/*.h etc. AUTHOR Larry Wall SEE ALSO perl(1) DIAGNOSTICS The usual warnings if it can't read or write the files involved. BUGS Doesn't construct the %sizeof array for you. It doesn't handle all C constructs, but it does attempt to isolate definitions inside evals so that you can get at the definitions that it can translate. It's only intended as a rough tool. You may need to dicker with the files produced. You have to run this program by hand; it's not run as part of the Perl installation. Doesn't handle complicated expressions built piecemeal, a la: enum { FIRST_VALUE, SECOND_VALUE, #ifdef ABC THIRD_VALUE #endif }; Doesn't necessarily locate all of your C compiler's internally-defined symbols. perl v5.38.2 2023-11-28 H2PH(1)
| null |
gobject-query
| null | null | null | null | null |
gpgrt-config
|
gpgrt-config is a script tool that is used by the autoconf macros shipped with gnupg software (e.g., AM_PATH_GPG_ERROR and AM_PATH_GPGME) to determine the compiler and linker flags that should be used to compile and link programs that use the specific library (e.g., libgpg- error or libgpgme). gpgrt-config uses pkg-config .pc files as data source. Apart from options gpgrt-config accepts a single argument module specifying the basename (without the ".pc"-suffix) of the pkg-config file to be used as input. module will default to gpg-error if it is not specified.
|
gpgrt-config - Helper script to get information about the installed version of gpg libraries
|
gpgrt-config [options] [ module ]
|
gpgrt-config accepts the following options: --libdir=LIBDIR Parent directory path of pkgconfig file search path. e.g., βgpgrt-config --libdir=/usr/lib --exists gpgmeβ will parse β/usr/lib/pkgconfig/gpgme.pcβ. --exists Test whether the pkg-config file βmodule.pcβ exist and exits with success or error accordingly. --modversion Print the currently installed version of module on the standard output. --libs Print the linker flags that are necessary to link a program using the module. --cflags Print the compiler flags that are necessary to compile a program using the module. --static Modifies output if linking statically instead of dynamically. --variable=VARNAME Output variable VARNAME from the module's pkg-config file. BUGS gpgrt-config is tried to be compatible to pkg-config, and to support cross build well, but it is not intended to be a replacement. Libgpg-error 1.49 2024-04-25 GPGRT-CONFIG(1)
| null |
word-list-compress
|
word-list-compress compresses or decompresses sorted word lists for use with the GNU Aspell spell checker. COMMANDS -c, c, compress compress the plain text word list read from standard input. -d, d, decompress decompress the compressed word list read from standard input.
|
word-list-compress - word list compressor/decompressor for GNU Aspell
|
word-list-compress c[ompress] | d[ecompress]
| null |
Here are a few examples of how you can use word-list-compress word-list-compress d <wordlist.cwl >wordlist.txt Decompress file wordlist.cwl to text file wordlist.txt word-list-compress c <wordlist.wl >wordlist.cwl 2>errors.txt Compress wordlist.wl to wordlist.cwl and send any error messages to a text file named errors.txt LC_COLLATE=C sort -u <wordlist.txt | word-list-compress c >wordlist.cwl Sort a word list, then pipe it to word-list-compress to create a compressed binary wordlist.cwl file. word-list-compress d <words.cwl | aspell create master ./words.rws Decompress a wordlist, then pipe it to aspell(1) to create a spelling list. Please check the aspell(1) info manual for proper usage and options. TIPS Word-list-compress is best used with sorted word list type files. It is not a general purpose compression program since the resulting files may actually increase in size. Word-list-compress accepts up to 255 text characters in the range of {0x21...0xFF}. If your word list requires a larger character set for certain languages or longer length for multi-word, scientific, medical, technical or other use, then it is recommended that you compress your word list using prezip-bin(1) DIAGNOSTICS Word-list-compress normally exits with a return code of 0. If it encounters an error, a message is sent to standard error output (stderr), and word-list-compress exits with a non-zero return value. Error messages are listed below: (display help/usage message) Unknown command given on the command line so word-list-compress displays a usage message to standard error output. Corrupt Input This is only for the decompression command d. The input file is of an unknown format or the input file/stream is corrupted. You may have some valid output, but word-list-compress could not complete the process. If the input file is a compressed wordlist but you have no output file, then it may be a newer prezip-bin(1) version of compressed file, if so, try decompressing the file with prezip-bin(1) instead. Output Data Error The output is full, write protected, or has an error and can no longer be written to. SEE ALSO aspell(1), aspell-import(1), prezip-bin(1), run-with-aspell(1) Aspell is fully documented in its Texinfo manual. See the `aspell' entry in info for more complete documentation. REPORTING BUGS For help, see the Aspell homepage at <http://aspell.net> and send bug reports/comments to the Aspell user list at the above address. AUTHOR This manual page was written by Aaron Lehmann <aaronl@vitelus.com>, Brian Nelson <pyro@debian.org> and Jose Da Silva <digital@joescat.com>. GNU 2005-09-05 WORD-LIST-COMPRESS(1)
|
python3.12-config
| null | null | null | null | null |
asn1Coding
|
Generates a DER encoding of ASN.1 DEFINITIONS file and ASSIGNMENTS file with value assignments. Mandatory arguments to long options are mandatory for short options too. -c, --check checks the syntax only -o, --output=FILE output file -h, --help display this help and exit -v, --version output version information and exit AUTHOR Written by Fabio Fiorina. REPORTING BUGS Report bugs to: help-libtasn1@gnu.org GNU Libtasn1 home page: <https://www.gnu.org/software/libtasn1/> General help using GNU software: <https://www.gnu.org/gethelp/> COPYRIGHT Copyright Β© 2022 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO The full documentation for asn1Coding is maintained as a Texinfo manual. If the info and asn1Coding programs are properly installed at your site, the command info libtasn1 should give you access to the complete manual. libtasn1 4.18.0.33-b8a32 August 2022 ASN1CODING(1)
|
asn1Coding - ASN.1 DER encoder
|
asn1Coding [OPTION] DEFINITIONS ASSIGNMENTS
| null | null |
mysqlcheck
|
The mysqlcheck client performs table maintenance: It checks, repairs, optimizes, or analyzes tables. Each table is locked and therefore unavailable to other sessions while it is being processed, although for check operations, the table is locked with a READ lock only (see Section 13.3.6, βLOCK TABLES and UNLOCK TABLES Statementsβ, for more information about READ and WRITE locks). Table maintenance operations can be time-consuming, particularly for large tables. If you use the --databases or --all-databases option to process all tables in one or more databases, an invocation of mysqlcheck might take a long time. (This is also true for the MySQL upgrade procedure if it determines that table checking is needed because it processes tables the same way.) mysqlcheck must be used when the mysqld server is running, which means that you do not have to stop the server to perform table maintenance. mysqlcheck uses the SQL statements CHECK TABLE, REPAIR TABLE, ANALYZE TABLE, and OPTIMIZE TABLE in a convenient way for the user. It determines which statements to use for the operation you want to perform, and then sends the statements to the server to be executed. For details about which storage engines each statement works with, see the descriptions for those statements in Section 13.7.3, βTable Maintenance Statementsβ. All storage engines do not necessarily support all four maintenance operations. In such cases, an error message is displayed. For example, if test.t is an MEMORY table, an attempt to check it produces this result: $> mysqlcheck test t test.t note : The storage engine for the table doesn't support check If mysqlcheck is unable to repair a table, see Section 2.10.13, βRebuilding or Repairing Tables or Indexesβ for manual table repair strategies. This is the case, for example, for InnoDB tables, which can be checked with CHECK TABLE, but not repaired with REPAIR TABLE. Caution It is best to make a backup of a table before performing a table repair operation; under some circumstances the operation might cause data loss. Possible causes include but are not limited to file system errors. There are three general ways to invoke mysqlcheck: mysqlcheck [options] db_name [tbl_name ...] mysqlcheck [options] --databases db_name ... mysqlcheck [options] --all-databases If you do not name any tables following db_name or if you use the --databases or --all-databases option, entire databases are checked. mysqlcheck has a special feature compared to other client programs. The default behavior of checking tables (--check) can be changed by renaming the binary. If you want to have a tool that repairs tables by default, you should just make a copy of mysqlcheck named mysqlrepair, or make a symbolic link to mysqlcheck named mysqlrepair. If you invoke mysqlrepair, it repairs tables. The names shown in the following table can be used to change mysqlcheck default behavior. ββββββββββββββββ¬ββββββββββββββββββββββββ βCommand β Meaning β ββββββββββββββββΌββββββββββββββββββββββββ€ βmysqlrepair β The default option is β β β --repair β ββββββββββββββββΌββββββββββββββββββββββββ€ βmysqlanalyze β The default option is β β β --analyze β ββββββββββββββββΌββββββββββββββββββββββββ€ βmysqloptimize β The default option is β β β --optimize β ββββββββββββββββ΄ββββββββββββββββββββββββ mysqlcheck supports the following options, which can be specified on the command line or in the [mysqlcheck] and [client] groups of an option file. For information about option files used by MySQL programs, see Section 4.2.2.2, βUsing Option Filesβ. β’ --help, -? ββββββββββββββββββββββ¬βββββββββ βCommand-Line Format β --help β ββββββββββββββββββββββ΄βββββββββ Display a help message and exit. β’ --all-databases, -A ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --all-databases β ββββββββββββββββββββββ΄ββββββββββββββββββ Check all tables in all databases. This is the same as using the --databases option and naming all the databases on the command line, except that the INFORMATION_SCHEMA and performance_schema databases are not checked. They can be checked by explicitly naming them with the --databases option. β’ --all-in-1, -1 ββββββββββββββββββββββ¬βββββββββββββ βCommand-Line Format β --all-in-1 β ββββββββββββββββββββββ΄βββββββββββββ Instead of issuing a statement for each table, execute a single statement for each database that names all the tables from that database to be processed. β’ --analyze, -a ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --analyze β ββββββββββββββββββββββ΄ββββββββββββ Analyze the tables. β’ --auto-repair ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --auto-repair β ββββββββββββββββββββββ΄ββββββββββββββββ If a checked table is corrupted, automatically fix it. Any necessary repairs are done after all tables have been checked. β’ --bind-address=ip_address ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --bind-address=ip_address β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ On a computer having multiple network interfaces, use this option to select which interface to use for connecting to the MySQL server. β’ --character-sets-dir=dir_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββ βCommand-Line Format β --character-sets-dir=dir_name β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββ€ βType β Directory name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββ The directory where character sets are installed. See Section 10.15, βCharacter Set Configurationβ. β’ --check, -c ββββββββββββββββββββββ¬ββββββββββ βCommand-Line Format β --check β ββββββββββββββββββββββ΄ββββββββββ Check the tables for errors. This is the default operation. β’ --check-only-changed, -C ββββββββββββββββββββββ¬βββββββββββββββββββββββ βCommand-Line Format β --check-only-changed β ββββββββββββββββββββββ΄βββββββββββββββββββββββ Check only tables that have changed since the last check or that have not been closed properly. β’ --check-upgrade, -g ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --check-upgrade β ββββββββββββββββββββββ΄ββββββββββββββββββ Invoke CHECK TABLE with the FOR UPGRADE option to check tables for incompatibilities with the current version of the server. β’ --compress ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --compress[={OFF|ON}] β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βDefault Value β OFF β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ Compress all information sent between the client and the server if possible. See Section 4.2.8, βConnection Compression Controlβ. This option is deprecated. Expect it to be removed in a future version of MySQL. See the section called βConfiguring Legacy Connection Compressionβ. β’ --compression-algorithms=value ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ βCommand-Line Format β --compression-algorithms=value β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βType β Set β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βDefault Value β uncompressed β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βValid Values β zlib zstd uncompressed β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ The permitted compression algorithms for connections to the server. The available algorithms are the same as for the protocol_compression_algorithms system variable. The default value is uncompressed. For more information, see Section 4.2.8, βConnection Compression Controlβ. β’ --databases, -B ββββββββββββββββββββββ¬ββββββββββββββ βCommand-Line Format β --databases β ββββββββββββββββββββββ΄ββββββββββββββ Process all tables in the named databases. Normally, mysqlcheck treats the first name argument on the command line as a database name and any following names as table names. With this option, it treats all name arguments as database names. β’ --debug[=debug_options], -# [debug_options] ββββββββββββββββββββββ¬ββββββββββββββββββββββββββ βCommand-Line Format β --debug[=debug_options] β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βDefault Value β d:t:o β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββ Write a debugging log. A typical debug_options string is d:t:o,file_name. The default is d:t:o. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. β’ --debug-check ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --debug-check β ββββββββββββββββββββββΌββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄ββββββββββββββββ Print some debugging information when the program exits. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. β’ --debug-info ββββββββββββββββββββββ¬βββββββββββββββ βCommand-Line Format β --debug-info β ββββββββββββββββββββββΌβββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄βββββββββββββββ Print debugging information and memory and CPU usage statistics when the program exits. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. β’ --default-character-set=charset_name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --default-character-set=charset_name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ Use charset_name as the default character set. See Section 10.15, βCharacter Set Configurationβ. β’ --defaults-extra-file=file_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββ βCommand-Line Format β --defaults-extra-file=file_name β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββ Read this option file after the global option file but (on Unix) before the user option file. If the file does not exist or is otherwise inaccessible, an error occurs. If file_name is not an absolute path name, it is interpreted relative to the current directory. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --defaults-file=file_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --defaults-file=file_name β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs. If file_name is not an absolute path name, it is interpreted relative to the current directory. Exception: Even with --defaults-file, client programs read .mylogin.cnf. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --defaults-group-suffix=str ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββ βCommand-Line Format β --defaults-group-suffix=str β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββ Read not only the usual option groups, but also groups with the usual names and a suffix of str. For example, mysqlcheck normally reads the [client] and [mysqlcheck] groups. If this option is given as --defaults-group-suffix=_other, mysqlcheck also reads the [client_other] and [mysqlcheck_other] groups. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --extended, -e ββββββββββββββββββββββ¬βββββββββββββ βCommand-Line Format β --extended β ββββββββββββββββββββββ΄βββββββββββββ If you are using this option to check tables, it ensures that they are 100% consistent but takes a long time. If you are using this option to repair tables, it runs an extended repair that may not only take a long time to execute, but may produce a lot of garbage rows also! β’ --default-auth=plugin ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --default-auth=plugin β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ A hint about which client-side authentication plugin to use. See Section 6.2.17, βPluggable Authenticationβ. β’ --enable-cleartext-plugin ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --enable-cleartext-plugin β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ Enable the mysql_clear_password cleartext authentication plugin. (See Section 6.4.1.4, βClient-Side Cleartext Pluggable Authenticationβ.) β’ --fast, -F ββββββββββββββββββββββ¬βββββββββ βCommand-Line Format β --fast β ββββββββββββββββββββββ΄βββββββββ Check only tables that have not been closed properly. β’ --force, -f ββββββββββββββββββββββ¬ββββββββββ βCommand-Line Format β --force β ββββββββββββββββββββββ΄ββββββββββ Continue even if an SQL error occurs. β’ --get-server-public-key ββββββββββββββββββββββ¬ββββββββββββββββββββββββββ βCommand-Line Format β --get-server-public-key β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββ Request from the server the public key required for RSA key pair-based password exchange. This option applies to clients that authenticate with the caching_sha2_password authentication plugin. For that plugin, the server does not send the public key unless requested. This option is ignored for accounts that do not authenticate with that plugin. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection. If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over --get-server-public-key. For information about the caching_sha2_password plugin, see Section 6.4.1.2, βCaching SHA-2 Pluggable Authenticationβ. β’ --host=host_name, -h host_name ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --host=host_name β ββββββββββββββββββββββΌβββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌβββββββββββββββββββ€ βDefault Value β localhost β ββββββββββββββββββββββ΄βββββββββββββββββββ Connect to the MySQL server on the given host. β’ --login-path=name ββββββββββββββββββββββ¬ββββββββββββββββββββ βCommand-Line Format β --login-path=name β ββββββββββββββββββββββΌββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββ Read options from the named login path in the .mylogin.cnf login path file. A βlogin pathβ is an option group containing options that specify which MySQL server to connect to and which account to authenticate as. To create or modify a login path file, use the mysql_config_editor utility. See mysql_config_editor(1). For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --no-login-paths ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --no-login-paths β ββββββββββββββββββββββ΄βββββββββββββββββββ Skips reading options from the login path file. See --login-path for related information. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --medium-check, -m ββββββββββββββββββββββ¬βββββββββββββββββ βCommand-Line Format β --medium-check β ββββββββββββββββββββββ΄βββββββββββββββββ Do a check that is faster than an --extended operation. This finds only 99.99% of all errors, which should be good enough in most cases. β’ --no-defaults ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --no-defaults β ββββββββββββββββββββββ΄ββββββββββββββββ Do not read any option files. If program startup fails due to reading unknown options from an option file, --no-defaults can be used to prevent them from being read. The exception is that the .mylogin.cnf file is read in all cases, if it exists. This permits passwords to be specified in a safer way than on the command line even when --no-defaults is used. To create .mylogin.cnf, use the mysql_config_editor utility. See mysql_config_editor(1). For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --optimize, -o ββββββββββββββββββββββ¬βββββββββββββ βCommand-Line Format β --optimize β ββββββββββββββββββββββ΄βββββββββββββ Optimize the tables. β’ --password[=password], -p[password] ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --password[=password] β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ The password of the MySQL account used for connecting to the server. The password value is optional. If not given, mysqlcheck prompts for one. If given, there must be no space between --password= or -p and the password following it. If no password option is specified, the default is to send no password. Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 6.1.2.1, βEnd-User Guidelines for Password Securityβ. To explicitly specify that there is no password and that mysqlcheck should not prompt for one, use the --skip-password option. β’ --password1[=pass_val] The password for multifactor authentication factor 1 of the MySQL account used for connecting to the server. The password value is optional. If not given, mysqlcheck prompts for one. If given, there must be no space between --password1= and the password following it. If no password option is specified, the default is to send no password. Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 6.1.2.1, βEnd-User Guidelines for Password Securityβ. To explicitly specify that there is no password and that mysqlcheck should not prompt for one, use the --skip-password1 option. --password1 and --password are synonymous, as are --skip-password1 and --skip-password. β’ --password2[=pass_val] The password for multifactor authentication factor 2 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for --password1; see the description of that option for details. β’ --password3[=pass_val] The password for multifactor authentication factor 3 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for --password1; see the description of that option for details. β’ --pipe, -W ββββββββββββββββββββββ¬βββββββββ βCommand-Line Format β --pipe β ββββββββββββββββββββββΌβββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββ On Windows, connect to the server using a named pipe. This option applies only if the server was started with the named_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by the named_pipe_full_access_group system variable. β’ --plugin-dir=dir_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --plugin-dir=dir_name β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β Directory name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ The directory in which to look for plugins. Specify this option if the --default-auth option is used to specify an authentication plugin but mysqlcheck does not find it. See Section 6.2.17, βPluggable Authenticationβ. β’ --port=port_num, -P port_num ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --port=port_num β ββββββββββββββββββββββΌββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌββββββββββββββββββ€ βDefault Value β 3306 β ββββββββββββββββββββββ΄ββββββββββββββββββ For TCP/IP connections, the port number to use. β’ --print-defaults ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --print-defaults β ββββββββββββββββββββββ΄βββββββββββββββββββ Print the program name and all options that it gets from option files. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --protocol={TCP|SOCKET|PIPE|MEMORY} ββββββββββββββββββββββ¬βββββββββββββββββββββββββ βCommand-Line Format β --protocol=type β ββββββββββββββββββββββΌβββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌβββββββββββββββββββββββββ€ βDefault Value β [see text] β ββββββββββββββββββββββΌβββββββββββββββββββββββββ€ βValid Values β TCP SOCKET PIPE β β β MEMORY β ββββββββββββββββββββββ΄βββββββββββββββββββββββββ The transport protocol to use for connecting to the server. It is useful when the other connection parameters normally result in use of a protocol other than the one you want. For details on the permissible values, see Section 4.2.7, βConnection Transport Protocolsβ. β’ --quick, -q ββββββββββββββββββββββ¬ββββββββββ βCommand-Line Format β --quick β ββββββββββββββββββββββ΄ββββββββββ If you are using this option to check tables, it prevents the check from scanning the rows to check for incorrect links. This is the fastest check method. If you are using this option to repair tables, it tries to repair only the index tree. This is the fastest repair method. β’ --repair, -r ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --repair β ββββββββββββββββββββββ΄βββββββββββ Perform a repair that can fix almost anything except unique keys that are not unique. β’ --server-public-key-path=file_name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --server-public-key-path=file_name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββ The path name to a file in PEM format containing a client-side copy of the public key required by the server for RSA key pair-based password exchange. This option applies to clients that authenticate with the sha256_password or caching_sha2_password authentication plugin. This option is ignored for accounts that do not authenticate with one of those plugins. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection. If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over --get-server-public-key. For sha256_password, this option applies only if MySQL was built using OpenSSL. For information about the sha256_password and caching_sha2_password plugins, see Section 6.4.1.3, βSHA-256 Pluggable Authenticationβ, and Section 6.4.1.2, βCaching SHA-2 Pluggable Authenticationβ. β’ --shared-memory-base-name=name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ βCommand-Line Format β --shared-memory-base-name=name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βPlatform Specific β Windows β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ On Windows, the shared-memory name to use for connections made using shared memory to a local server. The default value is MYSQL. The shared-memory name is case-sensitive. This option applies only if the server was started with the shared_memory system variable enabled to support shared-memory connections. β’ --silent, -s ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --silent β ββββββββββββββββββββββ΄βββββββββββ Silent mode. Print only error messages. β’ --skip-database=db_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββ βCommand-Line Format β --skip-database=db_name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββ Do not include the named database (case-sensitive) in the operations performed by mysqlcheck. β’ --socket=path, -S path ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ βCommand-Line Format β --socket={file_name|pipe_name} β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ For connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use. On Windows, this option applies only if the server was started with the named_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by the named_pipe_full_access_group system variable. β’ --ssl* Options that begin with --ssl specify whether to connect to the server using encryption and indicate where to find SSL keys and certificates. See the section called βCommand Options for Encrypted Connectionsβ. β’ --ssl-fips-mode={OFF|ON|STRICT} ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββ βCommand-Line Format β --ssl-fips-mode={OFF|ON|STRICT} β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βType β Enumeration β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βDefault Value β OFF β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βValid Values β OFF ON STRICT β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββ Controls whether to enable FIPS mode on the client side. The --ssl-fips-mode option differs from other --ssl-xxx options in that it is not used to establish encrypted connections, but rather to affect which cryptographic operations to permit. See Section 6.8, βFIPS Supportβ. These --ssl-fips-mode values are permitted: β’ OFF: Disable FIPS mode. β’ ON: Enable FIPS mode. β’ STRICT: Enable βstrictβ FIPS mode. Note If the OpenSSL FIPS Object Module is not available, the only permitted value for --ssl-fips-mode is OFF. In this case, setting --ssl-fips-mode to ON or STRICT causes the client to produce a warning at startup and to operate in non-FIPS mode. This option is deprecated. Expect it to be removed in a future version of MySQL. β’ --tables ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --tables β ββββββββββββββββββββββ΄βββββββββββ Override the --databases or -B option. All name arguments following the option are regarded as table names. β’ --tls-ciphersuites=ciphersuite_list ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --tls-ciphersuites=ciphersuite_list β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββ The permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a list of one or more colon-separated ciphersuite names. The ciphersuites that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, βEncrypted Connection TLS Protocols and Ciphersβ. β’ --tls-sni-servername=server_name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββ βCommand-Line Format β --tls-sni-servername=server_name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββ When specified, the name is passed to the libmysqlclient C API library using the MYSQL_OPT_TLS_SNI_SERVERNAME option of mysql_options(). The server name is not case-sensitive. To show which server name the client specified for the current session, if any, check the Tls_sni_server_name status variable. Server Name Indication (SNI) is an extension to the TLS protocol (OpenSSL must be compiled using TLS extensions for this option to function). The MySQL implementation of SNI represents the client-side only. β’ --tls-version=protocol_list ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββ βCommand-Line Format β --tls-version=protocol_list β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββ€ βDefault Value β TLSv1,TLSv1.1,TLSv1.2,TLSv1.3 β β β (OpenSSL 1.1.1 or higher) β β β TLSv1,TLSv1.1,TLSv1.2 β β β (otherwise) β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββ The permissible TLS protocols for encrypted connections. The value is a list of one or more comma-separated protocol names. The protocols that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, βEncrypted Connection TLS Protocols and Ciphersβ. β’ --use-frm ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --use-frm β ββββββββββββββββββββββ΄ββββββββββββ For repair operations on MyISAM tables, get the table structure from the data dictionary so that the table can be repaired even if the .MYI header is corrupted. β’ --user=user_name, -u user_name ββββββββββββββββββββββ¬ββββββββββββββββββββ βCommand-Line Format β --user=user_name, β ββββββββββββββββββββββΌββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββ The user name of the MySQL account to use for connecting to the server. β’ --verbose, -v ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --verbose β ββββββββββββββββββββββ΄ββββββββββββ Verbose mode. Print information about the various stages of program operation. β’ --version, -V ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --version β ββββββββββββββββββββββ΄ββββββββββββ Display version information and exit. β’ --write-binlog ββββββββββββββββββββββ¬βββββββββββββββββ βCommand-Line Format β --write-binlog β ββββββββββββββββββββββ΄βββββββββββββββββ This option is enabled by default, so that ANALYZE TABLE, OPTIMIZE TABLE, and REPAIR TABLE statements generated by mysqlcheck are written to the binary log. Use --skip-write-binlog to cause NO_WRITE_TO_BINLOG to be added to the statements so that they are not logged. Use the --skip-write-binlog when these statements should not be sent to replicas or run when using the binary logs for recovery from backup. β’ --zstd-compression-level=level ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββ βCommand-Line Format β --zstd-compression-level=# β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βType β Integer β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββ The compression level to use for connections to the server that use the zstd compression algorithm. The permitted levels are from 1 to 22, with larger values indicating increasing levels of compression. The default zstd compression level is 3. The compression level setting has no effect on connections that do not use zstd compression. For more information, see Section 4.2.8, βConnection Compression Controlβ. COPYRIGHT Copyright Β© 1997, 2023, Oracle and/or its affiliates. This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/. SEE ALSO For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/. AUTHOR Oracle Corporation (http://dev.mysql.com/). MySQL 8.3 11/23/2023 MYSQLCHECK(1)
|
mysqlcheck - a table maintenance program
|
mysqlcheck [options] [db_name [tbl_name ...]]
| null | null |
rvim
|
Vim is a text editor that is upwards compatible to Vi. It can be used to edit all kinds of plain text. It is especially useful for editing programs. There are a lot of enhancements above Vi: multi level undo, multi windows and buffers, syntax highlighting, command line editing, filename completion, on-line help, visual selection, etc.. See ":help vi_diff.txt" for a summary of the differences between Vim and Vi. While running Vim a lot of help can be obtained from the on-line help system, with the ":help" command. See the ON-LINE HELP section below. Most often Vim is started to edit a single file with the command vim file More generally Vim is started with: vim [options] [filelist] If the filelist is missing, the editor will start with an empty buffer. Otherwise exactly one out of the following four may be used to choose one or more files to be edited. file .. A list of filenames. The first one will be the current file and read into the buffer. The cursor will be positioned on the first line of the buffer. You can get to the other files with the ":next" command. To edit a file that starts with a dash, precede the filelist with "--". - The file to edit is read from stdin. Commands are read from stderr, which should be a tty. -t {tag} The file to edit and the initial cursor position depends on a "tag", a sort of goto label. {tag} is looked up in the tags file, the associated file becomes the current file and the associated command is executed. Mostly this is used for C programs, in which case {tag} could be a function name. The effect is that the file containing that function becomes the current file and the cursor is positioned on the start of the function. See ":help tag-commands". -q [errorfile] Start in quickFix mode. The file [errorfile] is read and the first error is displayed. If [errorfile] is omitted, the filename is obtained from the 'errorfile' option (defaults to "AztecC.Err" for the Amiga, "errors.err" on other systems). Further errors can be jumped to with the ":cn" command. See ":help quickfix". Vim behaves differently, depending on the name of the command (the executable may still be the same file). vim The "normal" way, everything is default. ex Start in Ex mode. Go to Normal mode with the ":vi" command. Can also be done with the "-e" argument. view Start in read-only mode. You will be protected from writing the files. Can also be done with the "-R" argument. gvim gview The GUI version. Starts a new window. Can also be done with the "-g" argument. evim eview The GUI version in easy mode. Starts a new window. Can also be done with the "-y" argument. rvim rview rgvim rgview Like the above, but with restrictions. It will not be possible to start shell commands, or suspend Vim. Can also be done with the "-Z" argument.
|
vim - Vi IMproved, a programmer's text editor
|
vim [options] [file ..] vim [options] - vim [options] -t tag vim [options] -q [errorfile] ex view gvim gview evim eview rvim rview rgvim rgview
|
The options may be given in any order, before or after filenames. Options without an argument can be combined after a single dash. +[num] For the first file the cursor will be positioned on line "num". If "num" is missing, the cursor will be positioned on the last line. +/{pat} For the first file the cursor will be positioned in the line with the first occurrence of {pat}. See ":help search-pattern" for the available search patterns. +{command} -c {command} {command} will be executed after the first file has been read. {command} is interpreted as an Ex command. If the {command} contains spaces it must be enclosed in double quotes (this depends on the shell that is used). Example: vim "+set si" main.c Note: You can use up to 10 "+" or "-c" commands. -S {file} {file} will be sourced after the first file has been read. This is equivalent to -c "source {file}". {file} cannot start with '-'. If {file} is omitted "Session.vim" is used (only works when -S is the last argument). --cmd {command} Like using "-c", but the command is executed just before processing any vimrc file. You can use up to 10 of these commands, independently from "-c" commands. -A If Vim has been compiled with ARABIC support for editing right-to-left oriented files and Arabic keyboard mapping, this option starts Vim in Arabic mode, i.e. 'arabic' is set. Otherwise an error message is given and Vim aborts. -b Binary mode. A few options will be set that makes it possible to edit a binary or executable file. -C Compatible. Set the 'compatible' option. This will make Vim behave mostly like Vi, even though a .vimrc file exists. -d Start in diff mode. There should between two to eight file name arguments. Vim will open all the files and show differences between them. Works like vimdiff(1). -d {device}, -dev {device} Open {device} for use as a terminal. Only on the Amiga. Example: "-d con:20/30/600/150". -D Debugging. Go to debugging mode when executing the first command from a script. -e Start Vim in Ex mode, just like the executable was called "ex". -E Start Vim in improved Ex mode, just like the executable was called "exim". -f Foreground. For the GUI version, Vim will not fork and detach from the shell it was started in. On the Amiga, Vim is not restarted to open a new window. This option should be used when Vim is executed by a program that will wait for the edit session to finish (e.g. mail). On the Amiga the ":sh" and ":!" commands will not work. --nofork Foreground. For the GUI version, Vim will not fork and detach from the shell it was started in. -F If Vim has been compiled with FKMAP support for editing right-to-left oriented files and Farsi keyboard mapping, this option starts Vim in Farsi mode, i.e. 'fkmap' and 'rightleft' are set. Otherwise an error message is given and Vim aborts. -g If Vim has been compiled with GUI support, this option enables the GUI. If no GUI support was compiled in, an error message is given and Vim aborts. --gui-dialog-file {name} When using the GUI, instead of showing a dialog, write the title and message of the dialog to file {name}. The file is created or appended to. Only useful for testing, to avoid that the test gets stuck on a dialog that can't be seen. Without the GUI the argument is ignored. --help, -h, -? Give a bit of help about the command line arguments and options. After this Vim exits. -H If Vim has been compiled with RIGHTLEFT support for editing right-to-left oriented files and Hebrew keyboard mapping, this option starts Vim in Hebrew mode, i.e. 'hkmap' and 'rightleft' are set. Otherwise an error message is given and Vim aborts. -i {viminfo} Specifies the filename to use when reading or writing the viminfo file, instead of the default "~/.viminfo". This can also be used to skip the use of the .viminfo file, by giving the name "NONE". -L Same as -r. -l Lisp mode. Sets the 'lisp' and 'showmatch' options on. -m Modifying files is disabled. Resets the 'write' option. You can still modify the buffer, but writing a file is not possible. -M Modifications not allowed. The 'modifiable' and 'write' options will be unset, so that changes are not allowed and files can not be written. Note that these options can be set to enable making modifications. -N No-compatible mode. Resets the 'compatible' option. This will make Vim behave a bit better, but less Vi compatible, even though a .vimrc file does not exist. -n No swap file will be used. Recovery after a crash will be impossible. Handy if you want to edit a file on a very slow medium (e.g. floppy). Can also be done with ":set uc=0". Can be undone with ":set uc=200". -nb Become an editor server for NetBeans. See the docs for details. -o[N] Open N windows stacked. When N is omitted, open one window for each file. -O[N] Open N windows side by side. When N is omitted, open one window for each file. -p[N] Open N tab pages. When N is omitted, open one tab page for each file. -P {parent-title} Win32 GUI only: Specify the title of the parent application. When possible, Vim will run in an MDI window inside the application. {parent-title} must appear in the window title of the parent application. Make sure that it is specific enough. Note that the implementation is still primitive. It won't work with all applications and the menu doesn't work. -R Read-only mode. The 'readonly' option will be set. You can still edit the buffer, but will be prevented from accidentally overwriting a file. If you do want to overwrite a file, add an exclamation mark to the Ex command, as in ":w!". The -R option also implies the -n option (see above). The 'readonly' option can be reset with ":set noro". See ":help 'readonly'". -r List swap files, with information about using them for recovery. -r {file} Recovery mode. The swap file is used to recover a crashed editing session. The swap file is a file with the same filename as the text file with ".swp" appended. See ":help recovery". -s Silent mode. Only when started as "Ex" or when the "-e" option was given before the "-s" option. -s {scriptin} The script file {scriptin} is read. The characters in the file are interpreted as if you had typed them. The same can be done with the command ":source! {scriptin}". If the end of the file is reached before the editor exits, further characters are read from the keyboard. -T {terminal} Tells Vim the name of the terminal you are using. Only required when the automatic way doesn't work. Should be a terminal known to Vim (builtin) or defined in the termcap or terminfo file. --not-a-term Tells Vim that the user knows that the input and/or output is not connected to a terminal. This will avoid the warning and the two second delay that would happen. --ttyfail When stdin or stdout is not a a terminal (tty) then exit right away. -u {vimrc} Use the commands in the file {vimrc} for initializations. All the other initializations are skipped. Use this to edit a special kind of files. It can also be used to skip all initializations by giving the name "NONE". See ":help initialization" within vim for more details. -U {gvimrc} Use the commands in the file {gvimrc} for GUI initializations. All the other GUI initializations are skipped. It can also be used to skip all GUI initializations by giving the name "NONE". See ":help gui-init" within vim for more details. -V[N] Verbose. Give messages about which files are sourced and for reading and writing a viminfo file. The optional number N is the value for 'verbose'. Default is 10. -V[N]{filename} Like -V and set 'verbosefile' to {filename}. The result is that messages are not displayed but written to the file {filename}. {filename} must not start with a digit. --log {filename} If Vim has been compiled with eval and channel feature, start logging and write entries to {filename}. This works like calling ch_logfile({filename}, 'ao') very early during startup. -v Start Vim in Vi mode, just like the executable was called "vi". This only has effect when the executable is called "ex". -w{number} Set the 'window' option to {number}. -w {scriptout} All the characters that you type are recorded in the file {scriptout}, until you exit Vim. This is useful if you want to create a script file to be used with "vim -s" or ":source!". If the {scriptout} file exists, characters are appended. -W {scriptout} Like -w, but an existing file is overwritten. -x Use encryption when writing files. Will prompt for a crypt key. -X Don't connect to the X server. Shortens startup time in a terminal, but the window title and clipboard will not be used. -y Start Vim in easy mode, just like the executable was called "evim" or "eview". Makes Vim behave like a click-and-type editor. -Z Restricted mode. Works like the executable starts with "r". -- Denotes the end of the options. Arguments after this will be handled as a file name. This can be used to edit a filename that starts with a '-'. --clean Do not use any personal configuration (vimrc, plugins, etc.). Useful to see if a problem reproduces with a clean Vim setup. --echo-wid GTK GUI only: Echo the Window ID on stdout. --literal Take file name arguments literally, do not expand wildcards. This has no effect on Unix where the shell expands wildcards. --noplugin Skip loading plugins. Implied by -u NONE. --remote Connect to a Vim server and make it edit the files given in the rest of the arguments. If no server is found a warning is given and the files are edited in the current Vim. --remote-expr {expr} Connect to a Vim server, evaluate {expr} in it and print the result on stdout. --remote-send {keys} Connect to a Vim server and send {keys} to it. --remote-silent As --remote, but without the warning when no server is found. --remote-wait As --remote, but Vim does not exit until the files have been edited. --remote-wait-silent As --remote-wait, but without the warning when no server is found. --serverlist List the names of all Vim servers that can be found. --servername {name} Use {name} as the server name. Used for the current Vim, unless used with a --remote argument, then it's the name of the server to connect to. --socketid {id} GTK GUI only: Use the GtkPlug mechanism to run gvim in another window. --startuptime {file} During startup write timing messages to the file {fname}. --version Print version information and exit. --windowid {id} Win32 GUI only: Make gvim try to use the window {id} as a parent, so that it runs inside that window. ON-LINE HELP Type ":help" in Vim to get started. Type ":help subject" to get help on a specific subject. For example: ":help ZZ" to get help for the "ZZ" command. Use <Tab> and CTRL-D to complete subjects (":help cmdline-completion"). Tags are present to jump from one place to another (sort of hypertext links, see ":help"). All documentation files can be viewed in this way, for example ":help syntax.txt". FILES /usr/local/share/vim/vim??/doc/*.txt The Vim documentation files. Use ":help doc-file-list" to get the complete list. vim?? is short version number, like vim91 for Vim 9.1 /usr/local/share/vim/vim??/doc/tags The tags file used for finding information in the documentation files. /usr/local/share/vim/vim??/syntax/syntax.vim System wide syntax initializations. /usr/local/share/vim/vim??/syntax/*.vim Syntax files for various languages. /usr/local/share/vim/vimrc System wide Vim initializations. ~/.vimrc, ~/.vim/vimrc, $XDG_CONFIG_HOME/vim/vimrc Your personal Vim initializations (first one found is used). /usr/local/share/vim/gvimrc System wide gvim initializations. ~/.gvimrc, ~/.vim/gvimrc, $XDG_CONFIG_HOME/vim/gvimrc Your personal gvim initializations (first one found is used). /usr/local/share/vim/vim??/optwin.vim Script used for the ":options" command, a nice way to view and set options. /usr/local/share/vim/vim??/menu.vim System wide menu initializations for gvim. /usr/local/share/vim/vim??/bugreport.vim Script to generate a bug report. See ":help bugs". /usr/local/share/vim/vim??/filetype.vim Script to detect the type of a file by its name. See ":help 'filetype'". /usr/local/share/vim/vim??/scripts.vim Script to detect the type of a file by its contents. See ":help 'filetype'". /usr/local/share/vim/vim??/print/*.ps Files used for PostScript printing. For recent info read the VIM home page: <URL:http://www.vim.org/> SEE ALSO vimtutor(1) AUTHOR Most of Vim was made by Bram Moolenaar, with a lot of help from others. See ":help credits" in Vim. Vim is based on Stevie, worked on by: Tim Thompson, Tony Andrews and G.R. (Fred) Walter. Although hardly any of the original code remains. BUGS Probably. See ":help todo" for a list of known problems. Note that a number of things that may be regarded as bugs by some, are in fact caused by a too-faithful reproduction of Vi's behaviour. And if you think other things are bugs "because Vi does it differently", you should take a closer look at the vi_diff.txt file (or type :help vi_diff.txt when in Vim). Also have a look at the 'compatible' and 'cpoptions' options. 2024 Jun 04 VIM(1)
| null |
brew
|
Homebrew is the easiest and most flexible way to install the UNIX tools Apple didnβt include with macOS. It can also install software not packaged for your Linux distribution without requiring sudo. TERMINOLOGY formula Homebrew package definition that builds from upstream sources cask Homebrew package definition that installs macOS native applications prefix path in which Homebrew is installed, e.g. /usr/local keg installation destination directory of a given formula version, e.g. /usr/local/Cellar/foo/0.1 rack directory containing one or more versioned kegs, e.g. /usr/local/Cellar/foo keg-only a formula is keg-only if it is not symlinked into Homebrewβs prefix opt prefix a symlink to the active version of a keg, e.g. /usr/local/opt/foo Cellar directory containing one or more named racks, e.g. /usr/local/Cellar Caskroom directory containing one or more named casks, e.g. /usr/local/Caskroom external command brew subcommand defined outside of the Homebrew/brew GitHub repository tap directory (and usually Git repository) of formulae, casks and/or external commands bottle pre-built keg poured into a rack of the Cellar instead of building from upstream sources ESSENTIAL COMMANDS For the full command list, see the COMMANDS section. With --verbose or --debug, many commands print extra debugging information. Note that these options should only appear after a command. Some command behaviour can be customised with environment variables; see the ENVIRONMENT section. install formula Install formula. formula is usually the name of the formula to install, but it has other syntaxes which are listed in the SPECIFYING FORMULAE section. uninstall formula Uninstall formula. list List all installed formulae. search [text|/text/] Perform a substring search of cask tokens and formula names for text. If text is flanked by slashes, it is interpreted as a regular expression. The search for text is extended online to homebrew/core and homebrew/cask. If no search term is provided, all locally available formulae are listed. COMMANDS analytics [subcommand] Control Homebrewβs anonymous aggregate user behaviour analytics. Read more at <https://docs.brew.sh/Analytics>. brew analytics [state] Display the current state of Homebrewβs analytics. brew analytics (on|off) Turn Homebrewβs analytics on or off respectively. autoremove [--dry-run] Uninstall formulae that were only installed as a dependency of another formula and are now no longer needed. -n, --dry-run List what would be uninstalled, but do not actually uninstall anything. casks List all locally installable casks including short names. cleanup [options] [formula|cask ...] Remove stale lock files and outdated downloads for all formulae and casks, and remove old versions of installed formulae. If arguments are specified, only do this for the given formulae and casks. Removes all downloads more than 120 days old. This can be adjusted with HOMEBREW_CLEANUP_MAX_AGE_DAYS. --prune Remove all cache files older than specified days. If you want to remove everything, use --prune=all. -n, --dry-run Show what would be removed, but do not actually remove anything. -s Scrub the cache, including downloads for even the latest versions. Note that downloads for any installed formulae or casks will still not be deleted. If you want to delete those too: rm -rf "$(brew --cache)" --prune-prefix Only prune the symlinks and directories from the prefix and remove no other files. commands [--quiet] [--include-aliases] Show lists of built-in and external commands. -q, --quiet List only the names of commands without category headers. --include-aliases Include aliases of internal commands. completions [subcommand] Control whether Homebrew automatically links external tap shell completion files. Read more at <https://docs.brew.sh/Shell-Completion>. brew completions [state] Display the current state of Homebrewβs completions. brew completions (link|unlink) Link or unlink Homebrewβs completions. config, --config Show Homebrew and system configuration info useful for debugging. If you file a bug report, you will be required to provide this information. deps [options] [formula|cask ...] Show dependencies for formula. When given multiple formula arguments, show the intersection of dependencies for each formula. By default, deps shows all required and recommended dependencies. If any version of each formula argument is installed and no other options are passed, this command displays their actual runtime dependencies (similar to brew linkage), which may differ from the current versionsβ stated dependencies if the installed versions are outdated. Note: --missing and --skip-recommended have precedence over --include-*. -n, --topological Sort dependencies in topological order. -1, --direct Show only the direct dependencies declared in the formula. --union Show the union of dependencies for multiple formula, instead of the intersection. --full-name List dependencies by their full name. --include-build Include :build dependencies for formula. --include-optional Include :optional dependencies for formula. --include-test Include :test dependencies for formula (non-recursive). --skip-recommended Skip :recommended dependencies for formula. --include-requirements Include requirements in addition to dependencies for formula. --tree Show dependencies as a tree. When given multiple formula arguments, show individual trees for each formula. --graph Show dependencies as a directed graph. --dot Show text-based graph description in DOT format. --annotate Mark any build, test, implicit, optional, or recommended dependencies as such in the output. --installed List dependencies for formulae that are currently installed. If formula is specified, list only its dependencies that are currently installed. --missing Show only missing dependencies. --eval-all Evaluate all available formulae and casks, whether installed or not, to list their dependencies. --for-each Switch into the mode used by the --eval-all option, but only list dependencies for each provided formula, one formula per line. This is used for debugging the --installed/--eval-all display mode. --HEAD Show dependencies for HEAD version instead of stable version. --formula Treat all named arguments as formulae. --cask Treat all named arguments as casks. desc [options] formula|cask|text|/regex/ [...] Display formulaβs name and one-line description. The cache is created on the first search, making that search slower than subsequent ones. -s, --search Search both names and descriptions for text. If text is flanked by slashes, it is interpreted as a regular expression. -n, --name Search just names for text. If text is flanked by slashes, it is interpreted as a regular expression. -d, --description Search just descriptions for text. If text is flanked by slashes, it is interpreted as a regular expression. --eval-all Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if HOMEBREW_EVAL_ALL is set. --formula Treat all named arguments as formulae. --cask Treat all named arguments as casks. developer [subcommand] Control Homebrewβs developer mode. When developer mode is enabled, brew update will update Homebrew to the latest commit on the master branch instead of the latest stable version along with some other behaviour changes. brew developer [state] Display the current state of Homebrewβs developer mode. brew developer (on|off) Turn Homebrewβs developer mode on or off respectively. docs Open Homebrewβs online documentation at <https://docs.brew.sh> in a browser. doctor, dr [--list-checks] [--audit-debug] [diagnostic_check ...] Check your system for potential problems. Will exit with a non-zero status if any potential problems are found. Please note that these warnings are just used to help the Homebrew maintainers with debugging if you file an issue. If everything you use Homebrew for is working fine: please donβt worry or file an issue; just ignore this. --list-checks List all audit methods, which can be run individually if provided as arguments. -D, --audit-debug Enable debugging and profiling of audit methods. fetch [options] formula|cask [...] Download a bottle (if available) or source packages for formulae and binaries for casks. For files, also print SHA-256 checksums. --os Download for the given operating system. (Pass all to download for all operating systems.) --arch Download for the given CPU architecture. (Pass all to download for all architectures.) --bottle-tag Download a bottle for given tag. --HEAD Fetch HEAD version instead of stable version. -f, --force Remove a previously cached version and re-fetch. -v, --verbose Do a verbose VCS checkout, if the URL represents a VCS. This is useful for seeing if an existing VCS cache has been updated. --retry Retry if downloading fails or re-download if the checksum of a previously cached version no longer matches. Tries at most 5 times with exponential backoff. --deps Also download dependencies for any listed formula. -s, --build-from-source Download source packages rather than a bottle. --build-bottle Download source packages (for eventual bottling) rather than a bottle. --force-bottle Download a bottle if it exists for the current or newest version of macOS, even if it would not be used during installation. --[no-]quarantine Disable/enable quarantining of downloads (default: enabled). --formula Treat all named arguments as formulae. --cask Treat all named arguments as casks. formulae List all locally installable formulae including short names. gist-logs [options] formula Upload logs for a failed build of formula to a new Gist. Presents an error message if no logs are found. --with-hostname Include the hostname in the Gist. -n, --new-issue Automatically create a new issue in the appropriate GitHub repository after creating the Gist. -p, --private The Gist will be marked private and will not appear in listings but will be accessible with its link. home, homepage [--formula] [--cask] [formula|cask ...] Open a formula or caskβs homepage in a browser, or open Homebrewβs own homepage if no argument is provided. --formula Treat all named arguments as formulae. --cask Treat all named arguments as casks. info, abv [options] [formula|cask ...] Display brief statistics for your Homebrew installation. If a formula or cask is provided, show summary of information about it. --analytics List global Homebrew analytics data or, if specified, installation and build error data for formula (provided neither HOMEBREW_NO_ANALYTICS nor HOMEBREW_NO_GITHUB_API are set). --days How many days of analytics data to retrieve. The value for days must be 30, 90 or 365. The default is 30. --category Which type of analytics data to retrieve. The value for category must be install, install-on-request or build-error; cask-install or os-version may be specified if formula is not. The default is install. --github Open the GitHub source page for formula and cask in a browser. To view the history locally: brew log -p formula or cask --json Print a JSON representation. Currently the default value for version is v1 for formula. For formula and cask use v2. See the docs for examples of using the JSON output: <https://docs.brew.sh/Querying-Brew> --installed Print JSON of formulae that are currently installed. --eval-all Evaluate all available formulae and casks, whether installed or not, to print their JSON. Implied if HOMEBREW_EVAL_ALL is set. --variations Include the variations hash in each formulaβs JSON output. -v, --verbose Show more verbose analytics data for formula. --formula Treat all named arguments as formulae. --cask Treat all named arguments as casks. install [options] formula|cask [...] Install a formula or cask. Additional options specific to a formula may be appended to the command. Unless HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK is set, brew upgrade or brew reinstall will be run for outdated dependents and dependents with broken linkage, respectively. Unless HOMEBREW_NO_INSTALL_CLEANUP is set, brew cleanup will then be run for the installed formulae or, every 30 days, for all formulae. Unless HOMEBREW_NO_INSTALL_UPGRADE is set, brew install formula will upgrade formula if it is already installed but outdated. -d, --debug If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory. -f, --force Install formulae without checking for previously installed keg-only or non-migrated versions. When installing casks, overwrite existing files (binaries and symlinks are excluded, unless originally from the same cask). -v, --verbose Print the verification and post-install steps. -n, --dry-run Show what would be installed, but do not actually install anything. --formula Treat all named arguments as formulae. --ignore-dependencies An unsupported Homebrew development option to skip installing any dependencies of any kind. If the dependencies are not already present, the formula will have issues. If youβre not developing Homebrew, consider adjusting your PATH rather than using this option. --only-dependencies Install the dependencies with specified options but do not install the formula itself. --cc Attempt to compile using the specified compiler, which should be the name of the compilerβs executable, e.g. gcc-7 for GCC 7. In order to use LLVMβs clang, specify llvm_clang. To use the Apple-provided clang, specify clang. This option will only accept compilers that are provided by Homebrew or bundled with macOS. Please do not file issues if you encounter errors while using this option. -s, --build-from-source Compile formula from source even if a bottle is provided. Dependencies will still be installed from bottles if they are available. --force-bottle Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation. --include-test Install testing dependencies required to run brew test formula. --HEAD If formula defines it, install the HEAD version, aka. main, trunk, unstable, master. --fetch-HEAD Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repositoryβs HEAD will only be checked for updates when a new stable or development version has been released. --keep-tmp Retain the temporary files created during installation. --debug-symbols Generate debug symbols on build. Source will be retained in a cache directory. --build-bottle Prepare the formula for eventual bottling during installation, skipping any post-install steps. --skip-post-install Install but skip any post-install steps. --bottle-arch Optimise bottles for the specified architecture rather than the oldest architecture supported by the version of macOS the bottles are built on. --display-times Print install times for each package at the end of the run. -i, --interactive Download and patch formula, then open a shell. This allows the user to run ./configure --help and otherwise determine how to turn the software package into a Homebrew package. -g, --git Create a Git repository, useful for creating patches to the software. --overwrite Delete files that already exist in the prefix while linking. --cask Treat all named arguments as casks. --[no-]binaries Disable/enable linking of helper executables (default: enabled). --require-sha Require all casks to have a checksum. --[no-]quarantine Disable/enable quarantining of downloads (default: enabled). --adopt Adopt existing artifacts in the destination that are identical to those being installed. Cannot be combined with --force. --skip-cask-deps Skip installing cask dependencies. --zap For use with brew reinstall --cask. Remove all files associated with a cask. May remove files which are shared between applications. leaves [--installed-on-request] [--installed-as-dependency] List installed formulae that are not dependencies of another installed formula or cask. -r, --installed-on-request Only list leaves that were manually installed. -p, --installed-as-dependency Only list leaves that were installed as dependencies. link, ln [options] installed_formula [...] Symlink all of formulaβs installed files into Homebrewβs prefix. This is done automatically when you install formulae but can be useful for manual installations. --overwrite Delete files that already exist in the prefix while linking. -n, --dry-run List files which would be linked or deleted by brew link --overwrite without actually linking or deleting any files. -f, --force Allow keg-only formulae to be linked. --HEAD Link the HEAD version of the formula if it is installed. list, ls [options] [installed_formula|installed_cask ...] List all installed formulae and casks. If formula is provided, summarise the paths within its current keg. If cask is provided, list its artifacts. --formula List only formulae, or treat all named arguments as formulae. --cask List only casks, or treat all named arguments as casks. --full-name Print formulae with fully-qualified names. Unless --full-name, --versions or --pinned are passed, other options (i.e. -1, -l, -r and -t) are passed to ls(1) which produces the actual output. --versions Show the version number for installed formulae, or only the specified formulae if formula are provided. --multiple Only show formulae with multiple versions installed. --pinned List only pinned formulae, or only the specified (pinned) formulae if formula are provided. See also pin, unpin. -1 Force output to be one entry per line. This is the default when output is not to a terminal. -l List formulae and/or casks in long format. Has no effect when a formula or cask name is passed as an argument. -r Reverse the order of the formulae and/or casks sort to list the oldest entries first. Has no effect when a formula or cask name is passed as an argument. -t Sort formulae and/or casks by time modified, listing most recently modified first. Has no effect when a formula or cask name is passed as an argument. log [options] [formula|cask] Show the git log for formula or cask, or show the log for the Homebrew repository if no formula or cask is provided. -p, --patch Also print patch from commit. --stat Also print diffstat from commit. --oneline Print only one line per commit. -1 Print only one commit. -n, --max-count Print only a specified number of commits. --formula Treat all named arguments as formulae. --cask Treat all named arguments as casks. migrate [options] installed_formula|installed_cask [...] Migrate renamed packages to new names, where formula are old names of packages. -f, --force Treat installed formula and provided formula as if they are from the same taps and migrate them anyway. -n, --dry-run Show what would be migrated, but do not actually migrate anything. --formula Only migrate formulae. --cask Only migrate casks. missing [--hide=] [formula ...] Check the given formula kegs for missing dependencies. If no formula are provided, check all kegs. Will exit with a non-zero status if any kegs are found to be missing dependencies. --hide Act as if none of the specified hidden are installed. hidden should be a comma-separated list of formulae. nodenv-sync Create symlinks for Homebrewβs installed NodeJS versions in ~/.nodenv/versions. Note that older version symlinks will also be created so e.g. NodeJS 19.1.0 will also be symlinked to 19.0.0. options [options] [formula ...] Show install options specific to formula. --compact Show all options on a single line separated by spaces. --installed Show options for formulae that are currently installed. --eval-all Evaluate all available formulae and casks, whether installed or not, to show their options. --command Show options for the specified command. outdated [options] [formula|cask ...] List installed casks and formulae that have an updated version available. By default, version information is displayed in interactive shells, and suppressed otherwise. -q, --quiet List only the names of outdated kegs (takes precedence over --verbose). -v, --verbose Include detailed version information. --formula List only outdated formulae. --cask List only outdated casks. --json Print output in JSON format. There are two versions: v1 and v2. v1 is deprecated and is currently the default if no version is specified. v2 prints outdated formulae and casks. --fetch-HEAD Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repositoryβs HEAD will only be checked for updates when a new stable or development version has been released. -g, --greedy Also include outdated casks with auto_updates true or version :latest. --greedy-latest Also include outdated casks including those with version :latest. --greedy-auto-updates Also include outdated casks including those with auto_updates true. pin installed_formula [...] Pin the specified formula, preventing them from being upgraded when issuing the brew upgrade formula command. See also unpin. Note: Other packages which depend on newer versions of a pinned formula might not install or run correctly. postinstall, post_install installed_formula [...] Rerun the post-install steps for formula. pyenv-sync Create symlinks for Homebrewβs installed Python versions in ~/.pyenv/versions. Note that older patch version symlinks will be created and linked to the minor version so e.g. Python 3.11.0 will also be symlinked to 3.11.3. rbenv-sync Create symlinks for Homebrewβs installed Ruby versions in ~/.rbenv/versions. Note that older version symlinks will also be created so e.g. Ruby 3.2.1 will also be symlinked to 3.2.0. readall [options] [tap ...] Import all items from the specified tap, or from all installed taps if none is provided. This can be useful for debugging issues across all items when making significant changes to formula.rb, testing the performance of loading all items or checking if any current formulae/casks have Ruby issues. --os Read using the given operating system. (Pass all to simulate all operating systems.) --arch Read using the given CPU architecture. (Pass all to simulate all architectures.) --aliases Verify any alias symlinks in each tap. --syntax Syntax-check all of Homebrewβs Ruby files (if no tap is passed). --eval-all Evaluate all available formulae and casks, whether installed or not. Implied if HOMEBREW_EVAL_ALL is set. --no-simulate Donβt simulate other system configurations when checking formulae and casks. reinstall [options] formula|cask [...] Uninstall and then reinstall a formula or cask using the same options it was originally installed with, plus any appended options specific to a formula. Unless HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK is set, brew upgrade or brew reinstall will be run for outdated dependents and dependents with broken linkage, respectively. Unless HOMEBREW_NO_INSTALL_CLEANUP is set, brew cleanup will then be run for the reinstalled formulae or, every 30 days, for all formulae. -d, --debug If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory. -f, --force Install without checking for previously installed keg-only or non-migrated versions. -v, --verbose Print the verification and post-install steps. --formula Treat all named arguments as formulae. -s, --build-from-source Compile formula from source even if a bottle is available. -i, --interactive Download and patch formula, then open a shell. This allows the user to run ./configure --help and otherwise determine how to turn the software package into a Homebrew package. --force-bottle Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation. --keep-tmp Retain the temporary files created during installation. --debug-symbols Generate debug symbols on build. Source will be retained in a cache directory. --display-times Print install times for each formula at the end of the run. -g, --git Create a Git repository, useful for creating patches to the software. --cask Treat all named arguments as casks. --[no-]binaries Disable/enable linking of helper executables (default: enabled). --require-sha Require all casks to have a checksum. --[no-]quarantine Disable/enable quarantining of downloads (default: enabled). --adopt Adopt existing artifacts in the destination that are identical to those being installed. Cannot be combined with --force. --skip-cask-deps Skip installing cask dependencies. --zap For use with brew reinstall --cask. Remove all files associated with a cask. May remove files which are shared between applications. search, -S [options] text|/regex/ [...] Perform a substring search of cask tokens and formula names for text. If text is flanked by slashes, it is interpreted as a regular expression. --formula Search for formulae. --cask Search for casks. --desc Search for formulae with a description matching text and casks with a name or description matching text. --eval-all Evaluate all available formulae and casks, whether installed or not, to search their descriptions. Implied if HOMEBREW_EVAL_ALL is set. --pull-request Search for GitHub pull requests containing text. --open Search for only open GitHub pull requests. --closed Search for only closed GitHub pull requests. --repology Search for text in the given database. --macports Search for text in the given database. --fink Search for text in the given database. --opensuse Search for text in the given database. --fedora Search for text in the given database. --archlinux Search for text in the given database. --debian Search for text in the given database. --ubuntu Search for text in the given database. setup-ruby Installs and configures Homebrewβs Ruby. shellenv [bash|csh|fish|pwsh|sh|tcsh|zsh] Print export statements. When run in a shell, this installation of Homebrew will be added to your PATH, MANPATH, and INFOPATH. The variables HOMEBREW_PREFIX, HOMEBREW_CELLAR and HOMEBREW_REPOSITORY are also exported to avoid querying them multiple times. To help guarantee idempotence, this command produces no output when Homebrewβs bin and sbin directories are first and second respectively in your PATH. Consider adding evaluation of this commandβs output to your dotfiles (e.g. ~/.bash_profile or ~/.zprofile on macOS and ~/.bashrc or ~/.zshrc on Linux) with: eval "$(brew shellenv)" The shell can be specified explicitly with a supported shell name parameter. Unknown shells will output POSIX exports. tap [options] [user/repo] [URL] Tap a formula repository. If no arguments are provided, list all installed taps. With URL unspecified, tap a formula repository from GitHub using HTTPS. Since so many taps are hosted on GitHub, this command is a shortcut for brew tap user/repo https://github.com/user/homebrew-repo. With URL specified, tap a formula repository from anywhere, using any transport protocol that git(1) handles. The one-argument form of tap simplifies but also limits. This two-argument command makes no assumptions, so taps can be cloned from places other than GitHub and using protocols other than HTTPS, e.g. SSH, git, HTTP, FTP(S), rsync. --[no-]force-auto-update Auto-update tap even if it is not hosted on GitHub. By default, only taps hosted on GitHub are auto-updated (for performance reasons). --custom-remote Install or change a tap with a custom remote. Useful for mirrors. --repair Migrate tapped formulae from symlink-based to directory-based structure. --eval-all Evaluate all the formulae, casks and aliases in the new tap to check validity. Implied if HOMEBREW_EVAL_ALL is set. --force Force install core taps even under API mode. tap-info [--installed] [--json] [tap ...] Show detailed information about one or more taps. If no tap names are provided, display brief statistics for all installed taps. --installed Show information on each installed tap. --json Print a JSON representation of tap. Currently the default and only accepted value for version is v1. See the docs for examples of using the JSON output: <https://docs.brew.sh/Querying-Brew> uninstall, remove, rm [options] installed_formula|installed_cask [...] Uninstall a formula or cask. -f, --force Delete all installed versions of formula. Uninstall even if cask is not installed, overwrite existing files and ignore errors when removing files. --zap Remove all files associated with a cask. May remove files which are shared between applications. --ignore-dependencies Donβt fail uninstall, even if formula is a dependency of any installed formulae. --formula Treat all named arguments as formulae. --cask Treat all named arguments as casks. unlink [--dry-run] installed_formula [...] Remove symlinks for formula from Homebrewβs prefix. This can be useful for temporarily disabling a formula: brew unlink formula && commands && brew link formula -n, --dry-run List files which would be unlinked without actually unlinking or deleting any files. unpin installed_formula [...] Unpin formula, allowing them to be upgraded by brew upgrade formula. See also pin. untap [--force] tap [...] Remove a tapped formula repository. -f, --force Untap even if formulae or casks from this tap are currently installed. update [options] Fetch the newest version of Homebrew and all formulae from GitHub using git(1) and perform any necessary migrations. --merge Use git merge to apply updates (rather than git rebase). --auto-update Run on auto-updates (e.g. before brew install). Skips some slower steps. -f, --force Always do a slower, full update check (even if unnecessary). update-reset [path-to-tap-repository ...] Fetch and reset Homebrew and all tap repositories (or any specified repository) using git(1) to their latest origin/HEAD. Note: this will destroy all your uncommitted or committed changes. upgrade [options] [installed_formula|installed_cask ...] Upgrade outdated casks and outdated, unpinned formulae using the same options they were originally installed with, plus any appended brew formula options. If cask or formula are specified, upgrade only the given cask or formula kegs (unless they are pinned; see pin, unpin). Unless HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK is set, brew upgrade or brew reinstall will be run for outdated dependents and dependents with broken linkage, respectively. Unless HOMEBREW_NO_INSTALL_CLEANUP is set, brew cleanup will then be run for the upgraded formulae or, every 30 days, for all formulae. -d, --debug If brewing fails, open an interactive debugging session with access to IRB or a shell inside the temporary build directory. -f, --force Install formulae without checking for previously installed keg-only or non-migrated versions. When installing casks, overwrite existing files (binaries and symlinks are excluded, unless originally from the same cask). -v, --verbose Print the verification and post-install steps. -n, --dry-run Show what would be upgraded, but do not actually upgrade anything. --formula Treat all named arguments as formulae. If no named arguments are specified, upgrade only outdated formulae. -s, --build-from-source Compile formula from source even if a bottle is available. -i, --interactive Download and patch formula, then open a shell. This allows the user to run ./configure --help and otherwise determine how to turn the software package into a Homebrew package. --force-bottle Install from a bottle if it exists for the current or newest version of macOS, even if it would not normally be used for installation. --fetch-HEAD Fetch the upstream repository to detect if the HEAD installation of the formula is outdated. Otherwise, the repositoryβs HEAD will only be checked for updates when a new stable or development version has been released. --keep-tmp Retain the temporary files created during installation. --debug-symbols Generate debug symbols on build. Source will be retained in a cache directory. --display-times Print install times for each package at the end of the run. --overwrite Delete files that already exist in the prefix while linking. --cask Treat all named arguments as casks. If no named arguments are specified, upgrade only outdated casks. --skip-cask-deps Skip installing cask dependencies. -g, --greedy Also include casks with auto_updates true or version :latest. --greedy-latest Also include casks with version :latest. --greedy-auto-updates Also include casks with auto_updates true. --[no-]binaries Disable/enable linking of helper executables (default: enabled). --require-sha Require all casks to have a checksum. --[no-]quarantine Disable/enable quarantining of downloads (default: enabled). uses [options] formula [...] Show formulae and casks that specify formula as a dependency; that is, show dependents of formula. When given multiple formula arguments, show the intersection of formulae that use formula. By default, uses shows all formulae and casks that specify formula as a required or recommended dependency for their stable builds. Note: --missing and --skip-recommended have precedence over --include-*. --recursive Resolve more than one level of dependencies. --installed Only list formulae and casks that are currently installed. --missing Only list formulae and casks that are not currently installed. --eval-all Evaluate all available formulae and casks, whether installed or not, to show their dependents. --include-build Include formulae that specify formula as a :build dependency. --include-test Include formulae that specify formula as a :test dependency. --include-optional Include formulae that specify formula as an :optional dependency. --skip-recommended Skip all formulae that specify formula as a :recommended dependency. --formula Include only formulae. --cask Include only casks. --cache [options] [formula|cask ...] Display Homebrewβs download cache. See also HOMEBREW_CACHE. If formula is provided, display the file or directory used to cache formula. --os Show cache file for the given operating system. (Pass all to show cache files for all operating systems.) --arch Show cache file for the given CPU architecture. (Pass all to show cache files for all architectures.) -s, --build-from-source Show the cache file used when building from source. --force-bottle Show the cache file used when pouring a bottle. --bottle-tag Show the cache file used when pouring a bottle for the given tag. --HEAD Show the cache file used when building from HEAD. --formula Only show cache files for formulae. --cask Only show cache files for casks. --caskroom [cask ...] Display Homebrewβs Caskroom path. If cask is provided, display the location in the Caskroom where cask would be installed, without any sort of versioned directory as the last path. --cellar [formula ...] Display Homebrewβs Cellar path. Default: $(brew --prefix)/Cellar, or if that directory doesnβt exist, $(brew --repository)/Cellar. If formula is provided, display the location in the Cellar where formula would be installed, without any sort of versioned directory as the last path. --env, environment [--shell=] [--plain] [formula ...] Summarise Homebrewβs build environment as a plain list. If the commandβs output is sent through a pipe and no shell is specified, the list is formatted for export to bash(1) unless --plain is passed. --shell Generate a list of environment variables for the specified shell, or --shell=auto to detect the current shell. --plain Generate plain output even when piped. --prefix [--unbrewed] [--installed] [formula ...] Display Homebrewβs install path. Default: β’ macOS ARM: /opt/homebrew β’ macOS Intel: /usr/local β’ Linux: /home/linuxbrew/.linuxbrew If formula is provided, display the location where formula is or would be installed. --unbrewed List files in Homebrewβs prefix not installed by Homebrew. --installed Outputs nothing and returns a failing status code if formula is not installed. --repository, --repo [tap ...] Display where Homebrewβs Git repository is located. If user/repo are provided, display where tap user/repoβs directory is located. --version, -v Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask (if tapped) to standard output. DEVELOPER COMMANDS audit [options] [formula|cask ...] Check formula for Homebrew coding style violations. This should be run before submitting a new formula or cask. If no formula|cask are provided, check all locally available formulae and casks and skip style checks. Will exit with a non-zero status if any errors are found. --os Audit the given operating system. (Pass all to audit all operating systems.) --arch Audit the given CPU architecture. (Pass all to audit all architectures.) --strict Run additional, stricter style checks. --git Run additional, slower style checks that navigate the Git repository. --online Run additional, slower style checks that require a network connection. --installed Only check formulae and casks that are currently installed. --eval-all Evaluate all available formulae and casks, whether installed or not, to audit them. Implied if HOMEBREW_EVAL_ALL is set. --new Run various additional style checks to determine if a new formula or cask is eligible for Homebrew. This should be used when creating new formulae or casks and implies --strict and --online. --[no-]signing Audit for signed apps, which are required on ARM --token-conflicts Audit for token conflicts. --tap Check the formulae within the given tap, specified as user/repo. --fix Fix style violations automatically using RuboCopβs auto-correct feature. --display-filename Prefix every line of output with the file or formula name being audited, to make output easy to grep. --skip-style Skip running non-RuboCop style checks. Useful if you plan on running brew style separately. Enabled by default unless a formula is specified by name. -D, --audit-debug Enable debugging and profiling of audit methods. --only Specify a comma-separated method list to only run the methods named audit_method. --except Specify a comma-separated method list to skip running the methods named audit_method. --only-cops Specify a comma-separated cops list to check for violations of only the listed RuboCop cops. --except-cops Specify a comma-separated cops list to skip checking for violations of the listed RuboCop cops. --formula Treat all named arguments as formulae. --cask Treat all named arguments as casks. bottle [options] installed_formula|file [...] Generate a bottle (binary package) from a formula that was installed with --build-bottle. If the formula specifies a rebuild version, it will be incremented in the generated DSL. Passing --keep-old will attempt to keep it at its original value, while --no-rebuild will remove it. --skip-relocation Do not check if the bottle can be marked as relocatable. --force-core-tap Build a bottle even if formula is not in homebrew/core or any installed taps. --no-rebuild If the formula specifies a rebuild version, remove it from the generated DSL. --keep-old If the formula specifies a rebuild version, attempt to preserve its value in the generated DSL. --json Write bottle information to a JSON file, which can be used as the value for --merge. --merge Generate an updated bottle block for a formula and optionally merge it into the formula file. Instead of a formula name, requires the path to a JSON file generated with brew bottle --json formula. --write Write changes to the formula file. A new commit will be generated unless --no-commit is passed. --no-commit When passed with --write, a new commit will not generated after writing changes to the formula file. --only-json-tab When passed with --json, the tab will be written to the JSON file but not the bottle. --no-all-checks Donβt try to create an all bottle or stop a no-change upload. --committer Specify a committer name and email in gitβs standard author format. --root-url Use the specified URL as the root of the bottleβs URL instead of Homebrewβs default. --root-url-using Use the specified download strategy class for downloading the bottleβs URL instead of Homebrewβs default. bump [options] [formula|cask ...] Display out-of-date brew formulae and the latest version available. If the returned current and livecheck versions differ or when querying specific formulae, also displays whether a pull request has been opened with the URL. --full-name Print formulae/casks with fully-qualified names. --no-pull-requests Do not retrieve pull requests from GitHub. --formula Check only formulae. --cask Check only casks. --tap Check formulae and casks within the given tap, specified as user/repo. --installed Check formulae and casks that are currently installed. --no-fork Donβt try to fork the repository. --open-pr Open a pull request for the new version if none have been opened yet. --limit Limit number of package results returned. --start-with Letter or word that the list of package results should alphabetically follow. bump-cask-pr [options] cask Create a pull request to update cask with a new version. A best effort to determine the SHA-256 will be made if the value is not supplied by the user. -n, --dry-run Print what would be done rather than doing it. --write-only Make the expected file modifications without taking any Git actions. --commit When passed with --write-only, generate a new commit after writing changes to the cask file. --no-audit Donβt run brew audit before opening the PR. --no-style Donβt run brew style --fix before opening the PR. --no-browse Print the pull request URL instead of opening in a browser. --no-fork Donβt try to fork the repository. --version Specify the new version for the cask. --version-arm Specify the new cask version for the ARM architecture. --version-intel Specify the new cask version for the Intel architecture. --message Prepend message to the default pull request message. --url Specify the URL for the new download. --sha256 Specify the SHA-256 checksum of the new download. --fork-org Use the specified GitHub organization for forking. bump-formula-pr [options] [formula] Create a pull request to update formula with a new URL or a new tag. If a URL is specified, the SHA-256 checksum of the new download should also be specified. A best effort to determine the SHA-256 will be made if not supplied by the user. If a tag is specified, the Git commit revision corresponding to that tag should also be specified. A best effort to determine the revision will be made if the value is not supplied by the user. If a version is specified, a best effort to determine the URL and SHA-256 or the tag and revision will be made if both values are not supplied by the user. Note: this command cannot be used to transition a formula from a URL-and-SHA-256 style specification into a tag-and-revision style specification, nor vice versa. It must use whichever style specification the formula already uses. -n, --dry-run Print what would be done rather than doing it. --write-only Make the expected file modifications without taking any Git actions. --commit When passed with --write-only, generate a new commit after writing changes to the formula file. --no-audit Donβt run brew audit before opening the PR. --strict Run brew audit --strict before opening the PR. --online Run brew audit --online before opening the PR. --no-browse Print the pull request URL instead of opening in a browser. --no-fork Donβt try to fork the repository. --mirror Use the specified URL as a mirror URL. If URL is a comma-separated list of URLs, multiple mirrors will be added. --fork-org Use the specified GitHub organization for forking. --version Use the specified version to override the value parsed from the URL or tag. Note that --version=0 can be used to delete an existing version override from a formula if it has become redundant. --message Prepend message to the default pull request message. --url Specify the URL for the new download. If a URL is specified, the SHA-256 checksum of the new download should also be specified. --sha256 Specify the SHA-256 checksum of the new download. --tag Specify the new git commit tag for the formula. --revision Specify the new commit revision corresponding to the specified git tag or specified version. -f, --force Remove all mirrors if --mirror was not specified. --install-dependencies Install missing dependencies required to update resources. --python-package-name Use the specified package-name when finding Python resources for formula. If no package name is specified, it will be inferred from the formulaβs stable URL. --python-extra-packages Include these additional Python packages when finding resources. --python-exclude-packages Exclude these Python packages when finding resources. bump-revision [options] formula [...] Create a commit to increment the revision of formula. If no revision is present, βrevision 1β will be added. -n, --dry-run Print what would be done rather than doing it. --remove-bottle-block Remove the bottle block in addition to bumping the revision. --write-only Make the expected file modifications without taking any Git actions. --message Append message to the default commit message. bump-unversioned-casks [options] cask|tap [...] Check all casks with unversioned URLs in a given tap for updates. -n, --dry-run Do everything except caching state and opening pull requests. --limit Maximum runtime in minutes. --state-file File for caching state. cat [--formula] [--cask] formula|cask [...] Display the source of a formula or cask. --formula Treat all named arguments as formulae. --cask Treat all named arguments as casks. command command [...] Display the path to the file being used when invoking brew cmd. contributions [--user=email|username] [--repositories=] [--csv] Summarise contributions to Homebrew repositories. --repositories Specify a comma-separated list of repositories to search. Supported repositories: brew, core, cask, aliases, bundle, command-not-found, test-bot, services, cask-fonts and cask-versions. Omitting this flag, or specifying --repositories=primary, searches only the main repositories: brew,core,cask. Specifying --repositories=all, searches all repositories. --from Date (ISO-8601 format) to start searching contributions. Omitting this flag searches the last year. --to Date (ISO-8601 format) to stop searching contributions. --user Specify a comma-separated list of GitHub usernames or email addresses to find contributions from. Omitting this flag searches maintainers. --csv Print a CSV of contributions across repositories over the time period. create [options] URL Generate a formula or, with --cask, a cask for the downloadable file at URL and open it in the editor. Homebrew will attempt to automatically derive the formula name and version, but if it fails, youβll have to make your own template. The wget formula serves as a simple example. For the complete API, see: <https://rubydoc.brew.sh/Formula> --autotools Create a basic template for an Autotools-style build. --cask Create a basic template for a cask. --cmake Create a basic template for a CMake-style build. --crystal Create a basic template for a Crystal build. --go Create a basic template for a Go build. --meson Create a basic template for a Meson-style build. --node Create a basic template for a Node build. --perl Create a basic template for a Perl build. --python Create a basic template for a Python build. --ruby Create a basic template for a Ruby build. --rust Create a basic template for a Rust build. --no-fetch Homebrew will not download URL to the cache and will thus not add its SHA-256 to the formula for you, nor will it check the GitHub API for GitHub projects (to fill out its description and homepage). --HEAD Indicate that URL points to the packageβs repository rather than a file. --set-name Explicitly set the name of the new formula or cask. --set-version Explicitly set the version of the new formula or cask. --set-license Explicitly set the license of the new formula. --tap Generate the new formula within the given tap, specified as user/repo. -f, --force Ignore errors for disallowed formula names and names that shadow aliases. dispatch-build-bottle [options] formula [...] Build bottles for these formulae with GitHub Actions. --tap Target tap repository (default: homebrew/core). --timeout Build timeout (in minutes, default: 60). --issue If specified, post a comment to this issue number if the job fails. --macos macOS version (or comma-separated list of versions) the bottle should be built for. --workflow Dispatch specified workflow (default: dispatch-build-bottle.yml). --upload Upload built bottles. --linux Dispatch bottle for Linux (using GitHub runners). --linux-self-hosted Dispatch bottle for Linux (using self-hosted runner). --linux-wheezy Use Debian Wheezy container for building the bottle on Linux. edit [options] [formula|cask|tap ...] Open a formula, cask or tap in the editor set by EDITOR or HOMEBREW_EDITOR, or open the Homebrew repository for editing if no argument is provided. --formula Treat all named arguments as formulae. --cask Treat all named arguments as casks. --print-path Print the file path to be edited, without opening an editor. extract [--version=] [--force] formula tap Look through repository history to find the most recent version of formula and create a copy in tap. Specifically, the command will create the new formula file at tap/Formula/formula@version.rb. If the tap is not installed yet, attempt to install/clone the tap before continuing. To extract a formula from a tap that is not homebrew/core use its fully-qualified form of user/repo/formula. --version Extract the specified version of formula instead of the most recent. -f, --force Overwrite the destination formula if it already exists. formula formula [...] Display the path where formula is located. generate-cask-api [--dry-run] Generate homebrew/cask API data files for <https://formulae.brew.sh>. The generated files are written to the current directory. -n, --dry-run Generate API data without writing it to files. generate-formula-api [--dry-run] Generate homebrew/core API data files for <https://formulae.brew.sh>. The generated files are written to the current directory. -n, --dry-run Generate API data without writing it to files. generate-man-completions Generate Homebrewβs manpages and shell completions. install-bundler-gems [--groups=] [--add-groups=] Install Homebrewβs Bundler gems. --groups Installs the specified comma-separated list of gem groups (default: last used). Replaces any previously installed groups. --add-groups Installs the specified comma-separated list of gem groups, in addition to those already installed. irb [--examples] [--pry] Enter the interactive Homebrew Ruby shell. --examples Show several examples. --pry Use Pry instead of IRB. Implied if HOMEBREW_PRY is set. linkage [options] [installed_formula ...] Check the library links from the given formula kegs. If no formula are provided, check all kegs. Raises an error if run on uninstalled formulae. --test Show only missing libraries and exit with a non-zero status if any missing libraries are found. --strict Exit with a non-zero status if any undeclared dependencies with linkage are found. --reverse For every library that a keg references, print its dylib path followed by the binaries that link to it. --cached Print the cached linkage values stored in HOMEBREW_CACHE, set by a previous brew linkage run. livecheck, lc [options] [formula|cask ...] Check for newer versions of formulae and/or casks from upstream. If no formula or cask argument is passed, the list of formulae and casks to check is taken from HOMEBREW_LIVECHECK_WATCHLIST or ~/.homebrew/livecheck_watchlist.txt. --full-name Print formulae and casks with fully-qualified names. --tap Check formulae and casks within the given tap, specified as user/repo. --eval-all Evaluate all available formulae and casks, whether installed or not, to check them. --installed Check formulae and casks that are currently installed. --newer-only Show the latest version only if itβs newer than the formula/cask. --json Output information in JSON format. -r, --resources Also check resources for formulae. -q, --quiet Suppress warnings, donβt print a progress bar for JSON output. --formula Only check formulae. --cask Only check casks. --extract-plist Include casks using the ExtractPlist livecheck strategy. pr-automerge [options] Find pull requests that can be automatically merged using brew pr-publish. --tap Target tap repository (default: homebrew/core). --workflow Workflow file to use with brew pr-publish. --with-label Pull requests must have this label. --without-labels Pull requests must not have these labels (default: do not merge, new formula, automerge-skip, pre-release, CI-published-bottle-commits). --without-approval Pull requests do not require approval to be merged. --publish Run brew pr-publish on matching pull requests. --autosquash Instruct brew pr-publish to automatically reformat and reword commits in the pull request to the preferred format. --ignore-failures Include pull requests that have failing status checks. pr-publish [options] pull_request [...] Publish bottles for a pull request with GitHub Actions. Requires write access to the repository. --autosquash If supported on the target tap, automatically reformat and reword commits to our preferred format. --large-runner Run the upload job on a large runner. --branch Branch to use the workflow from (default: master). --message Message to include when autosquashing revision bumps, deletions and rebuilds. --tap Target tap repository (default: homebrew/core). --workflow Target workflow filename (default: publish-commit-bottles.yml). pr-pull [options] pull_request [...] Download and publish bottles, and apply the bottle commit from a pull request with artifacts generated by GitHub Actions. Requires write access to the repository. --no-upload Download the bottles but donβt upload them. --no-commit Do not generate a new commit before uploading. --no-cherry-pick Do not cherry-pick commits from the pull request branch. -n, --dry-run Print what would be done rather than doing it. --clean Do not amend the commits from pull requests. --keep-old If the formula specifies a rebuild version, attempt to preserve its value in the generated DSL. --autosquash Automatically reformat and reword commits in the pull request to our preferred format. --branch-okay Do not warn if pulling to a branch besides the repository default (useful for testing). --resolve When a patch fails to apply, leave in progress and allow user to resolve, instead of aborting. --warn-on-upload-failure Warn instead of raising an error if the bottle upload fails. Useful for repairing bottle uploads that previously failed. --retain-bottle-dir Does not clean up the tmp directory for the bottle so it can be used later. --committer Specify a committer name and email in gitβs standard author format. --message Message to include when autosquashing revision bumps, deletions and rebuilds. --artifact Download artifacts with the specified name (default: bottles). --tap Target tap repository (default: homebrew/core). --root-url Use the specified URL as the root of the bottleβs URL instead of Homebrewβs default. --root-url-using Use the specified download strategy class for downloading the bottleβs URL instead of Homebrewβs default. --workflows Retrieve artifacts from the specified workflow (default: tests.yml). Can be a comma-separated list to include multiple workflows. --ignore-missing-artifacts Comma-separated list of workflows which can be ignored if they have not been run. pr-upload [options] Apply the bottle commit and publish bottles to a host. --keep-old If the formula specifies a rebuild version, attempt to preserve its value in the generated DSL. -n, --dry-run Print what would be done rather than doing it. --no-commit Do not generate a new commit before uploading. --warn-on-upload-failure Warn instead of raising an error if the bottle upload fails. Useful for repairing bottle uploads that previously failed. --upload-only Skip running brew bottle before uploading. --committer Specify a committer name and email in gitβs standard author format. --root-url Use the specified URL as the root of the bottleβs URL instead of Homebrewβs default. --root-url-using Use the specified download strategy class for downloading the bottleβs URL instead of Homebrewβs default. prof [--stackprof] command [...] Run Homebrew with a Ruby profiler. For example, brew prof readall. --stackprof Use stackprof instead of ruby-prof (the default). release [--major] [--minor] Create a new draft Homebrew/brew release with the appropriate version number and release notes. By default, brew release will bump the patch version number. Pass --major or --minor to bump the major or minor version numbers, respectively. The command will fail if the previous major or minor release was made less than one month ago. Note: Requires write access to the Homebrew/brew repository. --major Create a major release. --minor Create a minor release. rubocop Installs, configures and runs Homebrewβs rubocop. ruby [options] (-e text|file) Run a Ruby instance with Homebrewβs libraries loaded. For example, brew ruby -e "puts :gcc.f.deps" or brew ruby script.rb. Run e.g. brew ruby -- --version to pass arbitrary arguments to ruby. -r Load a library using require. -e Execute the given text string as a script. sh [--env=] [--cmd=] [file] Enter an interactive shell for Homebrewβs build environment. Use years-battle-hardened build logic to help your ./configure && make && make install and even your gem install succeed. Especially handy if you run Homebrew in an Xcode-only configuration since it adds tools like make to your PATH which build systems would not find otherwise. --env Use the standard PATH instead of superenvβs when std is passed. -c, --cmd Execute commands in a non-interactive shell. style [options] [file|tap|formula|cask ...] Check formulae or files for conformance to Homebrew style guidelines. Lists of file, tap and formula may not be combined. If none are provided, style will run style checks on the whole Homebrew library, including core code and all formulae. --fix Fix style violations automatically using RuboCopβs auto-correct feature. --reset-cache Reset the RuboCop cache. --formula Treat all named arguments as formulae. --cask Treat all named arguments as casks. --only-cops Specify a comma-separated cops list to check for violations of only the listed RuboCop cops. --except-cops Specify a comma-separated cops list to skip checking for violations of the listed RuboCop cops. tap-new [options] user/repo Generate the template files for a new tap. --no-git Donβt initialize a Git repository for the tap. --pull-label Label name for pull requests ready to be pulled (default: pr-pull). --branch Initialize Git repository and setup GitHub Actions workflows with the specified branch name (default: main). --github-packages Upload bottles to GitHub Packages. test [options] installed_formula [...] Run the test method provided by an installed formula. There is no standard output or return code, but generally it should notify the user if something is wrong with the installed formula. Example: brew install jruby && brew test jruby -f, --force Test formulae even if they are unlinked. --HEAD Test the HEAD version of a formula. --keep-tmp Retain the temporary files created for the test. --retry Retry if a testing fails. tests [options] Run Homebrewβs unit and integration tests. --coverage Generate code coverage reports. --generic Run only OS-agnostic tests. --online Include tests that use the GitHub API and tests that use any of the taps for official external commands. --byebug Enable debugging using byebug. --changed Only runs tests on files that were changed from the master branch. --fail-fast Exit early on the first failing test. --only Run only test_script_spec.rb. Appending :line_number will start at a specific line. --profile Run the test suite serially to find the n slowest tests. --seed Randomise tests with the specified value instead of a random seed. typecheck, tc [options] Check for typechecking errors using Sorbet. --fix Automatically fix type errors. -q, --quiet Silence all non-critical errors. --update Update RBI files. --update-all Update all RBI files rather than just updated gems. --suggest-typed Try upgrading typed sigils. --dir Typecheck all files in a specific directory. --file Typecheck a single file. --ignore Ignores input files that contain the given string in their paths (relative to the input path passed to Sorbet). unbottled [options] [formula ...] Show the unbottled dependents of formulae. --tag Use the specified bottle tag (e.g. big_sur) instead of the current OS. --dependents Skip getting analytics data and sort by number of dependents instead. --total Print the number of unbottled and total formulae. --lost Print the homebrew/core commits where bottles were lost in the last week. --eval-all Evaluate all available formulae and casks, whether installed or not, to check them. Implied if HOMEBREW_EVAL_ALL is set. unpack [options] formula [...] Unpack the source files for formula into subdirectories of the current working directory. --destdir Create subdirectories in the directory named by path instead. --patch Patches for formula will be applied to the unpacked source. -g, --git Initialise a Git repository in the unpacked source. This is useful for creating patches for the software. -f, --force Overwrite the destination directory if it already exists. update-license-data Update SPDX license data in the Homebrew repository. update-maintainers Update the list of maintainers in the Homebrew/brew README. update-python-resources [options] formula [...] Update versions for PyPI resource blocks in formula. -p, --print-only Print the updated resource blocks instead of changing formula. -s, --silent Suppress any output. --ignore-non-pypi-packages Donβt fail if formula is not a PyPI package. --install-dependencies Install missing dependencies required to update resources. --version Use the specified version when finding resources for formula. If no version is specified, the current version for formula will be used. --package-name Use the specified package-name when finding resources for formula. If no package name is specified, it will be inferred from the formulaβs stable URL. --extra-packages Include these additional packages when finding resources. --exclude-packages Exclude these packages when finding resources. update-sponsors Update the list of GitHub Sponsors in the Homebrew/brew README. update-test [options] Run a test of brew update with a new repository clone. If no options are passed, use origin/master as the start commit. --to-tag Set HOMEBREW_UPDATE_TO_TAG to test updating between tags. --keep-tmp Retain the temporary directory containing the new repository clone. --commit Use the specified commit as the start commit. --before Use the commit at the specified date as the start commit. vendor-gems [--update=] [--no-commit] Install and commit Homebrewβs vendored gems. --update Update the specified list of vendored gems to the latest version. --no-commit Do not generate a new commit upon completion. GLOBAL CASK OPTIONS These options are applicable to the install, reinstall, and upgrade subcommands with the --cask switch. --appdir Target location for Applications (default: /Applications). --keyboard-layoutdir Target location for Keyboard Layouts (default: /Library/Keyboard Layouts). --colorpickerdir Target location for Color Pickers (default: ~/Library/ColorPickers). --prefpanedir Target location for Preference Panes (default: ~/Library/PreferencePanes). --qlplugindir Target location for Quick Look Plugins (default: ~/Library/QuickLook). --mdimporterdir Target location for Spotlight Plugins (default: ~/Library/Spotlight). --dictionarydir Target location for Dictionaries (default: ~/Library/Dictionaries). --fontdir Target location for Fonts (default: ~/Library/Fonts). --servicedir Target location for Services (default: ~/Library/Services). --input-methoddir Target location for Input Methods (default: ~/Library/Input Methods). --internet-plugindir Target location for Internet Plugins (default: ~/Library/Internet Plug-Ins). --audio-unit-plugindir Target location for Audio Unit Plugins (default: ~/Library/Audio/Plug-Ins/Components). --vst-plugindir Target location for VST Plugins (default: ~/Library/Audio/Plug-Ins/VST). --vst3-plugindir Target location for VST3 Plugins (default: ~/Library/Audio/Plug-Ins/VST3). --screen-saverdir Target location for Screen Savers (default: ~/Library/Screen Savers). --language Comma-separated list of language codes to prefer for cask installation. The first matching language is used, otherwise it reverts to the caskβs default language. The default value is the language of your system. GLOBAL OPTIONS These options are applicable across multiple subcommands. -d, --debug Display any debugging information. -q, --quiet Make some output more quiet. -v, --verbose Make some output more verbose. -h, --help Show this message. OFFICIAL EXTERNAL COMMANDS alias [alias ... | alias=command] Show existing aliases. If no aliases are given, print the whole list. --edit Edit aliases in a text editor. Either one or all aliases may be opened at once. If the given alias doesnβt exist itβll be pre-populated with a template. bundle [subcommand] Bundler for non-Ruby dependencies from Homebrew, Homebrew Cask, Mac App Store, Whalebrew and Visual Studio Code. brew bundle [install] Install and upgrade (by default) all dependencies from the Brewfile. You can specify the Brewfile location using --file or by setting the HOMEBREW_BUNDLE_FILE environment variable. You can skip the installation of dependencies by adding space-separated values to one or more of the following environment variables: HOMEBREW_BUNDLE_BREW_SKIP, HOMEBREW_BUNDLE_CASK_SKIP, HOMEBREW_BUNDLE_MAS_SKIP, HOMEBREW_BUNDLE_WHALEBREW_SKIP, HOMEBREW_BUNDLE_TAP_SKIP. brew bundle will output a Brewfile.lock.json in the same directory as the Brewfile if all dependencies are installed successfully. This contains dependency and system status information which can be useful for debugging brew bundle failures and replicating a βlast known good buildβ state. You can opt-out of this behaviour by setting the HOMEBREW_BUNDLE_NO_LOCK environment variable or passing the --no-lock option. You may wish to check this file into the same version control system as your Brewfile (or ensure your version control system ignores it if youβd prefer to rely on debugging information from a local machine). brew bundle dump Write all installed casks/formulae/images/taps into a Brewfile in the current directory. brew bundle cleanup Uninstall all dependencies not present in the Brewfile. This workflow is useful for maintainers or testers who regularly install lots of formulae. brew bundle check Check if all dependencies present in the Brewfile are installed. This provides a successful exit code if everything is up-to-date, making it useful for scripting. brew bundle list List all dependencies present in the Brewfile. By default, only Homebrew formula dependencies are listed. brew bundle exec command Run an external command in an isolated build environment based on the Brewfile dependencies. This sanitized build environment ignores unrequested dependencies, which makes sure that things you didnβt specify in your Brewfile wonβt get picked up by commands like bundle install, npm install, etc. It will also add compiler flags which will help with finding keg-only dependencies like openssl, icu4c, etc. --file Read the Brewfile from this location. Use --file=- to pipe to stdin/stdout. --global Read the Brewfile from ~/.Brewfile or the HOMEBREW_BUNDLE_FILE_GLOBAL environment variable, if set. -v, --verbose install prints output from commands as they are run. check lists all missing dependencies. --no-upgrade install does not run brew upgrade on outdated dependencies. Note they may still be upgraded by brew install if needed. -f, --force install runs with --force/--overwrite. dump overwrites an existing Brewfile. cleanup actually performs its cleanup operations. --cleanup install performs cleanup operation, same as running cleanup --force. This is enabled by default if HOMEBREW_BUNDLE_INSTALL_CLEANUP is set and --global is passed. --no-lock install does not output a Brewfile.lock.json. --all list all dependencies. --formula list Homebrew formula dependencies. --cask list Homebrew cask dependencies. --tap list Homebrew tap dependencies. --mas list Mac App Store dependencies. --whalebrew list Whalebrew dependencies. --vscode list VSCode extensions. --describe dump adds a description comment above each line, unless the dependency does not have a description. This is enabled by default if HOMEBREW_BUNDLE_DUMP_DESCRIBE is set. --no-restart dump does not add restart_service to formula lines. --zap cleanup casks using the zap command instead of uninstall. command-not-found-init Print instructions for setting up the command-not-found hook for your shell. If the output is not to a tty, print the appropriate handler script for your shell. services [subcommand] Manage background services with macOSβ launchctl(1) daemon manager or Linuxβs systemctl(1) service manager. If sudo is passed, operate on /Library/LaunchDaemons//usr/lib/systemd/system (started at boot). Otherwise, operate on ~/Library/LaunchAgents/~/.config/systemd/user (started at login). [sudo] brew services [list] (--json) (--debug) List information about all managed services for the current user (or root). Provides more output from Homebrew and launchctl(1) or systemctl(1) if run with --debug. [sudo] brew services info (formula|--all|--json) List all managed services for the current user (or root). [sudo] brew services run (formula|--all) Run the service formula without registering to launch at login (or boot). [sudo] brew services start (formula|--all|--file=) Start the service formula immediately and register it to launch at login (or boot). [sudo] brew services stop (formula|--all) Stop the service formula immediately and unregister it from launching at login (or boot). [sudo] brew services kill (formula|--all) Stop the service formula immediately but keep it registered to launch at login (or boot). [sudo] brew services restart (formula|--all) Stop (if necessary) and start the service formula immediately and register it to launch at login (or boot). [sudo] brew services cleanup Remove all unused services. --file Use the service file from this location to start the service. --sudo-service-user When run as root on macOS, run the service(s) as this user. --all Run subcommand on all services. --json Output as JSON. --no-wait Donβt wait for stop to finish stopping the service. test-bot [options] [formula] Tests the full lifecycle of a Homebrew change to a tap (Git repository). For example, for a GitHub Actions pull request that changes a formula brew test-bot will ensure the system is cleaned and set up to test the formula, install the formula, run various tests and checks on it, bottle (package) the binaries and test formulae that depend on it to ensure they arenβt broken by these changes. Only supports GitHub Actions as a CI provider. This is because Homebrew uses GitHub Actions and itβs freely available for public and private use with macOS and Linux workers. --dry-run Print what would be done rather than doing it. --cleanup Clean all state from the Homebrew directory. Use with care! --skip-setup Donβt check if the local system is set up correctly. --build-from-source Build from source rather than building bottles. --build-dependents-from-source Build dependents from source rather than testing bottles. --junit generate a JUnit XML test results file. --keep-old Run brew bottle --keep-old to build new bottles for a single platform. --skip-relocation Run brew bottle --skip-relocation to build new bottles that donβt require relocation. --only-json-tab Run brew bottle --only-json-tab to build new bottles that do not contain a tab. --local Ask Homebrew to write verbose logs under ./logs/ and set $HOME to ./home/ --tap Use the Git repository of the given tap. Defaults to the core tap for syntax checking. --fail-fast Immediately exit on a failing step. -v, --verbose Print test step output in real time. Has the side effect of passing output as raw bytes instead of re-encoding in UTF-8. --test-default-formula Use a default testing formula when not building a tap and no other formulae are specified. --root-url Use the specified URL as the root of the bottleβs URL instead of Homebrewβs default. --git-name Set the Git author/committer names to the given name. --git-email Set the Git author/committer email to the given email. --publish Publish the uploaded bottles. --skip-online-checks Donβt pass --online to brew audit and skip brew livecheck. --skip-dependents Donβt test any dependents. --skip-livecheck Donβt test livecheck. --skip-recursive-dependents Only test the direct dependents. --skip-checksum-only-audit Donβt audit checksum-only changes. --skip-stable-version-audit Donβt audit the stable version. --skip-revision-audit Donβt audit the revision. --only-cleanup-before Only run the pre-cleanup step. Needs --cleanup. --only-setup Only run the local system setup check step. --only-tap-syntax Only run the tap syntax check step. --only-formulae Only run the formulae steps. --only-formulae-detect Only run the formulae detection steps. --only-formulae-dependents Only run the formulae dependents steps. --only-bottles-fetch Only run the bottles fetch steps. This optional post-upload test checks that all the bottles were uploaded correctly. It is not run unless requested and only needs to be run on a single machine. The bottle commit to be tested must be on the tested branch. --only-cleanup-after Only run the post-cleanup step. Needs --cleanup. --testing-formulae Use these testing formulae rather than running the formulae detection steps. --added-formulae Use these added formulae rather than running the formulae detection steps. --deleted-formulae Use these deleted formulae rather than running the formulae detection steps. --skipped-or-failed-formulae Use these skipped or failed formulae from formulae steps for a formulae dependents step. unalias alias [...] Remove aliases. which-formula [--explain] command [...] Show which formula(e) provides the given command. --explain Output explanation of how to get command by installing one of the providing formulae. which-update [options] [database] Database update for brew which-formula. --stats Print statistics about the database contents (number of commands and formulae, list of missing formulae). --commit Commit the changes using git. --update-existing Update database entries with outdated formula versions. --install-missing Install and update formulae that are missing from the database and donβt have bottles. --eval-all Evaluate all installed taps, rather than just the core tap. --max-downloads Specify a maximum number of formulae to download and update. CUSTOM EXTERNAL COMMANDS Homebrew, like git(1), supports external commands. These are executable scripts that reside somewhere in the PATH, named brew-cmdname or brew-cmdname.rb, which can be invoked like brew cmdname. This allows you to create your own commands without modifying Homebrewβs internals. Instructions for creating your own commands can be found in the docs: <https://docs.brew.sh/External-Commands> SPECIFYING FORMULAE Many Homebrew commands accept one or more formula arguments. These arguments can take several different forms: β’ The name of a formula: e.g. git, node, wget. β’ The fully-qualified name of a tapped formula: Sometimes a formula from a tapped repository may conflict with one in homebrew/core. You can still access these formulae by using a special syntax, e.g. homebrew/dupes/vim or homebrew/versions/node4. β’ An arbitrary file: Homebrew can install formulae from a local path. It can point to either a formula file or a bottle. Prefix relative paths with ./ to prevent them from being interpreted as a formula or tap name. SPECIFYING CASKS Many Homebrew Cask commands accept one or more cask arguments. These can be specified the same way as the formula arguments described in SPECIFYING FORMULAE above. ENVIRONMENT Note that environment variables must have a value set to be detected. For example, run export HOMEBREW_NO_INSECURE_REDIRECT=1 rather than just export HOMEBREW_NO_INSECURE_REDIRECT. HOMEBREW_* environment variables can also be set in Homebrewβs environment files: β’ /etc/homebrew/brew.env (system-wide) β’ $HOMEBREW_PREFIX/etc/homebrew/brew.env (prefix-specific) β’ $XDG_CONFIG_HOME/homebrew/brew.env if $XDG_CONFIG_HOME is set or $HOME/.homebrew/brew.env otherwise (user-specific) User-specific environment files take precedence over prefix-specific files and prefix-specific files take precedence over system-wide files (unless HOMEBREW_SYSTEM_ENV_TAKES_PRIORITY is set, see below). Note that these files do not support shell variable expansion e.g. $HOME or command execution e.g. $(cat file). HOMEBREW_API_DOMAIN Use this URL as the download mirror for Homebrew JSON API. If metadata files at that URL are temporarily unavailable, the default API domain will be used as a fallback mirror. Default: https://formulae.brew.sh/api. HOMEBREW_ARCH Linux only: Pass this value to a type name representing the compilerβs -march option. Default: native. HOMEBREW_ARTIFACT_DOMAIN Prefix all download URLs, including those for bottles, with this value. For example, HOMEBREW_ARTIFACT_DOMAIN=http://localhost:8080 will cause a formula with the URL https://example.com/foo.tar.gz to instead download from http://localhost:8080/https://example.com/foo.tar.gz. Bottle URLs however, have their domain replaced with this prefix. This results in e.g. https://ghcr.io/v2/homebrew/core/gettext/manifests/0.21 to instead be downloaded from http://localhost:8080/v2/homebrew/core/gettext/manifests/0.21 HOMEBREW_API_AUTO_UPDATE_SECS Check Homebrewβs API for new formulae or cask data every HOMEBREW_API_AUTO_UPDATE_SECS seconds. Alternatively, disable API auto-update checks entirely with HOMEBREW_NO_AUTO_UPDATE. Default: 450. HOMEBREW_AUTO_UPDATE_SECS Run brew update once every HOMEBREW_AUTO_UPDATE_SECS seconds before some commands, e.g. brew install, brew upgrade and brew tap. Alternatively, disable auto-update entirely with HOMEBREW_NO_AUTO_UPDATE. Default: 86400 (24 hours), 3600 (1 hour) if a developer command has been run or 300 (5 minutes) if HOMEBREW_NO_INSTALL_FROM_API is set. HOMEBREW_AUTOREMOVE If set, calls to brew cleanup and brew uninstall will automatically remove unused formula dependents and if HOMEBREW_NO_INSTALL_CLEANUP is not set, brew cleanup will start running brew autoremove periodically. HOMEBREW_BAT If set, use bat for the brew cat command. HOMEBREW_BAT_CONFIG_PATH Use this as the bat configuration file. Default: $BAT_CONFIG_PATH. HOMEBREW_BAT_THEME Use this as the bat theme for syntax highlighting. Default: $BAT_THEME. HOMEBREW_BOOTSNAP If set, use Bootsnap to speed up repeated brew calls. A no-op when using Homebrewβs vendored, relocatable Ruby on macOS (as it doesnβt work). HOMEBREW_BOTTLE_DOMAIN Use this URL as the download mirror for bottles. If bottles at that URL are temporarily unavailable, the default bottle domain will be used as a fallback mirror. For example, HOMEBREW_BOTTLE_DOMAIN=http://localhost:8080 will cause all bottles to download from the prefix http://localhost:8080/. If bottles are not available at HOMEBREW_BOTTLE_DOMAIN they will be downloaded from the default bottle domain. Default: https://ghcr.io/v2/homebrew/core. HOMEBREW_BREW_GIT_REMOTE Use this URL as the Homebrew/brew git(1) remote. Default: https://github.com/Homebrew/brew. HOMEBREW_BROWSER Use this as the browser when opening project homepages. Default: $BROWSER or the OSβs default browser. HOMEBREW_CACHE Use this directory as the download cache. Default: macOS: $HOME/Library/Caches/Homebrew, Linux: $XDG_CACHE_HOME/Homebrew or $HOME/.cache/Homebrew. HOMEBREW_CASK_OPTS Append these options to all cask commands. All --*dir options, --language, --require-sha, --no-quarantine and --no-binaries are supported. For example, you might add something like the following to your ~/.profile, ~/.bash_profile, or ~/.zshenv: export HOMEBREW_CASK_OPTS="--appdir=~/Applications --fontdir=/Library/Fonts" HOMEBREW_CLEANUP_MAX_AGE_DAYS Cleanup all cached files older than this many days. Default: 120. HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS If set, brew install, brew upgrade and brew reinstall will cleanup all formulae when this number of days has passed. Default: 30. HOMEBREW_COLOR If set, force colour output on non-TTY outputs. HOMEBREW_CORE_GIT_REMOTE Use this URL as the Homebrew/homebrew-core git(1) remote. Default: https://github.com/Homebrew/homebrew-core. HOMEBREW_CURL_PATH Linux only: Set this value to a new enough curl executable for Homebrew to use. Default: curl. HOMEBREW_CURL_RETRIES Pass the given retry count to --retry when invoking curl(1). Default: 3. HOMEBREW_CURL_VERBOSE If set, pass --verbose when invoking curl(1). HOMEBREW_CURLRC If set to an absolute path (i.e. beginning with /), pass it with --config when invoking curl(1). If set but not a valid path, do not pass --disable, which disables the use of .curlrc. HOMEBREW_DEBUG If set, always assume --debug when running commands. HOMEBREW_DEVELOPER If set, tweak behaviour to be more relevant for Homebrew developers (active or budding) by e.g. turning warnings into errors. HOMEBREW_DISABLE_LOAD_FORMULA If set, refuse to load formulae. This is useful when formulae are not trusted (such as in pull requests). HOMEBREW_DISPLAY Use this X11 display when opening a page in a browser, for example with brew home. Primarily useful on Linux. Default: $DISPLAY. HOMEBREW_DISPLAY_INSTALL_TIMES If set, print install times for each formula at the end of the run. HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN Use this base64 encoded username and password for authenticating with a Docker registry proxying GitHub Packages. If HOMEBREW_DOCKER_REGISTRY_TOKEN is set, it will be used instead. HOMEBREW_DOCKER_REGISTRY_TOKEN Use this bearer token for authenticating with a Docker registry proxying GitHub Packages. Preferred over HOMEBREW_DOCKER_REGISTRY_BASIC_AUTH_TOKEN. HOMEBREW_EDITOR Use this editor when editing a single formula, or several formulae in the same directory. Note: brew edit will open all of Homebrew as discontinuous files and directories. Visual Studio Code can handle this correctly in project mode, but many editors will do strange things in this case. Default: $EDITOR or $VISUAL. HOMEBREW_EVAL_ALL If set, brew commands evaluate all formulae and casks, executing their arbitrary code, by default without requiring --eval-all. Required to cache formula and cask descriptions. HOMEBREW_FAIL_LOG_LINES Output this many lines of output on formula system failures. Default: 15. HOMEBREW_FORBIDDEN_LICENSES A space-separated list of licenses. Homebrew will refuse to install a formula if it or any of its dependencies has a license on this list. HOMEBREW_FORCE_BREWED_CA_CERTIFICATES If set, always use a Homebrew-installed ca-certificates rather than the system version. Automatically set if the system version is too old. HOMEBREW_FORCE_BREWED_CURL If set, always use a Homebrew-installed curl(1) rather than the system version. Automatically set if the system version of curl is too old. HOMEBREW_FORCE_BREWED_GIT If set, always use a Homebrew-installed git(1) rather than the system version. Automatically set if the system version of git is too old. HOMEBREW_FORCE_VENDOR_RUBY If set, always use Homebrewβs vendored, relocatable Ruby version even if the system version of Ruby is new enough. HOMEBREW_GIT_EMAIL Set the Git author and committer email to this value. HOMEBREW_GIT_NAME Set the Git author and committer name to this value. HOMEBREW_GIT_PATH Linux only: Set this value to a new enough git executable for Homebrew to use. Default: git. HOMEBREW_GITHUB_API_TOKEN Use this personal access token for the GitHub API, for features such as brew search. You can create one at <https://github.com/settings/tokens>. If set, GitHub will allow you a greater number of API requests. For more information, see: <https://docs.github.com/en/rest/overview/rate-limits-for-the-rest-api> Note: Homebrew doesnβt require permissions for any of the scopes, but some developer commands may require additional permissions. HOMEBREW_GITHUB_PACKAGES_TOKEN Use this GitHub personal access token when accessing the GitHub Packages Registry (where bottles may be stored). HOMEBREW_GITHUB_PACKAGES_USER Use this username when accessing the GitHub Packages Registry (where bottles may be stored). HOMEBREW_INSTALL_BADGE Print this text before the installation summary of each successful build. Default: The βBeer Mugβ emoji. HOMEBREW_LIVECHECK_WATCHLIST Consult this file for the list of formulae to check by default when no formula argument is passed to brew livecheck. Default: $XDG_CONFIG_HOME/homebrew/livecheck_watchlist.txt if $XDG_CONFIG_HOME is set or $HOME/.homebrew/livecheck_watchlist.txt otherwise. HOMEBREW_LOGS Use this directory to store log files. Default: macOS: $HOME/Library/Logs/Homebrew, Linux: $XDG_CACHE_HOME/Homebrew/Logs or $HOME/.cache/Homebrew/Logs. HOMEBREW_MAKE_JOBS Use this value as the number of parallel jobs to run when building with make(1). Default: The number of available CPU cores. HOMEBREW_NO_ANALYTICS If set, do not send analytics. Google Analytics were destroyed. For more information, see: <https://docs.brew.sh/Analytics> HOMEBREW_NO_AUTO_UPDATE If set, do not automatically update before running some commands, e.g. brew install, brew upgrade and brew tap. Alternatively, run this less often by setting HOMEBREW_AUTO_UPDATE_SECS to a value higher than the default. HOMEBREW_NO_BOOTSNAP If set, do not use Bootsnap to speed up repeated brew calls. HOMEBREW_NO_CLEANUP_FORMULAE A comma-separated list of formulae. Homebrew will refuse to clean up or autoremove a formula if it appears on this list. HOMEBREW_NO_COLOR If set, do not print text with colour added. Default: $NO_COLOR. HOMEBREW_NO_EMOJI If set, do not print HOMEBREW_INSTALL_BADGE on a successful build. HOMEBREW_NO_ENV_HINTS If set, do not print any hints about changing Homebrewβs behaviour with environment variables. HOMEBREW_NO_GITHUB_API If set, do not use the GitHub API, e.g. for searches or fetching relevant issues after a failed install. HOMEBREW_NO_INSECURE_REDIRECT If set, forbid redirects from secure HTTPS to insecure HTTP. Note: while ensuring your downloads are fully secure, this is likely to cause from-source SourceForge, some GNU & GNOME-hosted formulae to fail to download. HOMEBREW_NO_INSTALL_CLEANUP If set, brew install, brew upgrade and brew reinstall will never automatically cleanup installed/upgraded/reinstalled formulae or all formulae every HOMEBREW_CLEANUP_PERIODIC_FULL_DAYS days. Alternatively, HOMEBREW_NO_CLEANUP_FORMULAE allows specifying specific formulae to not clean up. HOMEBREW_NO_INSTALL_FROM_API If set, do not install formulae and casks in homebrew/core and homebrew/cask taps using Homebrewβs API and instead use (large, slow) local checkouts of these repositories. HOMEBREW_NO_INSTALL_UPGRADE If set, brew install formula|cask will not upgrade formula|cask if it is installed but outdated. HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK If set, do not check for broken linkage of dependents or outdated dependents after installing, upgrading or reinstalling formulae. This will result in fewer dependents (and their dependencies) being upgraded or reinstalled but may result in more breakage from running brew install formula or brew upgrade formula. HOMEBREW_NO_UPDATE_REPORT_NEW If set, brew update will not show the list of newly added formulae/casks. HOMEBREW_PIP_INDEX_URL If set, brew install formula will use this URL to download PyPI package resources. Default: https://pypi.org/simple. HOMEBREW_PRY If set, use Pry for the brew irb command. HOMEBREW_UPGRADE_GREEDY If set, pass --greedy to all cask upgrade commands. HOMEBREW_SIMULATE_MACOS_ON_LINUX If set, running Homebrew on Linux will simulate certain macOS code paths. This is useful when auditing macOS formulae while on Linux. HOMEBREW_SKIP_OR_LATER_BOTTLES If set along with HOMEBREW_DEVELOPER, do not use bottles from older versions of macOS. This is useful in development on new macOS versions. HOMEBREW_SORBET_RUNTIME If set, enable runtime typechecking using Sorbet. Set by default for HOMEBREW_DEVELOPER or when running some developer commands. HOMEBREW_SSH_CONFIG_PATH If set, Homebrew will use the given config file instead of ~/.ssh/config when fetching Git repositories over SSH. Default: $HOME/.ssh/config HOMEBREW_SVN Use this as the svn(1) binary. Default: A Homebrew-built Subversion (if installed), or the system-provided binary. HOMEBREW_SYSTEM_ENV_TAKES_PRIORITY If set in Homebrewβs system-wide environment file (/etc/homebrew/brew.env), the system-wide environment file will be loaded last to override any prefix or user settings. HOMEBREW_SUDO_THROUGH_SUDO_USER If set, Homebrew will use the SUDO_USER environment variable to define the user to sudo(8) through when running sudo(8). HOMEBREW_TEMP Use this path as the temporary directory for building packages. Changing this may be needed if your system temporary directory and Homebrew prefix are on different volumes, as macOS has trouble moving symlinks across volumes when the target does not yet exist. This issue typically occurs when using FileVault or custom SSD configurations. Default: macOS: /private/tmp, Linux: /tmp. HOMEBREW_UPDATE_TO_TAG If set, always use the latest stable tag (even if developer commands have been run). HOMEBREW_VERBOSE If set, always assume --verbose when running commands. HOMEBREW_VERBOSE_USING_DOTS If set, verbose output will print a . no more than once a minute. This can be useful to avoid long-running Homebrew commands being killed due to no output. SUDO_ASKPASS If set, pass the -A option when calling sudo(8). all_proxy Use this SOCKS5 proxy for curl(1), git(1) and svn(1) when downloading through Homebrew. ftp_proxy Use this FTP proxy for curl(1), git(1) and svn(1) when downloading through Homebrew. http_proxy Use this HTTP proxy for curl(1), git(1) and svn(1) when downloading through Homebrew. https_proxy Use this HTTPS proxy for curl(1), git(1) and svn(1) when downloading through Homebrew. no_proxy A comma-separated list of hostnames and domain names excluded from proxying by curl(1), git(1) and svn(1) when downloading through Homebrew. USING HOMEBREW BEHIND A PROXY Set the http_proxy, https_proxy, all_proxy, ftp_proxy and/or no_proxy environment variables documented above. For example, to use an unauthenticated HTTP or SOCKS5 proxy: export http_proxy=http://$HOST:$PORT export all_proxy=socks5://$HOST:$PORT And for an authenticated HTTP proxy: export http_proxy=http://$USER:$PASSWORD@$HOST:$PORT SEE ALSO Homebrew Documentation: <https://docs.brew.sh> Homebrew API: <https://rubydoc.brew.sh> git(1), git-log(1) AUTHORS Homebrewβs Project Leader is Mike McQuaid. Homebrewβs Project Leadership Committee is Colin Dean, Issy Long, Mike McQuaid, Patrick Linnane and Vanessa Gennarelli. Homebrewβs Technical Steering Committee is Bo Anderson, FX Coudert, Michka Popoff, Mike McQuaid and Rylan Polster. Homebrewβs maintainers are Alexander Bayandin, Bevan Kay, Bo Anderson, Branch Vincent, Caleb Xu, Carlo Cabrera, David Baumgold, Douglas Eichelberger, Dustin Rodrigues, Eric Knibbe, FX Coudert, Issy Long, Justin Krehel, Markus Reiter, Miccal Matthews, Michael Cho, Michka Popoff, Mike McQuaid, Nanda H Krishna, Patrick Linnane, Razvan Azamfirei, Rui Chen, Ruoyu Zhong, Rylan Polster, Sam Ford, Sean Molenaar and Thierry Moisan. Former maintainers with significant contributions include Misty De MΓ©o, Shaun Jackman, VΓtor GalvΓ£o, Claudia Pellegrino, Seeker, William Woodruff, Jan Viljanen, JCount, commitay, Dominyk Tiller, Tim Smith, Baptiste Fontaine, Xu Cheng, Martin Afanasjew, Brett Koonce, Charlie Sharpsteen, Jack Nagel, Adam Vandenberg, Andrew Janke, Alex Dunn, neutric, Tomasz Pajor, Uladzislau Shablinski, Alyssa Ross, ilovezfs, Chongyu Zhu and Homebrewβs creator: Max Howell. BUGS See our issues on GitHub: Homebrew/brew <https://github.com/Homebrew/brew/issues> Homebrew/homebrew-core <https://github.com/Homebrew/homebrew-core/issues> Homebrew/homebrew-cask <https://github.com/Homebrew/homebrew-cask/issues> Homebrew March 2024 BREW(1)
|
brew - The Missing Package Manager for macOS (or Linux)
|
brew --version brew command [--verbose|-v] [options] [formula] ...
| null | null |
sgpt
| null | null | null | null | null |
make_chlayout_test
| null | null | null | null | null |
vimtutor
|
Vimtutor starts the Vim tutor. It copies the tutor file first, so that it can be modified without changing the original file. The Vimtutor is useful for people that want to learn their first Vim commands. The optional argument -g starts vimtutor with gvim rather than vim, if the GUI version of vim is available, or falls back to Vim if gvim is not found. The optional [language] argument is the two-letter name of a language, like "it" or "es". If the [language] argument is missing, the language of the current locale will be used. If a tutor in this language is available, it will be used. Otherwise the English version will be used. Vim is always started in Vi compatible mode. FILES /opt/homebrew/Cellar/vim/9.1.0600/share/vim/vim91/tutor/tutor[.language] The Vimtutor text file(s). /opt/homebrew/Cellar/vim/9.1.0600/share/vim/vim91/tutor/tutor.vim The Vim script used to copy the Vimtutor text file. AUTHOR The Vimtutor was originally written for Vi by Michael C. Pierce and Robert K. Ware, Colorado School of Mines using ideas supplied by Charles Smith, Colorado State University. E-mail: bware@mines.colorado.edu (now invalid). It was modified for Vim by Bram Moolenaar. For the names of the translators see the tutor files. SEE ALSO vim(1) 2001 April 2 VIMTUTOR(1)
|
vimtutor - the Vim tutor
|
vimtutor [-g] [language]
| null | null |
vmaf
| null | null | null | null | null |
mini_client
| null | null | null | null | null |
tdspool
| null | null | null | null | null |
timeout
|
Start COMMAND, and kill it if still running after DURATION. Mandatory arguments to long options are mandatory for short options too. --preserve-status exit with the same status as COMMAND, even when the command times out --foreground when not running timeout directly from a shell prompt, allow COMMAND to read from the TTY and get TTY signals; in this mode, children of COMMAND will not be timed out -k, --kill-after=DURATION also send a KILL signal if COMMAND is still running this long after the initial signal was sent -s, --signal=SIGNAL specify the signal to be sent on timeout; SIGNAL may be a name like 'HUP' or a number; see 'kill -l' for a list of signals -v, --verbose diagnose to stderr any signal sent upon timeout --help display this help and exit --version output version information and exit DURATION is a floating point number with an optional suffix: 's' for seconds (the default), 'm' for minutes, 'h' for hours or 'd' for days. A duration of 0 disables the associated timeout. Upon timeout, send the TERM signal to COMMAND, if no other SIGNAL specified. The TERM signal kills any process that does not block or catch that signal. It may be necessary to use the KILL signal, since this signal can't be caught. Exit status: 124 if COMMAND times out, and --preserve-status is not specified 125 if the timeout command itself fails 126 if COMMAND is found but cannot be invoked 127 if COMMAND cannot be found 137 if COMMAND (or timeout itself) is sent the KILL (9) signal (128+9) - the exit status of COMMAND otherwise BUGS Some platforms don't currently support timeouts beyond the year 2038. AUTHOR Written by Padraig Brady. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO kill(1) Full documentation <https://www.gnu.org/software/coreutils/timeout> or available locally via: info '(coreutils) timeout invocation' GNU coreutils 9.3 April 2023 TIMEOUT(1)
|
timeout - run a command with a time limit
|
timeout [OPTION] DURATION COMMAND [ARG]... timeout [OPTION]
| null | null |
phar
|
The PHAR file format provides a way to put entire PHP applications into a single file called a "phar" (PHP Archive) for easy distribution and installation. With the phar command you can create, update or extract PHP archives. Commands: add compress delete extract help help-list info list meta-del meta-get meta-set pack sign stub-get stub-set tree version add command Add entries to a PHAR package. Required arguments: -f file Specifies the phar file to work on. ... Any number of input files and directories. If -i is in use then ONLY files and matching the given regular expression are being packed. If -x is given then files matching that regular expression are NOT being packed. Optional arguments: -a alias Provide an alias name for the phar file. -c algo Compression algorithm (see COMPRESSION ) -i regex Specifies a regular expression for input files. -l level Number of preceding subdirectories to strip from file entries -x regex Regular expression for input files to exclude. compress command Compress or uncompress all files or a selected entry. Required arguments: -c algo Compression algorithm (see COMPRESSION ) -f file Specifies the phar file to work on. Optional arguments: -e entry Name of entry to work on (must include PHAR internal directory name if any). delete command Delete entry from a PHAR archive Required arguments: -e entry Name of entry to work on (must include PHAR internal directory name if any). -f file Specifies the phar file to work on. extract command Extract a PHAR package to a directory. Required arguments: -f file Specifies the phar file to work on. Optional arguments: -i regex Specifies a regular expression for input files. -x regex Regular expression for input files to exclude. ... Directory to extract to (defaults to '.'). help command This help or help for a selected command. Optional arguments: ... Optional command to retrieve help for. help-list command Lists available commands. info command Get information about a PHAR package. By using -k it is possible to return a single value. Required arguments: -f file Specifies the phar file to work on. Optional arguments: -k index Subscription index to work on. list command List contents of a PHAR archive. Required arguments: -f file Specifies the phar file to work on. Optional arguments: -i regex Specifies a regular expression for input files. -x regex Regular expression for input files to exclude. meta-del command Delete meta information of a PHAR entry or a PHAR package. If -k is given then the metadata is expected to be an array and the given index is being deleted. If something was deleted the return value is 0 otherwise it is 1. Required arguments: -f file Specifies the phar file to work on. Optional arguments: -e entry Name of entry to work on (must include PHAR internal directory name if any). -k index Subscription index to work on. meta-get command Get meta information of a PHAR entry or a PHAR package in serialized from. If no output file is specified for meta data then stdout is being used. You can also specify a particular index using -k. In that case the metadata is expected to be an array and the value of the given index is returned using echo rather than using serialize. If that index does not exist or no meta data is present then the return value is 1. Required arguments: -f file Specifies the phar file to work on. Optional arguments: -e entry Name of entry to work on (must include PHAR internal directory name if any). -k index Subscription index to work on. meta-set command Set meta data of a PHAR entry or a PHAR package using serialized input. If no input file is specified for meta data then stdin is being used. You can also specify a particular index using -k. In that case the metadata is expected to be an array and the value of the given index is being set. If the metadata is not present or empty a new array will be created. If the metadata is present and a flat value then the return value is 1. Also using -k the input is been taken directly rather then being serialized. Required arguments: -f file Specifies the phar file to work on. -m meta Meta data to store with entry (serialized php data). Optional arguments: -e entry Name of entry to work on (must include PHAR internal directory name if any). -k index Subscription index to work on. pack command Pack files into a PHAR archive. When using -s <stub>, then the stub file is being excluded from the list of input files/dirs.To create an archive that contains PEAR class PHP_Archive then point -p argument to PHP/Archive.php. Required arguments: -f file Specifies the phar file to work on. ... Any number of input files and directories. If -i is in use then ONLY files and matching the given regular expression are being packed. If -x is given then files matching that regular expression are NOT being packed. Optional arguments: -a alias Provide an alias name for the phar file. -b bang Hash-bang line to start the archive (e.g. #!/usr/bin/php). The hash mark itself '#!' and the newline character are optional. -c algo Compression algorithm (see COMPRESSION ) -h hash Selects the hash algorithm (see HASH ) -i regex Specifies a regular expression for input files. -l level Number of preceding subdirectories to strip from file entries -p loader Location of PHP_Archive class file (pear list-files PHP_Archive).You can use '0' or '1' to locate it automatically using the mentioned pear command. When using '0' the command does not error out when the class file cannot be located. This switch also adds some code around the stub so that class PHP_Archive gets registered as phar:// stream wrapper if necessary. And finally this switch will add the file phar.inc from this package and load it to ensure class Phar is present. -s stub Select the stub file. -x regex Regular expression for input files to exclude. -y key Private key for OpenSSL signing. sign command Set signature hash algorithm. Required arguments: -f file Specifies the phar file to work on. -h hash Selects the hash algorithm (see HASH ) Optional arguments: -y key Private key for OpenSSL signing. stub-get command Get the stub of a PHAR file. If no output file is specified as stub then stdout is being used. Required arguments: -f file Specifies the phar file to work on. Optional arguments: -s stub Select the stub file. stub-set command Set the stub of a PHAR file. If no input file is specified as stub then stdin is being used. Required arguments: -f file Specifies the phar file to work on. Optional arguments: -b bang Hash-bang line to start the archive (e.g. #!/usr/bin/php). The hash mark itself '#!' and the newline character are optional. -p loader Location of PHP_Archive class file (pear list-files PHP_Archive).You can use '0' or '1' to locate it automatically using the mentioned pear command. When using '0' the command does not error out when the class file cannot be located. This switch also adds some code around the stub so that class PHP_Archive gets registered as phar:// stream wrapper if necessary. And finally this switch will add the file phar.inc from this package and load it to ensure class Phar is present. -s stub Select the stub file. tree command Get a directory tree for a PHAR archive. Required arguments: -f file Specifies the phar file to work on. Optional arguments: -i regex Specifies a regular expression for input files. -x regex Regular expression for input files to exclude. version command Get information about the PHAR environment and the tool version. COMPRESSION Algorithms: 0 No compression none No compression auto Automatically select compression algorithm gz GZip compression gzip GZip compression bz2 BZip2 compression bzip2 BZip2 compression HASH Algorithms: md5 MD5 sha1 SHA1 sha256 SHA256 sha512 SHA512 openssl OpenSSL using SHA-1 openssl_sha256 OpenSSL using SHA-256 openssl_sha512 OpenSSL using SHA-512 SEE ALSO For a more or less complete description of PHAR look here: http://php.net/phar BUGS You can view the list of known bugs or report any new bug you found at: https://github.com/php/php-src/issues AUTHORS The PHP Group: Thies C. Arntzen, Stig Bakken, Andi Gutmans, Rasmus Lerdorf, Sam Ruby, Sascha Schumann, Zeev Suraski, Jim Winstead, Andrei Zmievski. Work for the PHP archive was done by Gregory Beaver, Marcus Boerger. A List of active developers can be found here: http://www.php.net/credits.php And last but not least PHP was developed with the help of a huge amount of contributors all around the world. VERSION INFORMATION This manpage describes phar, version 8.3.9. COPYRIGHT Copyright Β© The PHP Group This source file is subject to version 3.01 of the PHP license, that is bundled with this package in the file LICENSE, and is available through the world-wide-web at the following url: https://www.php.net/license/3_01.txt If you did not receive a copy of the PHP license and are unable to obtain it through the world-wide-web, please send a note to license@php.net so we can mail you a copy immediately. The PHP Group 2024 PHAR(1)
|
phar, phar.phar - PHAR (PHP archive) command line tool
|
phar <command> [options] ...
| null | null |
env_parallel.dash
| null | null | null | null | null |
mysql_keyring_encryption_test
| null | null | null | null | null |
prove
| null |
prove - Run tests through a TAP harness. USAGE prove [options] [files or directories]
| null |
Boolean options: -v, --verbose Print all test lines. -l, --lib Add 'lib' to the path for your tests (-Ilib). -b, --blib Add 'blib/lib' and 'blib/arch' to the path for your tests -s, --shuffle Run the tests in random order. -c, --color Colored test output (default). --nocolor Do not color test output. --count Show the X/Y test count when not verbose (default) --nocount Disable the X/Y test count. -D --dry Dry run. Show test that would have run. -f, --failures Show failed tests. -o, --comments Show comments. --ignore-exit Ignore exit status from test scripts. -m, --merge Merge test scripts' STDERR with their STDOUT. -r, --recurse Recursively descend into directories. --reverse Run the tests in reverse order. -q, --quiet Suppress some test output while running tests. -Q, --QUIET Only print summary results. -p, --parse Show full list of TAP parse errors, if any. --directives Only show results with TODO or SKIP directives. --timer Print elapsed time after each test. --trap Trap Ctrl-C and print summary on interrupt. --normalize Normalize TAP output in verbose output -T Enable tainting checks. -t Enable tainting warnings. -W Enable fatal warnings. -w Enable warnings. -h, --help Display this help -?, Display this help -V, --version Display the version -H, --man Longer manpage for prove --norc Don't process default .proverc Options that take arguments: -I Library paths to include. -P Load plugin (searches App::Prove::Plugin::*.) -M Load a module. -e, --exec Interpreter to run the tests ('' for compiled tests.) --ext Set the extension for tests (default '.t') --harness Define test harness to use. See TAP::Harness. --formatter Result formatter to use. See FORMATTERS. --source Load and/or configure a SourceHandler. See SOURCE HANDLERS. -a, --archive out.tgz Store the resulting TAP in an archive file. -j, --jobs N Run N test jobs in parallel (try 9.) --state=opts Control prove's persistent state. --statefile=file Use `file` instead of `.prove` for state --rc=rcfile Process options from rcfile --rules Rules for parallel vs sequential processing. NOTES .proverc If ~/.proverc or ./.proverc exist they will be read and any options they contain processed before the command line options. Options in .proverc are specified in the same way as command line options: # .proverc --state=hot,fast,save -j9 Additional option files may be specified with the "--rc" option. Default option file processing is disabled by the "--norc" option. Under Windows and VMS the option file is named _proverc rather than .proverc and is sought only in the current directory. Reading from "STDIN" If you have a list of tests (or URLs, or anything else you want to test) in a file, you can add them to your tests by using a '-': prove - < my_list_of_things_to_test.txt See the "README" in the "examples" directory of this distribution. Default Test Directory If no files or directories are supplied, "prove" looks for all files matching the pattern "t/*.t". Colored Test Output Colored test output using TAP::Formatter::Color is the default, but if output is not to a terminal, color is disabled. You can override this by adding the "--color" switch. Color support requires Term::ANSIColor and, on windows platforms, also Win32::Console::ANSI. If the necessary module(s) are not installed colored output will not be available. Exit Code If the tests fail "prove" will exit with non-zero status. Arguments to Tests It is possible to supply arguments to tests. To do so separate them from prove's own arguments with the arisdottle, '::'. For example prove -v t/mytest.t :: --url http://example.com would run t/mytest.t with the options '--url http://example.com'. When running multiple tests they will each receive the same arguments. "--exec" Normally you can just pass a list of Perl tests and the harness will know how to execute them. However, if your tests are not written in Perl or if you want all tests invoked exactly the same way, use the "-e", or "--exec" switch: prove --exec '/usr/bin/ruby -w' t/ prove --exec '/usr/bin/perl -Tw -mstrict -Ilib' t/ prove --exec '/path/to/my/customer/exec' "--merge" If you need to make sure your diagnostics are displayed in the correct order relative to test results you can use the "--merge" option to merge the test scripts' STDERR into their STDOUT. This guarantees that STDOUT (where the test results appear) and STDERR (where the diagnostics appear) will stay in sync. The harness will display any diagnostics your tests emit on STDERR. Caveat: this is a bit of a kludge. In particular note that if anything that appears on STDERR looks like a test result the test harness will get confused. Use this option only if you understand the consequences and can live with the risk. "--trap" The "--trap" option will attempt to trap SIGINT (Ctrl-C) during a test run and display the test summary even if the run is interrupted "--state" You can ask "prove" to remember the state of previous test runs and select and/or order the tests to be run based on that saved state. The "--state" switch requires an argument which must be a comma separated list of one or more of the following options. "last" Run the same tests as the last time the state was saved. This makes it possible, for example, to recreate the ordering of a shuffled test. # Run all tests in random order $ prove -b --state=save --shuffle # Run them again in the same order $ prove -b --state=last "failed" Run only the tests that failed on the last run. # Run all tests $ prove -b --state=save # Run failures $ prove -b --state=failed If you also specify the "save" option newly passing tests will be excluded from subsequent runs. # Repeat until no more failures $ prove -b --state=failed,save "passed" Run only the passed tests from last time. Useful to make sure that no new problems have been introduced. "all" Run all tests in normal order. Multiple options may be specified, so to run all tests with the failures from last time first: $ prove -b --state=failed,all,save "hot" Run the tests that most recently failed first. The last failure time of each test is stored. The "hot" option causes tests to be run in most-recent- failure order. $ prove -b --state=hot,save Tests that have never failed will not be selected. To run all tests with the most recently failed first use $ prove -b --state=hot,all,save This combination of options may also be specified thus $ prove -b --state=adrian "todo" Run any tests with todos. "slow" Run the tests in slowest to fastest order. This is useful in conjunction with the "-j" parallel testing switch to ensure that your slowest tests start running first. $ prove -b --state=slow -j9 "fast" Run test tests in fastest to slowest order. "new" Run the tests in newest to oldest order based on the modification times of the test scripts. "old" Run the tests in oldest to newest order. "fresh" Run those test scripts that have been modified since the last test run. "save" Save the state on exit. The state is stored in a file called .prove (_prove on Windows and VMS) in the current directory. The "--state" switch may be used more than once. $ prove -b --state=hot --state=all,save --rules The "--rules" option is used to control which tests are run sequentially and which are run in parallel, if the "--jobs" option is specified. The option may be specified multiple times, and the order matters. The most practical use is likely to specify that some tests are not "parallel-ready". Since mentioning a file with --rules doesn't cause it to be selected to run as a test, you can "set and forget" some rules preferences in your .proverc file. Then you'll be able to take maximum advantage of the performance benefits of parallel testing, while some exceptions are still run in parallel. --rules examples # All tests are allowed to run in parallel, except those starting with "p" --rules='seq=t/p*.t' --rules='par=**' # All tests must run in sequence except those starting with "p", which should be run parallel --rules='par=t/p*.t' --rules resolution β’ By default, all tests are eligible to be run in parallel. Specifying any of your own rules removes this one. β’ "First match wins". The first rule that matches a test will be the one that applies. β’ Any test which does not match a rule will be run in sequence at the end of the run. β’ The existence of a rule does not imply selecting a test. You must still specify the tests to run. β’ Specifying a rule to allow tests to run in parallel does not make them run in parallel. You still need specify the number of parallel "jobs" in your Harness object. --rules Glob-style pattern matching We implement our own glob-style pattern matching for --rules. Here are the supported patterns: ** is any number of characters, including /, within a pathname * is zero or more characters within a filename/directory name ? is exactly one character within a filename/directory name {foo,bar,baz} is any of foo, bar or baz. \ is an escape character More advanced specifications for parallel vs sequence run rules If you need more advanced management of what runs in parallel vs in sequence, see the associated 'rules' documentation in TAP::Harness and TAP::Parser::Scheduler. If what's possible directly through "prove" is not sufficient, you can write your own harness to access these features directly. @INC prove introduces a separation between "options passed to the perl which runs prove" and "options passed to the perl which runs tests"; this distinction is by design. Thus the perl which is running a test starts with the default @INC. Additional library directories can be added via the "PERL5LIB" environment variable, via -Ifoo in "PERL5OPT" or via the "-Ilib" option to prove. Taint Mode Normally when a Perl program is run in taint mode the contents of the "PERL5LIB" environment variable do not appear in @INC. Because "PERL5LIB" is often used during testing to add build directories to @INC prove passes the names of any directories found in "PERL5LIB" as -I switches. The net effect of this is that "PERL5LIB" is honoured even when prove is run in taint mode. FORMATTERS You can load a custom TAP::Parser::Formatter: prove --formatter MyFormatter SOURCE HANDLERS You can load custom TAP::Parser::SourceHandlers, to change the way the parser interprets particular sources of TAP. prove --source MyHandler --source YetAnother t If you want to provide config to the source you can use: prove --source MyCustom \ --source Perl --perl-option 'foo=bar baz' --perl-option avg=0.278 \ --source File --file-option extensions=.txt --file-option extensions=.tmp t --source pgTAP --pgtap-option pset=format=html --pgtap-option pset=border=2 Each "--$source-option" option must specify a key/value pair separated by an "=". If an option can take multiple values, just specify it multiple times, as with the "extensions=" examples above. If the option should be a hash reference, specify the value as a second pair separated by a "=", as in the "pset=" examples above (escape "=" with a backslash). All "--sources" are combined into a hash, and passed to "new" in TAP::Harness's "sources" parameter. See TAP::Parser::IteratorFactory for more details on how configuration is passed to SourceHandlers. PLUGINS Plugins can be loaded using the "-Pplugin" syntax, eg: prove -PMyPlugin This will search for a module named "App::Prove::Plugin::MyPlugin", or failing that, "MyPlugin". If the plugin can't be found, "prove" will complain & exit. You can pass arguments to your plugin by appending "=arg1,arg2,etc" to the plugin name: prove -PMyPlugin=fou,du,fafa Please check individual plugin documentation for more details. Available Plugins For an up-to-date list of plugins available, please check CPAN: <http://search.cpan.org/search?query=App%3A%3AProve+Plugin> Writing Plugins Please see "PLUGINS" in App::Prove. perl v5.38.2 2023-11-28 PROVE(1)
| null |
gpgsplit
| null | null | null | null | null |
tac
|
Write each FILE to standard output, last line first. With no FILE, or when FILE is -, read standard input. Mandatory arguments to long options are mandatory for short options too. -b, --before attach the separator before instead of after -r, --regex interpret the separator as a regular expression -s, --separator=STRING use STRING as the separator instead of newline --help display this help and exit --version output version information and exit AUTHOR Written by Jay Lepreau and David MacKenzie. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO cat(1), rev(1) Full documentation <https://www.gnu.org/software/coreutils/tac> or available locally via: info '(coreutils) tac invocation' GNU coreutils 9.3 April 2023 TAC(1)
|
tac - concatenate and print files in reverse
|
tac [OPTION]... [FILE]...
| null | null |
numfmt
|
Reformat NUMBER(s), or the numbers from standard input if none are specified. Mandatory arguments to long options are mandatory for short options too. --debug print warnings about invalid input -d, --delimiter=X use X instead of whitespace for field delimiter --field=FIELDS replace the numbers in these input fields (default=1); see FIELDS below --format=FORMAT use printf style floating-point FORMAT; see FORMAT below for details --from=UNIT auto-scale input numbers to UNITs; default is 'none'; see UNIT below --from-unit=N specify the input unit size (instead of the default 1) --grouping use locale-defined grouping of digits, e.g. 1,000,000 (which means it has no effect in the C/POSIX locale) --header[=N] print (without converting) the first N header lines; N defaults to 1 if not specified --invalid=MODE failure mode for invalid numbers: MODE can be: abort (default), fail, warn, ignore --padding=N pad the output to N characters; positive N will right-align; negative N will left-align; padding is ignored if the output is wider than N; the default is to automatically pad if a whitespace is found --round=METHOD use METHOD for rounding when scaling; METHOD can be: up, down, from-zero (default), towards-zero, nearest --suffix=SUFFIX add SUFFIX to output numbers, and accept optional SUFFIX in input numbers --to=UNIT auto-scale output numbers to UNITs; see UNIT below --to-unit=N the output unit size (instead of the default 1) -z, --zero-terminated line delimiter is NUL, not newline --help display this help and exit --version output version information and exit UNIT options: none no auto-scaling is done; suffixes will trigger an error auto accept optional single/two letter suffix: 1K = 1000, 1Ki = 1024, 1M = 1000000, 1Mi = 1048576, si accept optional single letter suffix: 1K = 1000, 1M = 1000000, ... iec accept optional single letter suffix: 1K = 1024, 1M = 1048576, ... iec-i accept optional two-letter suffix: 1Ki = 1024, 1Mi = 1048576, ... FIELDS supports cut(1) style field ranges: N N'th field, counted from 1 N- from N'th field, to end of line N-M from N'th to M'th field (inclusive) -M from first to M'th field (inclusive) - all fields Multiple fields/ranges can be separated with commas FORMAT must be suitable for printing one floating-point argument '%f'. Optional quote (%'f) will enable --grouping (if supported by current locale). Optional width value (%10f) will pad output. Optional zero (%010f) width will zero pad the number. Optional negative values (%-10f) will left align. Optional precision (%.1f) will override the input determined precision. Exit status is 0 if all input numbers were successfully converted. By default, numfmt will stop at the first conversion error with exit status 2. With --invalid='fail' a warning is printed for each conversion error and the exit status is 2. With --invalid='warn' each conversion error is diagnosed, but the exit status is 0. With --invalid='ignore' conversion errors are not diagnosed and the exit status is 0.
|
numfmt - Convert numbers from/to human-readable strings
|
numfmt [OPTION]... [NUMBER]...
| null |
$ numfmt --to=si 1000 -> "1.0K" $ numfmt --to=iec 2048 -> "2.0K" $ numfmt --to=iec-i 4096 -> "4.0Ki" $ echo 1K | numfmt --from=si -> "1000" $ echo 1K | numfmt --from=iec -> "1024" $ df -B1 | numfmt --header --field 2-4 --to=si $ ls -l | numfmt --header --field 5 --to=iec $ ls -lh | numfmt --header --field 5 --from=iec --padding=10 $ ls -lh | numfmt --header --field 5 --from=iec --format %10f AUTHOR Written by Assaf Gordon. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO Full documentation <https://www.gnu.org/software/coreutils/numfmt> or available locally via: info '(coreutils) numfmt invocation' GNU coreutils 9.3 April 2023 NUMFMT(1)
|
podchecker
|
podchecker will read the given input files looking for POD syntax errors in the POD documentation and will print any errors it find to STDERR. At the end, it will print a status message indicating the number of errors found. Directories are ignored, an appropriate warning message is printed. podchecker invokes the podchecker() function exported by Pod::Checker Please see "podchecker()" in Pod::Checker for more details. RETURN VALUE podchecker returns a 0 (zero) exit status if all specified POD files are ok. ERRORS podchecker returns the exit status 1 if at least one of the given POD files has syntax errors. The status 2 indicates that at least one of the specified files does not contain any POD commands. Status 1 overrides status 2. If you want unambiguous results, call podchecker with one single argument only. SEE ALSO Pod::Simple and Pod::Checker AUTHORS Please report bugs using <http://rt.cpan.org>. Brad Appleton <bradapp@enteract.com>, Marek Rouchal <marekr@cpan.org> Based on code for Pod::Text::pod2text(1) written by Tom Christiansen <tchrist@mox.perl.com> perl v5.38.2 2023-11-28 PODCHECKER(1)
|
podchecker - check the syntax of POD format documentation files
|
podchecker [-help] [-man] [-(no)warnings] [file ...] OPTIONS AND ARGUMENTS -help Print a brief help message and exit. -man Print the manual page and exit. -warnings -nowarnings Turn on/off printing of warnings. Repeating -warnings increases the warning level, i.e. more warnings are printed. Currently increasing to level two causes flagging of unescaped "<,>" characters. file The pathname of a POD file to syntax-check (defaults to standard input).
| null | null |
gid
|
Print user and group information for each specified USER, or (when USER omitted) for the current process. -a ignore, for compatibility with other versions -Z, --context print only the security context of the process -g, --group print only the effective group ID -G, --groups print all group IDs -n, --name print a name instead of a number, for -ugG -r, --real print the real ID instead of the effective ID, with -ugG -u, --user print only the effective user ID -z, --zero delimit entries with NUL characters, not whitespace; not permitted in default format --help display this help and exit --version output version information and exit Without any OPTION, print some useful set of identified information. AUTHOR Written by Arnold Robbins and David MacKenzie. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO Full documentation <https://www.gnu.org/software/coreutils/id> or available locally via: info '(coreutils) id invocation' GNU coreutils 9.3 April 2023 ID(1)
|
id - print real and effective user and group IDs
|
id [OPTION]... [USER]...
| null | null |
torchrun
| null | null | null | null | null |
texture_to_cube
| null | null | null | null | null |
gpinky
|
-l produce long format output for the specified USERs -b omit the user's home directory and shell in long format -h omit the user's project file in long format -p omit the user's plan file in long format -s do short format output, this is the default -f omit the line of column headings in short format -w omit the user's full name in short format -i omit the user's full name and remote host in short format -q omit the user's full name, remote host and idle time in short format --help display this help and exit --version output version information and exit A lightweight 'finger' program; print user information. The utmp file will be /var/run/utmpx. AUTHOR Written by Joseph Arceneaux, David MacKenzie, and Kaveh Ghazi. REPORTING BUGS GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Report any translation bugs to <https://translationproject.org/team/> COPYRIGHT Copyright Β© 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO Full documentation <https://www.gnu.org/software/coreutils/pinky> or available locally via: info '(coreutils) pinky invocation' GNU coreutils 9.3 April 2023 PINKY(1)
|
pinky - lightweight finger
|
pinky [OPTION]... [USER]...
| null | null |
dirmngr
|
Since version 2.1 of GnuPG, dirmngr takes care of accessing the OpenPGP keyservers. As with previous versions it is also used as a server for managing and downloading certificate revocation lists (CRLs) for X.509 certificates, downloading X.509 certificates, and providing access to OCSP providers. Dirmngr is invoked internally by gpg, gpgsm, or via the gpg-connect-agent tool. COMMANDS Commands are not distinguished from options except for the fact that only one command is allowed. --version Print the program version and licensing information. Note that you cannot abbreviate this command. --help, -h Print a usage message summarizing the most useful command-line options. Note that you cannot abbreviate this command. --dump-options Print a list of all available options and commands. Note that you cannot abbreviate this command. --server Run in server mode and wait for commands on the stdin. The default mode is to create a socket and listen for commands there. This is only used for testing. --daemon Run in background daemon mode and listen for commands on a socket. This is the way dirmngr is started on demand by the other GnuPG components. To force starting dirmngr it is in general best to use gpgconf --launch dirmngr. --supervised Run in the foreground, sending logs to stderr, and listening on file descriptor 3, which must already be bound to a listening socket. This option is deprecated and not supported on Windows. --list-crls List the contents of the CRL cache on stdout. This is probably only useful for debugging purposes. --load-crl file This command requires a filename as additional argument, and it will make Dirmngr try to import the CRL in file into it's cache. Note, that this is only possible if Dirmngr is able to retrieve the CA's certificate directly by its own means. In general it is better to use gpgsm's --call-dirmngr loadcrl filename command so that gpgsm can help dirmngr. --fetch-crl url This command requires an URL as additional argument, and it will make dirmngr try to retrieve and import the CRL from that url into it's cache. This is mainly useful for debugging purposes. The dirmngr-client provides the same feature for a running dirmngr. --shutdown This commands shuts down an running instance of Dirmngr. This command has currently no effect. --flush This command removes all CRLs from Dirmngr's cache. Client requests will thus trigger reading of fresh CRLs.
|
dirmngr - GnuPG's network access daemon
|
dirmngr [options] command [args]
|
Note that all long options with the exception of --options and --homedir may also be given in the configuration file after stripping off the two leading dashes. --options file Reads configuration from file instead of from the default per- user configuration file. The default configuration file is named βdirmngr.confβ and expected in the home directory. --homedir dir Set the name of the home directory to dir. This option is only effective when used on the command line. The default is the directory named β.gnupgβ directly below the home directory of the user unless the environment variable GNUPGHOME has been set in which case its value will be used. Many kinds of data are stored within this directory. -v --verbose Outputs additional information while running. You can increase the verbosity by giving several verbose commands to dirmngr, such as -vv. --log-file file Append all logging output to file. This is very helpful in seeing what the agent actually does. Use βsocket://β to log to socket. --compatibility-flags flags Set compatibility flags to work around certain problems or to emulate bugs. The flags are given as a comma separated list of flag names and are OR-ed together. The special flag "none" clears the list and allows one to start over with an empty list. To get a list of available flags the sole word "help" can be used. --faked-system-time epoch This option is only useful for testing; it sets the system time back or forth to epoch which is the number of seconds elapsed since the year 1970. Alternatively epoch may be given as a full ISO time string (e.g. "20070924T154812"). --debug-level level Select the debug level for investigating problems. level may be a numeric value or by a keyword: none No debugging at all. A value of less than 1 may be used instead of the keyword. basic Some basic debug messages. A value between 1 and 2 may be used instead of the keyword. advanced More verbose debug messages. A value between 3 and 5 may be used instead of the keyword. expert Even more detailed messages. A value between 6 and 8 may be used instead of the keyword. guru All of the debug messages you can get. A value greater than 8 may be used instead of the keyword. The creation of hash tracing files is only enabled if the keyword is used. How these messages are mapped to the actual debugging flags is not specified and may change with newer releases of this program. They are however carefully selected to best aid in debugging. --debug flags Set debug flags. All flags are or-ed and flags may be given in C syntax (e.g. 0x0042) or as a comma separated list of flag names. To get a list of all supported flags the single word "help" can be used. This option is only useful for debugging and the behavior may change at any time without notice. --debug-all Same as --debug=0xffffffff --tls-debug level Enable debugging of the TLS layer at level. The details of the debug level depend on the used TLS library and are not set in stone. --debug-wait n When running in server mode, wait n seconds before entering the actual processing loop and print the pid. This gives time to attach a debugger. --disable-check-own-socket On some platforms dirmngr is able to detect the removal of its socket file and shutdown itself. This option disable this self- test for debugging purposes. -s --sh -c --csh Format the info output in daemon mode for use with the standard Bourne shell respective the C-shell. The default is to guess it based on the environment variable SHELL which is in almost all cases sufficient. --force Enabling this option forces loading of expired CRLs; this is only useful for debugging. --use-tor --no-use-tor The option --use-tor switches Dirmngr and thus GnuPG into ``Tor mode'' to route all network access via Tor (an anonymity network). Certain other features are disabled in this mode. The effect of --use-tor cannot be overridden by any other command or even by reloading dirmngr. The use of --no-use-tor disables the use of Tor. The default is to use Tor if it is available on startup or after reloading dirmngr. The test on the availability of Tor is done by trying to connect to a SOCKS proxy at either port 9050 or 9150; if another type of proxy is listening on one of these ports, you should use --no-use-tor. --standard-resolver This option forces the use of the system's standard DNS resolver code. This is mainly used for debugging. Note that on Windows a standard resolver is not used and all DNS access will return the error ``Not Implemented'' if this option is used. Using this together with enabled Tor mode returns the error ``Not Enabled''. --recursive-resolver When possible use a recursive resolver instead of a stub resolver. --resolver-timeout n Set the timeout for the DNS resolver to N seconds. The default are 30 seconds. --connect-timeout n --connect-quick-timeout n Set the timeout for HTTP and generic TCP connection attempts to N seconds. The value set with the quick variant is used when the --quick option has been given to certain Assuan commands. The quick value is capped at the value of the regular connect timeout. The default values are 15 and 2 seconds. Note that the timeout values are for each connection attempt; the connection code will attempt to connect all addresses listed for a server. --listen-backlog n Set the size of the queue for pending connections. The default is 64. --allow-version-check Allow Dirmngr to connect to https://versions.gnupg.org to get the list of current software versions. If this option is enabled the list is retrieved in case the local copy does not exist or is older than 5 to 7 days. See the option --query-swdb of the command gpgconf for more details. Note, that regardless of this option a version check can always be triggered using this command: gpg-connect-agent --dirmngr 'loadswdb --force' /bye --keyserver name Use name as your keyserver. This is the server that gpg communicates with to receive keys, send keys, and search for keys. The format of the name is a URI: `scheme:[//]keyservername[:port]' The scheme is the type of keyserver: "hkp" for the HTTP (or compatible) keyservers or "ldap" for the LDAP keyservers. Note that your particular installation of GnuPG may have other keyserver types available as well. Keyserver schemes are case-insensitive. After the keyserver name, optional keyserver configuration options may be provided. These are the same as the --keyserver-options of gpg, but apply only to this particular keyserver. Some keyservers synchronize with each other, so there is not always a need to send keys to more than one server. Some keyservers use round robin DNS to give a different keyserver each time you use it. If exactly two keyservers are configured and only one is a Tor hidden service (.onion), Dirmngr selects the keyserver to use depending on whether Tor is locally running or not. The check for a running Tor is done for each new connection. If no keyserver is explicitly configured, dirmngr will use the built-in default of https://keyserver.ubuntu.com. To avoid the use of a default keyserver the value none can be used. Windows users with a keyserver running on their Active Directory may use the short form ldap:/// for name to access this directory. For accessing anonymous LDAP keyservers name is in general just a ldaps://ldap.example.com. A BaseDN parameter should never be specified. If authentication is required things are more complicated and two methods are available: The modern method (since version 2.2.28) is to use the very same syntax as used with the option --ldapserver. Please see over there for details; here is an example: keyserver ldap:ldap.example.com::uid=USERNAME,ou=GnuPG Users, dc=example,dc=com:PASSWORD::starttls The other method is to use a full URL for name; for example: keyserver ldaps://ldap.example.com/????bindname=uid=USERNAME %2Cou=GnuPG%20Users%2Cdc=example%2Cdc=com,password=PASSWORD Put this all on one line without any spaces and keep the '%2C' as given. Replace USERNAME, PASSWORD, and the 'dc' parts according to the instructions received from your LDAP administrator. Note that only simple authentication (i.e. cleartext passwords) is supported and thus using ldaps is strongly suggested (since 2.2.28 "ldaps" defaults to port 389 and uses STARTTLS). On Windows authentication via AD can be requested by adding gpgNtds=1 after the fourth question mark instead of the bindname and password parameter. --nameserver ipaddr In ``Tor mode'' Dirmngr uses a public resolver via Tor to resolve DNS names. If the default public resolver, which is 8.8.8.8, shall not be used a different one can be given using this option. Note that a numerical IP address must be given (IPv6 or IPv4) and that no error checking is done for ipaddr. --disable-ipv4 --disable-ipv6 Disable the use of all IPv4 or IPv6 addresses. --disable-ldap Entirely disables the use of LDAP. --disable-http Entirely disables the use of HTTP. --ignore-http-dp When looking for the location of a CRL, the to be tested certificate usually contains so called CRL Distribution Point (DP) entries which are URLs describing the way to access the CRL. The first found DP entry is used. With this option all entries using the HTTP scheme are ignored when looking for a suitable DP. --ignore-ldap-dp This is similar to --ignore-http-dp but ignores entries using the LDAP scheme. Both options may be combined resulting in ignoring DPs entirely. --ignore-ocsp-service-url Ignore all OCSP URLs contained in the certificate. The effect is to force the use of the default responder. --honor-http-proxy If the environment variable βhttp_proxyβ has been set, use its value to access HTTP servers. If on Windows the option is used but the environment variable is not set, the proxy settings are taken from the system. --http-proxy host[:port] Use host and port to access HTTP servers. The use of this option overrides the environment variable βhttp_proxyβ regardless whether --honor-http-proxy has been set. --ldap-proxy host[:port] Use host and port to connect to LDAP servers. If port is omitted, port 389 (standard LDAP port) is used. This overrides any specified host and port part in a LDAP URL and will also be used if host and port have been omitted from the URL. --only-ldap-proxy Never use anything else but the LDAP "proxy" as configured with --ldap-proxy. Usually dirmngr tries to use other configured LDAP server if the connection using the "proxy" failed. --ldapserverlist-file file Read the list of LDAP servers to consult for CRLs and X.509 certificates from file instead of the default per-user ldap server list file. The default value for file is βdirmngr_ldapservers.confβ. This server list file contains one LDAP server per line in the format hostname:port:username:password:base_dn:flags Lines starting with a β#β are comments. Note that as usual all strings entered are expected to be UTF-8 encoded. Obviously this will lead to problems if the password has originally been encoded as Latin-1. There is no other solution here than to put such a password in the binary encoding into the file (i.e. non-ascii characters won't show up readable). ([The gpgconf tool might be helpful for frontends as it enables editing this configuration file using percent-escaped strings.]) --ldapserver spec This is an alternative way to specify LDAP servers for CRL and X.509 certificate retrieval. If this option is used the servers configured in βdirmngr_ldapservers.confβ (or the file given by --ldapserverlist-file) are cleared. Note that βdirmngr_ldapservers.confβ is not read again by a reload signal. However, --ldapserver options are read again. spec is either a proper LDAP URL or a colon delimited list of the form hostname:port:username:password:base_dn:flags: with an optional prefix of ldap: (but without the two slashes which would turn this into a proper LDAP URL). flags is a list of one or more comma delimited keywords: plain The default: Do not use a TLS secured connection at all; the default port is 389. starttls Use STARTTLS to secure the connection; the default port is 389. ldaptls Tunnel LDAP through a TLS connection; the default port is 636. ntds On Windows authenticate the LDAP connection using the Active Directory with the current user. areconly On Windows use only the A or AAAA record when resolving the LDAP server name. Note that in an URL style specification the scheme ldaps:// refers to STARTTLS and _not_ to LDAP-over-TLS. --ldaptimeout secs Specify the number of seconds to wait for an LDAP query before timing out. The default are 15 seconds. 0 will never timeout. --add-servers This option makes dirmngr add any servers it discovers when validating certificates against CRLs to the internal list of servers to consult for certificates and CRLs. This option should in general not be used. This option might be useful when trying to validate a certificate that has a CRL distribution point that points to a server that is not already listed in the ldapserverlist. Dirmngr will always go to this server and try to download the CRL, but chances are high that the certificate used to sign the CRL is located on the same server. So if dirmngr doesn't add that new server to list, it will often not be able to verify the signature of the CRL unless the --add-servers option is used. Caveat emptor: Using this option may enable denial-of-service attacks and leak search requests to unknown third parties. This is because arbitrary servers are added to the internal list of LDAP servers which in turn is used for all unspecific LDAP queries as well as a fallback for queries which did not return a result. --allow-ocsp This option enables OCSP support if requested by the client. OCSP requests are rejected by default because they may violate the privacy of the user; for example it is possible to track the time when a user is reading a mail. --ocsp-responder url Use url as the default OCSP Responder if the certificate does not contain information about an assigned responder. Note, that --ocsp-signer must also be set to a valid certificate. --ocsp-signer fpr|file Use the certificate with the fingerprint fpr to check the responses of the default OCSP Responder. Alternatively a filename can be given in which case the response is expected to be signed by one of the certificates described in that file. Any argument which contains a slash, dot or tilde is considered a filename. Usual filename expansion takes place: A tilde at the start followed by a slash is replaced by the content of βHOMEβ, no slash at start describes a relative filename which will be searched at the home directory. To make sure that the file is searched in the home directory, either prepend the name with "./" or use a name which contains a dot. If a response has been signed by a certificate described by these fingerprints no further check upon the validity of this certificate is done. The format of the FILE is a list of SHA-1 fingerprint, one per line with optional colons between the bytes. Empty lines and lines prefix with a hash mark are ignored. --ocsp-max-clock-skew n The number of seconds a skew between the OCSP responder and them local clock is accepted. Default is 600 (10 minutes). --ocsp-max-period n Seconds a response is at maximum considered valid after the time given in the thisUpdate field. Default is 7776000 (90 days). --ocsp-current-period n The number of seconds an OCSP response is considered valid after the time given in the NEXT_UPDATE datum. Default is 10800 (3 hours). --max-replies n Do not return more that n items in one query. The default is 10. --ignore-cert-extension oid Add oid to the list of ignored certificate extensions. The oid is expected to be in dotted decimal form, like 2.5.29.3. This option may be used more than once. Critical flagged certificate extensions matching one of the OIDs in the list are treated as if they are actually handled and thus the certificate won't be rejected due to an unknown critical extension. Use this option with care because extensions are usually flagged as critical for a reason. --ignore-crl-extension oid Add oid to the list of ignored CRL extensions. The oid is expected to be in dotted decimal form. Critical flagged CRL extensions matching one of the OIDs in the list are treated as if they are actually handled and thus the certificate won't be rejected due to an unknown critical extension. Use this option with care because extensions are usually flagged as critical for a reason. --ignore-cert fpr|file Entirely ignore certificates with the fingerprint fpr. As an alternative to the fingerprint a filename can be given in which case all certificates described in that file are ignored. Any argument which contains a slash, dot or tilde is considered a filename. Usual filename expansion takes place: A tilde at the start followed by a slash is replaced by the content of βHOMEβ, no slash at start describes a relative filename which will be searched at the home directory. To make sure that the file is searched in the home directory, either prepend the name with "./" or use a name which contains a dot. The format of such a file is a list of SHA-1 fingerprint, one per line with optional colons between the bytes. Empty lines and lines prefixed with a hash mark are ignored. This option is useful as a quick workaround to exclude certain certificates from the system store. --hkp-cacert file Use the root certificates in file for verification of the TLS certificates used with hkps (keyserver access over TLS). If the file is in PEM format a suffix of .pem is expected for file. This option may be given multiple times to add more root certificates. Tilde expansion is supported. If no hkp-cacert directive is present, dirmngr will use the system CAs.
|
Here is an example on how to show dirmngr's internal table of OpenPGP keyserver addresses. The output is intended for debugging purposes and not part of a defined API. gpg-connect-agent --dirmngr 'keyserver --hosttable' /bye To inhibit the use of a particular host you have noticed in one of the keyserver pools, you may use gpg-connect-agent --dirmngr 'keyserver --dead pgpkeys.bnd.de' /bye The description of the keyserver command can be printed using gpg-connect-agent --dirmngr 'help keyserver' /bye FILES Dirmngr makes use of several directories when running in daemon mode: There are a few configuration files to control the operation of dirmngr. By default they may all be found in the current home directory (see: [option --homedir]). dirmngr.conf This is the standard configuration file read by dirmngr on startup. It may contain any valid long option; the leading two dashes may not be entered and the option may not be abbreviated. This file is also read after a SIGHUP however not all options will actually have an effect. This default name may be changed on the command line (see: [option --options]). You should backup this file. /etc/gnupg/trusted-certs This directory should be filled with certificates of Root CAs you are trusting in checking the CRLs and signing OCSP Responses. Usually these are the same certificates you use with the applications making use of dirmngr. It is expected that each of these certificate files contain exactly one DER encoded certificate in a file with the suffix β.crtβ or β.derβ. dirmngr reads those certificates on startup and when given a SIGHUP. Certificates which are not readable or do not make up a proper X.509 certificate are ignored; see the log file for details. Applications using dirmngr (e.g. gpgsm) can request these certificates to complete a trust chain in the same way as with the extra-certs directory (see below). Note that for OCSP responses the certificate specified using the option --ocsp-signer is always considered valid to sign OCSP requests. /etc/gnupg/extra-certs This directory may contain extra certificates which are preloaded into the internal cache on startup. Applications using dirmngr (e.g. gpgsm) can request cached certificates to complete a trust chain. This is convenient in cases you have a couple intermediate CA certificates or certificates usually used to sign OCSP responses. These certificates are first tried before going out to the net to look for them. These certificates must also be DER encoded and suffixed with β.crtβ or β.derβ. ~/.gnupg/crls.d This directory is used to store cached CRLs. The βcrls.dβ part will be created by dirmngr if it does not exists but you need to make sure that the upper directory exists. Several options control the use of trusted certificates for TLS and CRLs. Here is an Overview on the use and origin of those Root CA certificates: System These System root certificates are used by: FIXME The origin of the system provided certificates depends on the platform. On Windows all certificates from the Windows System Stores ROOT and CA are used. On other platforms the certificates are read from the first file found form this list: β/etc/ssl/ca-bundle.pemβ, β/etc/ssl/certs/ca-certificates.crtβ, β/etc/pki/tls/cert.pemβ, β/usr/local/share/certs/ca-root-nss.crtβ, β/etc/ssl/cert.pemβ. GnuPG The GnuPG specific certificates stored in the directory β/etc/gnupg/trusted-certsβ are only used to validate CRLs. OpenPGP keyserver For accessing the OpenPGP keyservers the only certificates used are those set with the configuration option hkp-cacert. OpenPGP keyserver pool This is usually only one certificate read from the file β/opt/homebrew/Cellar/gnupg/2.4.5/share/gnupg/gnupg/sks-keyservers.netCA.pemβ. If this certificate exists it is used to access the special keyservers hkps.pool.sks-keyservers.net (or βhkps://keys.gnupg.netβ). Please note that gpgsm accepts Root CA certificates for its own purposes only if they are listed in its file βtrustlist.txtβ. dirmngr does not make use of this list - except FIXME. NOTES To be able to see diagnostics it is often useful to put at least the following lines into the configuration file β~/gnupg/dirmngr.confβ: log-file ~/dirmngr.log verbose You may want to check the log file to see whether all desired root CA certificates are correctly loaded. To be able to perform OCSP requests you probably want to add the line: allow-ocsp To make sure that new options are read or that after the installation of a new GnuPG versions the right dirmngr version is running, you should kill an existing dirmngr so that a new instance is started as needed by the other components: gpgconf --kill dirmngr Direct interfaction with the dirmngr is possible by using the command gpg-connect-agent --dirmngr Enter HELP at the prompt to see a list of commands and enter HELP followed by a command name to get help on that command. SIGNALS A running dirmngr may be controlled by signals, i.e. using the kill command to send a signal to the process. Here is a list of supported signals: SIGHUP This signal flushes all internally cached CRLs as well as any cached certificates. Then the certificate cache is reinitialized as on startup. Options are re-read from the configuration file. Instead of sending this signal it is better to use gpgconf --reload dirmngr SIGTERM Shuts down the process but waits until all current requests are fulfilled. If the process has received 3 of these signals and requests are still pending, a shutdown is forced. You may also use gpgconf --kill dirmngr instead of this signal SIGINT Shuts down the process immediately. SIGUSR1 This prints some caching statistics to the log file. SEE ALSO gpgsm(1), dirmngr-client(1) The full documentation for this tool is maintained as a Texinfo manual. If GnuPG and the info program are properly installed at your site, the command info gnupg should give you access to the complete manual including a menu structure and an index. GnuPG 2.4.5 2024-03-04 DIRMNGR(8)
|
lz4
|
lz4 is an extremely fast lossless compression algorithm, based on byte-aligned LZ77 family of compression scheme. lz4 offers compression speeds > 500 MB/s per core, linearly scalable with multi-core CPUs. It features an extremely fast decoder, offering speed in multiple GB/s per core, typically reaching RAM speed limit on multi-core systems. The native file format is the .lz4 format. Difference between lz4 and gzip lz4 supports a command line syntax similar but not identical to gzip(1). Differences are : β’ lz4 compresses a single file by default (see -m for multiple files) β’ lz4 file1 file2 means : compress file1 into file2 β’ lz4 file.lz4 will default to decompression (use -z to force compression) β’ lz4 preserves original files (see --rm to erase source file on completion) β’ lz4 shows real-time notification statistics during compression or decompression of a single file (use -q to silence them) β’ When no destination is specified, result is sent on implicit output, which depends on stdout status. When stdout is Not the console, it becomes the implicit output. Otherwise, if stdout is the console, the implicit output is filename.lz4. β’ It is considered bad practice to rely on implicit output in scripts. because the scriptΒ΄s environment may change. Always use explicit output in scripts. -c ensures that output will be stdout. Conversely, providing a destination name, or using -m ensures that the output will be either the specified name, or filename.lz4 respectively. Default behaviors can be modified by opt-in commands, detailed below. β’ lz4 -m makes it possible to provide multiple input filenames, which will be compressed into files using suffix .lz4. Progress notifications become disabled by default (use -v to enable them). This mode has a behavior which more closely mimics gzip command line, with the main remaining difference being that source files are preserved by default. β’ Similarly, lz4 -m -d can decompress multiple *.lz4 files. β’ ItΒ΄s possible to opt-in to erase source files on successful compression or decompression, using --rm command. β’ Consequently, lz4 -m --rm behaves the same as gzip. Concatenation of .lz4 files It is possible to concatenate .lz4 files as is. lz4 will decompress such files as if they were a single .lz4 file. For example: lz4 file1 > foo.lz4 lz4 file2 >> foo.lz4 Then lz4cat foo.lz4 is equivalent to cat file1 file2.
|
lz4 - lz4, unlz4, lz4cat - Compress or decompress .lz4 files
|
lz4 [OPTIONS] [-|INPUT-FILE] OUTPUT-FILE unlz4 is equivalent to lz4 -d lz4cat is equivalent to lz4 -dcfm When writing scripts that need to decompress files, it is recommended to always use the name lz4 with appropriate arguments (lz4 -d or lz4 -dc) instead of the names unlz4 and lz4cat.
|
Short commands concatenation In some cases, some options can be expressed using short command -x or long command --long-word. Short commands can be concatenated together. For example, -d -c is equivalent to -dc. Long commands cannot be concatenated. They must be clearly separated by a space. Multiple commands When multiple contradictory commands are issued on a same command line, only the latest one will be applied. Operation mode -z --compress Compress. This is the default operation mode when no operation mode option is specified, no other operation mode is implied from the command name (for example, unlz4 implies --decompress), nor from the input file name (for example, a file extension .lz4 implies --decompress by default). -z can also be used to force compression of an already compressed .lz4 file. -d --decompress --uncompress Decompress. --decompress is also the default operation when the input filename has an .lz4 extension. -t --test Test the integrity of compressed .lz4 files. The decompressed data is discarded. No files are created nor removed. -b# Benchmark mode, using # compression level. --list List information about .lz4 files. note : current implementation is limited to single-frame .lz4 files. Operation modifiers -# Compression level, with # being any value from 1 to 12. Higher values trade compression speed for compression ratio. Values above 12 are considered the same as 12. Recommended values are 1 for fast compression (default), and 9 for high compression. Speed/compression trade-off will vary depending on data to compress. Decompression speed remains fast at all settings. --fast[=#] Switch to ultra-fast compression levels. The higher the value, the faster the compression speed, at the cost of some compression ratio. If =# is not present, it defaults to 1. This setting overrides compression level if one was set previously. Similarly, if a compression level is set after --fast, it overrides it. --best Set highest compression level. Same as -12. --favor-decSpeed Generate compressed data optimized for decompression speed. Compressed data will be larger as a consequence (typically by ~0.5%), while decompression speed will be improved by 5-20%, depending on use cases. This option only works in combination with very high compression levels (>=10). -D dictionaryName Compress, decompress or benchmark using dictionary dictionaryName. Compression and decompression must use the same dictionary to be compatible. Using a different dictionary during decompression will either abort due to decompression error, or generate a checksum error. -f --[no-]force This option has several effects: If the target file already exists, overwrite it without prompting. When used with --decompress and lz4 cannot recognize the type of the source file, copy the source file as is to standard output. This allows lz4cat --force to be used like cat (1) for files that have not been compressed with lz4. -c --stdout --to-stdout Force write to standard output, even if it is the console. -m --multiple Multiple input files. Compressed file names will be appended a .lz4 suffix. This mode also reduces notification level. Can also be used to list multiple files. lz4 -m has a behavior equivalent to gzip -k (it preserves source files by default). -r operate recursively on directories. This mode also sets -m (multiple input files). -B# Block size [4-7](default : 7) -B4= 64KB ; -B5= 256KB ; -B6= 1MB ; -B7= 4MB -BI Produce independent blocks (default) -BD Blocks depend on predecessors (improves compression ratio, more noticeable on small blocks) -BX Generate block checksums (default:disabled) --[no-]frame-crc Select frame checksum (default:enabled) --no-crc Disable both frame and block checksums --[no-]content-size Header includes original size (default:not present) Note : this option can only be activated when the original size can be determined, hence for a file. It wonΒ΄t work with unknown source size, such as stdin or pipe. --[no-]sparse Sparse mode support (default:enabled on file, disabled on stdout) -l Use Legacy format (typically for Linux Kernel compression) Note : -l is not compatible with -m (--multiple) nor -r Other options -v --verbose Verbose mode -q --quiet Suppress warnings and real-time statistics; specify twice to suppress errors too -h -H --help Display help/long help and exit -V --version Display Version number and exit -k --keep Preserve source files (default behavior) --rm Delete source files on successful compression or decompression -- Treat all subsequent arguments as files Benchmark mode -b# Benchmark file(s), using # compression level -e# Benchmark multiple compression levels, from b# to e# (included) -i# Minimum evaluation time in seconds [1-9] (default : 3) BUGS Report bugs at: https://github.com/lz4/lz4/issues AUTHOR Yann Collet lz4 v1.9.4 August 2022 LZ4(1)
| null |
mysqlimport
|
The mysqlimport client provides a command-line interface to the LOAD DATA SQL statement. Most options to mysqlimport correspond directly to clauses of LOAD DATA syntax. See Section 13.2.9, βLOAD DATA Statementβ. Invoke mysqlimport like this: mysqlimport [options] db_name textfile1 [textfile2 ...] For each text file named on the command line, mysqlimport strips any extension from the file name and uses the result to determine the name of the table into which to import the file's contents. For example, files named patient.txt, patient.text, and patient all would be imported into a table named patient. mysqlimport supports the following options, which can be specified on the command line or in the [mysqlimport] and [client] groups of an option file. For information about option files used by MySQL programs, see Section 4.2.2.2, βUsing Option Filesβ. β’ --help, -? ββββββββββββββββββββββ¬βββββββββ βCommand-Line Format β --help β ββββββββββββββββββββββ΄βββββββββ Display a help message and exit. β’ --bind-address=ip_address ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --bind-address=ip_address β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ On a computer having multiple network interfaces, use this option to select which interface to use for connecting to the MySQL server. β’ --character-sets-dir=dir_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --character-sets-dir=path β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βDefault Value β [none] β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ The directory where character sets are installed. See Section 10.15, βCharacter Set Configurationβ. β’ --columns=column_list, -c column_list ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --columns=column_list β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ This option takes a list of comma-separated column names as its value. The order of the column names indicates how to match data file columns with table columns. β’ --compress, -C ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --compress[={OFF|ON}] β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βDefault Value β OFF β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ Compress all information sent between the client and the server if possible. See Section 4.2.8, βConnection Compression Controlβ. This option is deprecated. Expect it to be removed in a future version of MySQL. See the section called βConfiguring Legacy Connection Compressionβ. β’ --compression-algorithms=value ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ βCommand-Line Format β --compression-algorithms=value β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βType β Set β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βDefault Value β uncompressed β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βValid Values β zlib zstd uncompressed β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ The permitted compression algorithms for connections to the server. The available algorithms are the same as for the protocol_compression_algorithms system variable. The default value is uncompressed. For more information, see Section 4.2.8, βConnection Compression Controlβ. β’ --debug[=debug_options], -# [debug_options] ββββββββββββββββββββββ¬ββββββββββββββββββββββββββ βCommand-Line Format β --debug[=debug_options] β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βDefault Value β d:t:o β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββ Write a debugging log. A typical debug_options string is d:t:o,file_name. The default is d:t:o. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. β’ --debug-check ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --debug-check β ββββββββββββββββββββββΌββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄ββββββββββββββββ Print some debugging information when the program exits. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. β’ --debug-info ββββββββββββββββββββββ¬βββββββββββββββ βCommand-Line Format β --debug-info β ββββββββββββββββββββββΌβββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄βββββββββββββββ Print debugging information and memory and CPU usage statistics when the program exits. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. β’ --default-character-set=charset_name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --default-character-set=charset_name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ Use charset_name as the default character set. See Section 10.15, βCharacter Set Configurationβ. β’ --default-auth=plugin ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --default-auth=plugin β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ A hint about which client-side authentication plugin to use. See Section 6.2.17, βPluggable Authenticationβ. β’ --defaults-extra-file=file_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββ βCommand-Line Format β --defaults-extra-file=file_name β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββ Read this option file after the global option file but (on Unix) before the user option file. If the file does not exist or is otherwise inaccessible, an error occurs. If file_name is not an absolute path name, it is interpreted relative to the current directory. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --defaults-file=file_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --defaults-file=file_name β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs. If file_name is not an absolute path name, it is interpreted relative to the current directory. Exception: Even with --defaults-file, client programs read .mylogin.cnf. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --defaults-group-suffix=str ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββ βCommand-Line Format β --defaults-group-suffix=str β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββ Read not only the usual option groups, but also groups with the usual names and a suffix of str. For example, mysqlimport normally reads the [client] and [mysqlimport] groups. If this option is given as --defaults-group-suffix=_other, mysqlimport also reads the [client_other] and [mysqlimport_other] groups. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --delete, -D ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --delete β ββββββββββββββββββββββ΄βββββββββββ Empty the table before importing the text file. β’ --enable-cleartext-plugin ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --enable-cleartext-plugin β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ Enable the mysql_clear_password cleartext authentication plugin. (See Section 6.4.1.4, βClient-Side Cleartext Pluggable Authenticationβ.) β’ --fields-terminated-by=..., --fields-enclosed-by=..., --fields-optionally-enclosed-by=..., --fields-escaped-by=... ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββ βCommand-Line Format β --fields-terminated-by=string β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββ ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββ βCommand-Line Format β --fields-enclosed-by=string β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββ ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --fields-optionally-enclosed-by=string β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ ββββββββββββββββββββββ¬ββββββββββββββββββββββ βCommand-Line Format β --fields-escaped-by β ββββββββββββββββββββββΌββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββ These options have the same meaning as the corresponding clauses for LOAD DATA. See Section 13.2.9, βLOAD DATA Statementβ. β’ --force, -f ββββββββββββββββββββββ¬ββββββββββ βCommand-Line Format β --force β ββββββββββββββββββββββ΄ββββββββββ Ignore errors. For example, if a table for a text file does not exist, continue processing any remaining files. Without --force, mysqlimport exits if a table does not exist. β’ --get-server-public-key ββββββββββββββββββββββ¬ββββββββββββββββββββββββββ βCommand-Line Format β --get-server-public-key β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββ Request from the server the public key required for RSA key pair-based password exchange. This option applies to clients that authenticate with the caching_sha2_password authentication plugin. For that plugin, the server does not send the public key unless requested. This option is ignored for accounts that do not authenticate with that plugin. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection. If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over --get-server-public-key. For information about the caching_sha2_password plugin, see Section 6.4.1.2, βCaching SHA-2 Pluggable Authenticationβ. β’ --host=host_name, -h host_name ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --host=host_name β ββββββββββββββββββββββΌβββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌβββββββββββββββββββ€ βDefault Value β localhost β ββββββββββββββββββββββ΄βββββββββββββββββββ Import data to the MySQL server on the given host. The default host is localhost. β’ --ignore, -i ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --ignore β ββββββββββββββββββββββ΄βββββββββββ See the description for the --replace option. β’ --ignore-lines=N ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --ignore-lines=# β ββββββββββββββββββββββΌβββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββ΄βββββββββββββββββββ Ignore the first N lines of the data file. β’ --lines-terminated-by=... ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββ βCommand-Line Format β --lines-terminated-by=string β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββ This option has the same meaning as the corresponding clause for LOAD DATA. For example, to import Windows files that have lines terminated with carriage return/linefeed pairs, use --lines-terminated-by="\r\n". (You might have to double the backslashes, depending on the escaping conventions of your command interpreter.) See Section 13.2.9, βLOAD DATA Statementβ. β’ --local, -L ββββββββββββββββββββββ¬ββββββββββ βCommand-Line Format β --local β ββββββββββββββββββββββΌββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄ββββββββββ By default, files are read by the server on the server host. With this option, mysqlimport reads input files locally on the client host. Successful use of LOCAL load operations within mysqlimport also requires that the server permits local loading; see Section 6.1.6, βSecurity Considerations for LOAD DATA LOCALβ β’ --lock-tables, -l ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --lock-tables β ββββββββββββββββββββββ΄ββββββββββββββββ Lock all tables for writing before processing any text files. This ensures that all tables are synchronized on the server. β’ --login-path=name ββββββββββββββββββββββ¬ββββββββββββββββββββ βCommand-Line Format β --login-path=name β ββββββββββββββββββββββΌββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββ Read options from the named login path in the .mylogin.cnf login path file. A βlogin pathβ is an option group containing options that specify which MySQL server to connect to and which account to authenticate as. To create or modify a login path file, use the mysql_config_editor utility. See mysql_config_editor(1). For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --no-login-paths ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --no-login-paths β ββββββββββββββββββββββ΄βββββββββββββββββββ Skips reading options from the login path file. See --login-path for related information. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --low-priority ββββββββββββββββββββββ¬βββββββββββββββββ βCommand-Line Format β --low-priority β ββββββββββββββββββββββ΄βββββββββββββββββ Use LOW_PRIORITY when loading the table. This affects only storage engines that use only table-level locking (such as MyISAM, MEMORY, and MERGE). β’ --no-defaults ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --no-defaults β ββββββββββββββββββββββ΄ββββββββββββββββ Do not read any option files. If program startup fails due to reading unknown options from an option file, --no-defaults can be used to prevent them from being read. The exception is that the .mylogin.cnf file is read in all cases, if it exists. This permits passwords to be specified in a safer way than on the command line even when --no-defaults is used. To create .mylogin.cnf, use the mysql_config_editor utility. See mysql_config_editor(1). For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --password[=password], -p[password] ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --password[=password] β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ The password of the MySQL account used for connecting to the server. The password value is optional. If not given, mysqlimport prompts for one. If given, there must be no space between --password= or -p and the password following it. If no password option is specified, the default is to send no password. Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 6.1.2.1, βEnd-User Guidelines for Password Securityβ. To explicitly specify that there is no password and that mysqlimport should not prompt for one, use the --skip-password option. β’ --password1[=pass_val] The password for multifactor authentication factor 1 of the MySQL account used for connecting to the server. The password value is optional. If not given, mysqlimport prompts for one. If given, there must be no space between --password1= and the password following it. If no password option is specified, the default is to send no password. Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 6.1.2.1, βEnd-User Guidelines for Password Securityβ. To explicitly specify that there is no password and that mysqlimport should not prompt for one, use the --skip-password1 option. --password1 and --password are synonymous, as are --skip-password1 and --skip-password. β’ --password2[=pass_val] The password for multifactor authentication factor 2 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for --password1; see the description of that option for details. β’ --password3[=pass_val] The password for multifactor authentication factor 3 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for --password1; see the description of that option for details. β’ --pipe, -W ββββββββββββββββββββββ¬βββββββββ βCommand-Line Format β --pipe β ββββββββββββββββββββββΌβββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββ On Windows, connect to the server using a named pipe. This option applies only if the server was started with the named_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by the named_pipe_full_access_group system variable. β’ --plugin-dir=dir_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --plugin-dir=dir_name β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β Directory name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ The directory in which to look for plugins. Specify this option if the --default-auth option is used to specify an authentication plugin but mysqlimport does not find it. See Section 6.2.17, βPluggable Authenticationβ. β’ --port=port_num, -P port_num ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --port=port_num β ββββββββββββββββββββββΌββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌββββββββββββββββββ€ βDefault Value β 3306 β ββββββββββββββββββββββ΄ββββββββββββββββββ For TCP/IP connections, the port number to use. β’ --print-defaults ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --print-defaults β ββββββββββββββββββββββ΄βββββββββββββββββββ Print the program name and all options that it gets from option files. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --protocol={TCP|SOCKET|PIPE|MEMORY} ββββββββββββββββββββββ¬βββββββββββββββββββββββββ βCommand-Line Format β --protocol=type β ββββββββββββββββββββββΌβββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌβββββββββββββββββββββββββ€ βDefault Value β [see text] β ββββββββββββββββββββββΌβββββββββββββββββββββββββ€ βValid Values β TCP SOCKET PIPE β β β MEMORY β ββββββββββββββββββββββ΄βββββββββββββββββββββββββ The transport protocol to use for connecting to the server. It is useful when the other connection parameters normally result in use of a protocol other than the one you want. For details on the permissible values, see Section 4.2.7, βConnection Transport Protocolsβ. β’ --replace, -r ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --replace β ββββββββββββββββββββββ΄ββββββββββββ The --replace and --ignore options control handling of input rows that duplicate existing rows on unique key values. If you specify --replace, new rows replace existing rows that have the same unique key value. If you specify --ignore, input rows that duplicate an existing row on a unique key value are skipped. If you do not specify either option, an error occurs when a duplicate key value is found, and the rest of the text file is ignored. β’ --server-public-key-path=file_name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --server-public-key-path=file_name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββ The path name to a file in PEM format containing a client-side copy of the public key required by the server for RSA key pair-based password exchange. This option applies to clients that authenticate with the sha256_password or caching_sha2_password authentication plugin. This option is ignored for accounts that do not authenticate with one of those plugins. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection. If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over --get-server-public-key. For sha256_password, this option applies only if MySQL was built using OpenSSL. For information about the sha256_password and caching_sha2_password plugins, see Section 6.4.1.3, βSHA-256 Pluggable Authenticationβ, and Section 6.4.1.2, βCaching SHA-2 Pluggable Authenticationβ. β’ --shared-memory-base-name=name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ βCommand-Line Format β --shared-memory-base-name=name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βPlatform Specific β Windows β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ On Windows, the shared-memory name to use for connections made using shared memory to a local server. The default value is MYSQL. The shared-memory name is case-sensitive. This option applies only if the server was started with the shared_memory system variable enabled to support shared-memory connections. β’ --silent, -s ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --silent β ββββββββββββββββββββββ΄βββββββββββ Silent mode. Produce output only when errors occur. β’ --socket=path, -S path ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ βCommand-Line Format β --socket={file_name|pipe_name} β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ For connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use. On Windows, this option applies only if the server was started with the named_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by the named_pipe_full_access_group system variable. β’ --ssl* Options that begin with --ssl specify whether to connect to the server using encryption and indicate where to find SSL keys and certificates. See the section called βCommand Options for Encrypted Connectionsβ. β’ --ssl-fips-mode={OFF|ON|STRICT} ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββ βCommand-Line Format β --ssl-fips-mode={OFF|ON|STRICT} β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βType β Enumeration β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βDefault Value β OFF β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βValid Values β OFF ON STRICT β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββ Controls whether to enable FIPS mode on the client side. The --ssl-fips-mode option differs from other --ssl-xxx options in that it is not used to establish encrypted connections, but rather to affect which cryptographic operations to permit. See Section 6.8, βFIPS Supportβ. These --ssl-fips-mode values are permitted: β’ OFF: Disable FIPS mode. β’ ON: Enable FIPS mode. β’ STRICT: Enable βstrictβ FIPS mode. Note If the OpenSSL FIPS Object Module is not available, the only permitted value for --ssl-fips-mode is OFF. In this case, setting --ssl-fips-mode to ON or STRICT causes the client to produce a warning at startup and to operate in non-FIPS mode. This option is deprecated. Expect it to be removed in a future version of MySQL. β’ --tls-ciphersuites=ciphersuite_list ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --tls-ciphersuites=ciphersuite_list β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββ The permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a list of one or more colon-separated ciphersuite names. The ciphersuites that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, βEncrypted Connection TLS Protocols and Ciphersβ. β’ --tls-sni-servername=server_name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββ βCommand-Line Format β --tls-sni-servername=server_name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββ When specified, the name is passed to the libmysqlclient C API library using the MYSQL_OPT_TLS_SNI_SERVERNAME option of mysql_options(). The server name is not case-sensitive. To show which server name the client specified for the current session, if any, check the Tls_sni_server_name status variable. Server Name Indication (SNI) is an extension to the TLS protocol (OpenSSL must be compiled using TLS extensions for this option to function). The MySQL implementation of SNI represents the client-side only. β’ --tls-version=protocol_list ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββ βCommand-Line Format β --tls-version=protocol_list β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββ€ βDefault Value β TLSv1,TLSv1.1,TLSv1.2,TLSv1.3 β β β (OpenSSL 1.1.1 or higher) β β β TLSv1,TLSv1.1,TLSv1.2 β β β (otherwise) β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββ The permissible TLS protocols for encrypted connections. The value is a list of one or more comma-separated protocol names. The protocols that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, βEncrypted Connection TLS Protocols and Ciphersβ. β’ --user=user_name, -u user_name ββββββββββββββββββββββ¬ββββββββββββββββββββ βCommand-Line Format β --user=user_name, β ββββββββββββββββββββββΌββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββ The user name of the MySQL account to use for connecting to the server. β’ --use-threads=N ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --use-threads=# β ββββββββββββββββββββββΌββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββ΄ββββββββββββββββββ Load files in parallel using N threads. β’ --verbose, -v ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --verbose β ββββββββββββββββββββββ΄ββββββββββββ Verbose mode. Print more information about what the program does. β’ --version, -V ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --version β ββββββββββββββββββββββ΄ββββββββββββ Display version information and exit. β’ --zstd-compression-level=level ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββ βCommand-Line Format β --zstd-compression-level=# β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βType β Integer β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββ The compression level to use for connections to the server that use the zstd compression algorithm. The permitted levels are from 1 to 22, with larger values indicating increasing levels of compression. The default zstd compression level is 3. The compression level setting has no effect on connections that do not use zstd compression. For more information, see Section 4.2.8, βConnection Compression Controlβ. Here is a sample session that demonstrates use of mysqlimport: $> mysql -e 'CREATE TABLE imptest(id INT, n VARCHAR(30))' test $> ed a 100 Max Sydow 101 Count Dracula . w imptest.txt 32 q $> od -c imptest.txt 0000000 1 0 0 \t M a x S y d o w \n 1 0 0000020 1 \t C o u n t D r a c u l a \n 0000040 $> mysqlimport --local test imptest.txt test.imptest: Records: 2 Deleted: 0 Skipped: 0 Warnings: 0 $> mysql -e 'SELECT * FROM imptest' test +------+---------------+ | id | n | +------+---------------+ | 100 | Max Sydow | | 101 | Count Dracula | +------+---------------+ COPYRIGHT Copyright Β© 1997, 2023, Oracle and/or its affiliates. This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/. SEE ALSO For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/. AUTHOR Oracle Corporation (http://dev.mysql.com/). MySQL 8.3 11/23/2023 MYSQLIMPORT(1)
|
mysqlimport - a data import program
|
mysqlimport [options] db_name textfile1 ...
| null | null |
rtmpgw
|
rtmpgw is a server for streaming media content from RTMP out to HTTP. rtmpgw listens for HTTP requests that specify RTMP stream parameters and then returns the RTMP data in the HTTP response. The only valid HTTP request is "GET /" but additional options can be provided in URL- encoded fashion. Options specified on the command line will be used as defaults, which can be overridden by options in the HTTP request.
|
rtmpgw - RTMP streaming media gateway
|
rtmpgw [-r_url] [-n_hostname] [-c_port] [-l_protocol] [-S_host:port] [-a_app] [-t_tcUrl] [-p_pageUrl] [-s_swfUrl] [-f_flashVer] [-u_auth] [-C_conndata] [-y_playpath] [-v] [-d_subscription] [-e] [-k_skip] [-A_start] [-B_stop] [-b_buffer] [-m_timeout] [-T_key] [-j_JSON] [-w_swfHash] [-x_swfSize] [-W_swfUrl] [-X_swfAge] [-D_address] [-g_port] [-q] [-V] [-z] rtmpgw -h
|
Network Parameters These options define how to connect to the media server. --rtmp -r url URL of the server and media content. --host -n hostname Overrides the hostname in the RTMP URL. --port -c port Overrides the port number in the RTMP URL. --protocol -l number Overrides the protocol in the RTMP URL. 0 = rtmp 1 = rtmpt 2 = rtmpe 3 = rtmpte 4 = rtmps 5 = rtmpts --socks -S host:port Use the specified SOCKS4 proxy. Connection Parameters These options define the content of the RTMP Connect request packet. If correct values are not provided, the media server will reject the connection attempt. --app -a app Name of application to connect to on the RTMP server. Overrides the app in the RTMP URL. Sometimes the rtmpdump URL parser cannot determine the app name automatically, so it must be given explicitly using this option. --tcUrl -t url URL of the target stream. Defaults to rtmp[e]://host[:port]/app/playpath. --pageUrl -p url URL of the web page in which the media was embedded. By default no value will be sent. --swfUrl -s url URL of the SWF player for the media. By default no value will be sent. --flashVer -f version Version of the Flash plugin used to run the SWF player. The default is "LNX 10,0,32,18". --auth -u string An authentication string to be appended to the Connect message. Using this option will append a Boolean TRUE and then the specified string. This option is only used by some particular servers and is deprecated. The more general --conn option should be used instead. --conn -C type:data Append arbitrary AMF data to the Connect message. The type must be B for Boolean, N for number, S for string, O for object, or Z for null. For Booleans the data must be either 0 or 1 for FALSE or TRUE, respectively. Likewise for Objects the data must be 0 or 1 to end or begin an object, respectively. Data items in subobjects may be named, by prefixing the type with 'N' and specifying the name before the value, e.g. NB:myFlag:1. This option may be used multiple times to construct arbitrary AMF sequences. E.g. -C B:1 -C S:authMe -C O:1 -C NN:code:1.23 -C NS:flag:ok -C O:0 Session Parameters These options take effect after the Connect request has succeeded. --playpath -y path Overrides the playpath parsed from the RTMP URL. Sometimes the rtmpdump URL parser cannot determine the correct playpath automatically, so it must be given explicitly using this option. --live -v Specify that the media is a live stream. No resuming or seeking in live streams is possible. --subscribe -d stream Name of live stream to subscribe to. Defaults to playpath. --start -A num Start at num seconds into the stream. Not valid for live streams. --stop -B num Stop at num seconds into the stream. --buffer -b num Set buffer time to num milliseconds. The default is 20000. --timeout -m num Timeout the session after num seconds without receiving any data from the server. The default is 120. Security Parameters These options handle additional authentication requests from the server. --token -T key Key for SecureToken response, used if the server requires SecureToken authentication. --jtv -j JSON JSON token used by legacy Justin.tv servers. Invokes NetStream.Authenticate.UsherToken --swfhash -w hexstring SHA256 hash of the decompressed SWF file. This option may be needed if the server uses SWF Verification, but see the --swfVfy option below. The hash is 32 bytes, and must be given in hexadecimal. The --swfsize option must always be used with this option. --swfsize -x num Size of the decompressed SWF file. This option may be needed if the server uses SWF Verification, but see the --swfVfy option below. The --swfhash option must always be used with this option. --swfVfy -W url URL of the SWF player for this media. This option replaces all three of the --swfUrl, --swfhash, and --swfsize options. When this option is used, the SWF player is retrieved from the specified URL and the hash and size are computed automatically. Also the information is cached in a .swfinfo file in the user's home directory, so that it doesn't need to be retrieved and recalculated every time rtmpdump is run. The .swfinfo file records the URL, the time it was fetched, the modification timestamp of the SWF file, its size, and its hash. By default, the cached info will be used for 30 days before re-checking. --swfAge -X days Specify how many days to use the cached SWF info before re- checking. Use 0 to always check the SWF URL. Note that if the check shows that the SWF file has the same modification timestamp as before, it will not be retrieved again. Miscellaneous --device -D address Listener IP address. The default is 0.0.0.0, i.e., any IP address. --sport -g port Listener port. The default is 80. --quiet -q Suppress all command output. --verbose -V Verbose command output. --debug -z Debug level output. Extremely verbose, including hex dumps of all packet data. --help -h Print a summary of command options.
|
The HTTP request GET /?r=rtmp:%2f%2fserver%2fmyapp&y=somefile HTTP/1.0 is equivalent to the rtrmpdump(1) invocation rtmpdump -r rtmp://server/myapp -y somefile Note that only the shortform (single letter) options are supported. ENVIRONMENT HOME The value of $HOME is used as the location for the .swfinfo file. FILES $HOME/.swfinfo Cache of SWF Verification information SEE ALSO rtmpdump(1) AUTHORS Andrej Stepanchuk, Howard Chu, The Flvstreamer Team <http://rtmpdump.mplayerhq.hu> RTMPDump v2.4 2011-07-20 RTMPGW(8)
|
fonttools
| null | null | null | null | null |
pngtogd2
| null | null | null | null | null |
converttopdf
| null | null | null | null | null |
code
|
Creates a scoped value for the specified command and its associated arg arguments. A scoped value is a list with three elements: the "@scope" keyword, a namespace context, and a value string. For example, the command namespace foo { code puts "Hello World!" } produces the scoped value: @scope ::foo {puts {Hello World!}} Note that the code command captures the current namespace context. If the -namespace flag is specified, then the current context is ignored, and the name string is used as the namespace context. Extensions like Tk execute ordinary code fragments in the global namespace. A scoped value captures a code fragment together with its namespace context in a way that allows it to be executed properly later. It is needed, for example, to wrap up code fragments when a Tk widget is used within a namespace: namespace foo { private proc report {mesg} { puts "click: $mesg" } button .b1 -text "Push Me" -command [code report "Hello World!"] pack .b1 } The code fragment associated with button .b1 only makes sense in the context of namespace "foo". Furthermore, the "report" procedure is private, and can only be accessed within that namespace. The code command wraps up the code fragment in a way that allows it to be executed properly when the button is pressed. Also, note that the code command preserves the integrity of arguments on the command line. This makes it a natural replacement for the list command, which is often used to format Tcl code fragments. In other words, instead of using the list command like this: after 1000 [list puts "Hello $name!"] use the code command like this: after 1000 [code puts "Hello $name!"] This not only formats the command correctly, but also captures its namespace context. Scoped commands can be invoked like ordinary code fragments, with or without the eval command. For example, the following statements work properly: set cmd {@scope ::foo .b1} $cmd configure -background red set opts {-bg blue -fg white} eval $cmd configure $opts Note that scoped commands by-pass the usual protection mechanisms; the command: @scope ::foo {report {Hello World!}} can be used to access the "foo::report" proc from any namespace context, even though it is private. KEYWORDS scope, callback, namespace, public, protected, private itcl 3.0 code(n)
|
code - capture the namespace context for a code fragment
|
itcl::code ?-namespace name? command ?arg arg ...? ______________________________________________________________________________
| null | null |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.