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_server2
| null | null | null | null | null |
fc-conflist
| null | null | null | null | null |
gchgrp
|
Change the group of each FILE to GROUP. With --reference, change the group 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 --dereference affect the referent of each symbolic link (this is the default), rather than the symbolic link itself -h, --no-dereference affect symbolic links instead of any referenced file (useful only on systems that can change the ownership of a symlink) --no-preserve-root do not treat '/' specially (the default) --preserve-root fail to operate recursively on '/' --reference=RFILE use RFILE's group rather than specifying a GROUP. RFILE is always dereferenced if a symbolic link. -R, --recursive operate on files and directories recursively The following options modify how a hierarchy is traversed when the -R option is also specified. If more than one is specified, only the final one takes effect. -H if a command line argument is a symbolic link to a directory, traverse it -L traverse every symbolic link to a directory encountered -P do not traverse any symbolic links (default) --help display this help and exit --version output version information and exit
|
chgrp - change group ownership
|
chgrp [OPTION]... GROUP FILE... chgrp [OPTION]... --reference=RFILE FILE...
| null |
chgrp staff /u Change the group of /u to "staff". chgrp -hR staff /u Change the group of /u and subfiles to "staff". 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 chown(1), chown(2) Full documentation <https://www.gnu.org/software/coreutils/chgrp> or available locally via: info '(coreutils) chgrp invocation' GNU coreutils 9.3 April 2023 CHGRP(1)
|
gcat
|
Concatenate FILE(s) to standard output. With no FILE, or when FILE is -, read standard input. -A, --show-all equivalent to -vET -b, --number-nonblank number nonempty output lines, overrides -n -e equivalent to -vE -E, --show-ends display $ at end of each line -n, --number number all output lines -s, --squeeze-blank suppress repeated empty output lines -t equivalent to -vT -T, --show-tabs display TAB characters as ^I -u (ignored) -v, --show-nonprinting use ^ and M- notation, except for LFD and TAB --help display this help and exit --version output version information and exit
|
cat - concatenate files and print on the standard output
|
cat [OPTION]... [FILE]...
| null |
cat f - g Output f's contents, then standard input, then g's contents. cat Copy standard input to standard output. AUTHOR Written by Torbjorn Granlund and Richard M. Stallman. 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 tac(1) Full documentation <https://www.gnu.org/software/coreutils/cat> or available locally via: info '(coreutils) cat invocation' GNU coreutils 9.3 April 2023 CAT(1)
|
glib-mkenums
| null | null | null | null | null |
redis-benchmark
| null | null | null | null | null |
crypt_and_hash
| null | null | null | null | null |
xzmore
|
xzmore displays text from compressed files to a terminal using more(1). Files supported by xz(1) are decompressed; other files are assumed to be in uncompressed form already. If no files are given, xzmore reads from standard input. See the more(1) manual for the keyboard commands. Note that scrolling backwards might not be possible depending on the implementation of more(1). This is because xzmore uses a pipe to pass the decompressed data to more(1). xzless(1) uses less(1) which provides more advanced features. The command lzmore is provided for backward compatibility with LZMA Utils. ENVIRONMENT PAGER If PAGER is set, its value is used as the pager instead of more(1). SEE ALSO more(1), xz(1), xzless(1), zmore(1) Tukaani 2024-02-12 XZMORE(1)
|
xzmore, lzmore - view xz or lzma compressed (text) files
|
xzmore [file...] lzmore [file...]
| null | null |
pod2html
|
Converts files from pod format (see perlpod) to HTML format. ARGUMENTS pod2html takes the following arguments: backlink --backlink --nobacklink Turn =head1 directives into links pointing to the top of the HTML file. --nobacklink (which is the default behavior) does not create these backlinks. cachedir --cachedir=name Specify which directory is used for storing cache. Default directory is the current working directory. css --css=URL Specify the URL of cascading style sheet to link from resulting HTML file. Default is none style sheet. flush --flush Flush the cache. header --header --noheader Create header and footer blocks containing the text of the "NAME" section. --noheader -- which is the default behavior -- does not create header or footer blocks. help --help Displays the usage message. htmldir --htmldir=name Sets the directory to which all cross references in the resulting HTML file will be relative. Not passing this causes all links to be absolute since this is the value that tells Pod::Html the root of the documentation tree. Do not use this and --htmlroot in the same call to pod2html; they are mutually exclusive. htmlroot --htmlroot=URL Sets the base URL for the HTML files. When cross-references are made, the HTML root is prepended to the URL. Do not use this if relative links are desired: use --htmldir instead. Do not pass both this and --htmldir to pod2html; they are mutually exclusive. index --index Generate an index at the top of the HTML file (default behaviour). noindex --noindex Do not generate an index at the top of the HTML file. infile --infile=name Specify the pod file to convert. Input is taken from STDIN if no infile is specified. outfile --outfile=name Specify the HTML file to create. Output goes to STDOUT if no outfile is specified. poderrors --poderrors --nopoderrors Include a "POD ERRORS" section in the outfile if there were any POD errors in the infile (default behaviour). --nopoderrors does not create this "POD ERRORS" section. podpath --podpath=name:...:name Specify which subdirectories of the podroot contain pod files whose HTML converted forms can be linked-to in cross-references. podroot --podroot=name Specify the base directory for finding library pods. quiet --quiet --noquiet Don't display mostly harmless warning messages. --noquiet -- which is the default behavior -- does display these mostly harmless warning messages (but this is not the same as "verbose" mode). recurse --recurse --norecurse Recurse into subdirectories specified in podpath (default behaviour). --norecurse does not recurse into these subdirectories. title --title=title Specify the title of the resulting HTML file. verbose --verbose --noverbose Display progress messages. --noverbose -- which is the default behavior -- does not display these progress messages. AUTHOR Tom Christiansen, <tchrist@perl.com>. BUGS See Pod::Html for a list of known bugs in the translator. SEE ALSO perlpod, Pod::Html COPYRIGHT This program is distributed under the Artistic License. perl v5.38.2 2023-11-28 POD2HTML(1)
|
pod2html - convert .pod files to .html files
|
pod2html --help --htmldir=<name> --htmlroot=<URL> --infile=<name> --outfile=<name> --podpath=<name>:...:<name> --podroot=<name> --cachedir=<name> --flush --recurse --norecurse --quiet --noquiet --verbose --noverbose --index --noindex --backlink --nobacklink --header --noheader --poderrors --nopoderrors --css=<URL> --title=<name>
| null | null |
asn1Parser
|
Read FILE with ASN.1 definitions and generate a C array that is used with libtasn1 functions. Mandatory arguments to long options are mandatory for short options too. -c, --check checks the syntax only -o, --output=FILE output file -n, --name=NAME array name -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 asn1Parser is maintained as a Texinfo manual. If the info and asn1Parser 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 ASN1PARSER(1)
|
asn1Parser - ASN.1 syntax tree generator for libtasn1
|
asn1Parser [OPTION] FILE
| null | null |
mysqlrouter_plugin_info
|
The mysqlrouter_plugin_info utility is a debugging tool that inspects a MySQL Router plugin for potential conflicts and general problems. Usage information: $> ./mysqlrouter_plugin_info --help Usage: ./mysqlrouter_plugin_info <mysqlrouter_plugin_file> <mysql_plugin_name> Example: ./mysqlrouter_plugin_info /usr/lib/mysqlrouter/routing.so routing To print help information: ./mysqlrouter_plugin_info --help To print application version: ./mysqlrouter_plugin_info --version $> ./bin/mysqlrouter_plugin_info --version MySQLRouter Plugin Info App 8.0.3 Example usage: $> ./bin/mysqlrouter_plugin_info lib/mysqlrouter/routing.so routing { "abi-version": "2.0", "arch-descriptor": "i386/darwin//", "brief": "Routing MySQL connections between MySQL clients/connectors and servers", "plugin-version": "0.0.1", "requires": [], "conflicts": [] } COPYRIGHT Copyright © 2006, 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/. AUTHOR Oracle Corporation (http://dev.mysql.com/). MySQL 8.1 11/22/2023 MYSQLROUTER_PLUGIN_INFO(1)
|
mysqlrouter_plugin_info - MySQL Router Plugin Information
|
mysqlrouter_plugin_info [options]
| null | null |
hb-view
| null | null | null | null | null |
bunx
| null | null | null | null | null |
idn2
|
The idn2 tool converts DNS domains from UTF-8 to ASCII compatible encoding (ACE) form, as used in the DNS protocol. The encoding format is the Internationalized Domain Name (IDNA2008/TR46) format. Internationalized Domain Name (IDNA2008) convert STRINGS, or standard input. Command line interface to the Libidn2 implementation of IDNA2008. All strings are expected to be encoded in the locale charset. To process a string that starts with `-', for example `-foo', use `--' to signal the end of parameters, as in `idn2 --quiet -- -foo'. Mandatory arguments to long options are mandatory for short options too. -h, --help Print help and exit -V, --version Print version and exit -d, --decode Decode (punycode) domain name -l, --lookup Lookup domain name (default) -r, --register Register label -T, --tr46t Enable TR46 transitional processing -N, --tr46nt Enable TR46 non-transitional processing --no-tr46 Disable TR46 processing --usestd3asciirules Enable STD3 ASCII rules --no-alabelroundtrip Disable A-label roundtrip for lookups --debug Print debugging information --quiet Silent operation AUTHOR Written by Simon Josefsson, Tim Ruehsen. REPORTING BUGS Report bugs to: help-libidn@gnu.org Libidn2 home page: <https://www.gnu.org/software/libidn/#libidn2> General help using GNU software: <https://www.gnu.org/gethelp/> COPYRIGHT Copyright © 2011-2024 Simon Josefsson, Tim Ruehsen. 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 idn(1) The full documentation for idn2 is maintained as a Texinfo manual. If the info and idn2 programs are properly installed at your site, the command info idn2 should give you access to the complete manual. Libidn2 2.3.7 January 2024 IDN2(1)
|
idn2 - Libidn2 Internationalized Domain Names conversion tool
|
idn2 [OPTION]... [STRINGS]...
| null | null |
cwebp
|
This manual page documents the cwebp command. cwebp compresses an image using the WebP format. Input format can be either PNG, JPEG, TIFF, WebP or raw Y'CbCr samples. Note: Animated PNG and WebP files are not supported.
|
cwebp - compress an image file to a WebP file
|
cwebp [options] input_file -o output_file.webp
|
The basic options are: -o string Specify the name of the output WebP file. If omitted, cwebp will perform compression but only report statistics. Using "-" as output name will direct output to 'stdout'. -- string Explicitly specify the input file. This option is useful if the input file starts with a '-' for instance. This option must appear last. Any other options afterward will be ignored. -h, -help A short usage summary. -H, -longhelp A summary of all the possible options. -version Print the version number (as major.minor.revision) and exit. -lossless Encode the image without any loss. For images with fully transparent area, the invisible pixel values (R/G/B or Y/U/V) will be preserved only if the -exact option is used. -near_lossless int Specify the level of near-lossless image preprocessing. This option adjusts pixel values to help compressibility, but has minimal impact on the visual quality. It triggers lossless compression mode automatically. The range is 0 (maximum preprocessing) to 100 (no preprocessing, the default). The typical value is around 60. Note that lossy with -q 100 can at times yield better results. -q float Specify the compression factor for RGB channels between 0 and 100. The default is 75. In case of lossy compression (default), a small factor produces a smaller file with lower quality. Best quality is achieved by using a value of 100. In case of lossless compression (specified by the -lossless option), a small factor enables faster compression speed, but produces a larger file. Maximum compression is achieved by using a value of 100. -z int Switch on lossless compression mode with the specified level between 0 and 9, with level 0 being the fastest, 9 being the slowest. Fast mode produces larger file size than slower ones. A good default is -z 6. This option is actually a shortcut for some predefined settings for quality and method. If options -q or -m are subsequently used, they will invalidate the effect of this option. -alpha_q int Specify the compression factor for alpha compression between 0 and 100. Lossless compression of alpha is achieved using a value of 100, while the lower values result in a lossy compression. The default is 100. -preset string Specify a set of pre-defined parameters to suit a particular type of source material. Possible values are: default, photo, picture, drawing, icon, text. Since -preset overwrites the other parameters' values (except the -q one), this option should preferably appear first in the order of the arguments. -m int Specify the compression method to use. This parameter controls the trade off between encoding speed and the compressed file size and quality. Possible values range from 0 to 6. Default value is 4. When higher values are used, the encoder will spend more time inspecting additional encoding possibilities and decide on the quality gain. Lower value can result in faster processing time at the expense of larger file size and lower compression quality. -crop x_position y_position width height Crop the source to a rectangle with top-left corner at coordinates (x_position, y_position) and size width x height. This cropping area must be fully contained within the source rectangle. Note: the cropping is applied before any scaling. -resize width height Resize the source to a rectangle with size width x height. If either (but not both) of the width or height parameters is 0, the value will be calculated preserving the aspect-ratio. Note: scaling is applied after cropping. -mt Use multi-threading for encoding, if possible. -low_memory Reduce memory usage of lossy encoding by saving four times the compressed size (typically). This will make the encoding slower and the output slightly different in size and distortion. This flag is only effective for methods 3 and up, and is off by default. Note that leaving this flag off will have some side effects on the bitstream: it forces certain bitstream features like number of partitions (forced to 1). Note that a more detailed report of bitstream size is printed by cwebp when using this option. LOSSY OPTIONS These options are only effective when doing lossy encoding (the default, with or without alpha). -size int Specify a target size (in bytes) to try and reach for the compressed output. The compressor will make several passes of partial encoding in order to get as close as possible to this target. If both -size and -psnr are used, -size value will prevail. -psnr float Specify a target PSNR (in dB) to try and reach for the compressed output. The compressor will make several passes of partial encoding in order to get as close as possible to this target. If both -size and -psnr are used, -size value will prevail. -pass int Set a maximum number of passes to use during the dichotomy used by options -size or -psnr. Maximum value is 10, default is 1. If options -size or -psnr were used, but -pass wasn't specified, a default value of '6' passes will be used. If -pass is specified, but neither -size nor -psnr are, a target PSNR of 40dB will be used. -qrange int int Specifies the permissible interval for the quality factor. This is particularly useful when using multi-pass (-size or -psnr options). Default is 0 100. If the quality factor is outside this range, it will be clamped. If the minimum value must be less or equal to the maximum one. -af Turns auto-filter on. This algorithm will spend additional time optimizing the filtering strength to reach a well-balanced quality. -jpeg_like Change the internal parameter mapping to better match the expected size of JPEG compression. This flag will generally produce an output file of similar size to its JPEG equivalent (for the same -q setting), but with less visual distortion. Advanced options: -f int Specify the strength of the deblocking filter, between 0 (no filtering) and 100 (maximum filtering). A value of 0 will turn off any filtering. Higher value will increase the strength of the filtering process applied after decoding the picture. The higher the value the smoother the picture will appear. Typical values are usually in the range of 20 to 50. -sharpness int Specify the sharpness of the filtering (if used). Range is 0 (sharpest) to 7 (least sharp). Default is 0. -strong Use strong filtering (if filtering is being used thanks to the -f option). Strong filtering is on by default. -nostrong Disable strong filtering (if filtering is being used thanks to the -f option) and use simple filtering instead. -sharp_yuv Use more accurate and sharper RGB->YUV conversion if needed. Note that this process is slower than the default 'fast' RGB->YUV conversion. -sns int Specify the amplitude of the spatial noise shaping. Spatial noise shaping (or sns for short) refers to a general collection of built-in algorithms used to decide which area of the picture should use relatively less bits, and where else to better transfer these bits. The possible range goes from 0 (algorithm is off) to 100 (the maximal effect). The default value is 50. -segments int Change the number of partitions to use during the segmentation of the sns algorithm. Segments should be in range 1 to 4. Default value is 4. This option has no effect for methods 3 and up, unless -low_memory is used. -partition_limit int Degrade quality by limiting the number of bits used by some macroblocks. Range is 0 (no degradation, the default) to 100 (full degradation). Useful values are usually around 30-70 for moderately large images. In the VP8 format, the so-called control partition has a limit of 512k and is used to store the following information: whether the macroblock is skipped, which segment it belongs to, whether it is coded as intra 4x4 or intra 16x16 mode, and finally the prediction modes to use for each of the sub-blocks. For a very large image, 512k only leaves room for a few bits per 16x16 macroblock. The absolute minimum is 4 bits per macroblock. Skip, segment, and mode information can use up almost all these 4 bits (although the case is unlikely), which is problematic for very large images. The partition_limit factor controls how frequently the most bit-costly mode (intra 4x4) will be used. This is useful in case the 512k limit is reached and the following message is displayed: Error code: 6 (PARTITION0_OVERFLOW: Partition #0 is too big to fit 512k). If using -partition_limit is not enough to meet the 512k constraint, one should use less segments in order to save more header bits per macroblock. See the -segments option. Note the -m and -q options also influence the encoder's decisions and ability to hit this limit. LOGGING OPTIONS These options control the level of output: -v Print extra information (encoding time in particular). -print_psnr Compute and report average PSNR (Peak-Signal-To-Noise ratio). -print_ssim Compute and report average SSIM (structural similarity metric, see https://en.wikipedia.org/wiki/SSIM for additional details). -print_lsim Compute and report local similarity metric (sum of lowest error amongst the collocated pixel neighbors). -progress Report encoding progress in percent. -quiet Do not print anything. -short Only print brief information (output file size and PSNR) for testing purposes. -map int Output additional ASCII-map of encoding information. Possible map values range from 1 to 6. This is only meant to help debugging. ADDITIONAL OPTIONS More advanced options are: -s width height Specify that the input file actually consists of raw Y'CbCr samples following the ITU-R BT.601 recommendation, in 4:2:0 linear format. The luma plane has size width x height. -pre int Specify some preprocessing steps. Using a value of '2' will trigger quality-dependent pseudo-random dithering during RGBA->YUVA conversion (lossy compression only). -alpha_filter string Specify the predictive filtering method for the alpha plane. One of 'none', 'fast' or 'best', in increasing complexity and slowness order. Default is 'fast'. Internally, alpha filtering is performed using four possible predictions (none, horizontal, vertical, gradient). The 'best' mode will try each mode in turn and pick the one which gives the smaller size. The 'fast' mode will just try to form an a priori guess without testing all modes. -alpha_method int Specify the algorithm used for alpha compression: 0 or 1. Algorithm 0 denotes no compression, 1 uses WebP lossless format for compression. The default is 1. -exact Preserve RGB values in transparent area. The default is off, to help compressibility. -blend_alpha int This option blends the alpha channel (if present) with the source using the background color specified in hexadecimal as 0xrrggbb. The alpha channel is afterward reset to the opaque value 255. -noalpha Using this option will discard the alpha channel. -hint string Specify the hint about input image type. Possible values are: photo, picture or graph. -metadata string A comma separated list of metadata to copy from the input to the output if present. Valid values: all, none, exif, icc, xmp. The default is none. Note: each input format may not support all combinations. -noasm Disable all assembly optimizations. 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/
|
cwebp -q 50 -lossless picture.png -o picture_lossless.webp cwebp -q 70 picture_with_alpha.png -o picture_with_alpha.webp cwebp -sns 70 -f 50 -size 60000 picture.png -o picture.webp cwebp -o picture.webp -- ---picture.png AUTHORS cwebp 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 Pascal Massimino <pascal.massimino@gmail.com>, for the Debian project (and may be used by others). SEE ALSO dwebp(1), gif2webp(1) Please refer to https://developers.google.com/speed/webp/ for additional information. March 26, 2024 CWEBP(1)
|
sndfile-interleave
|
sndfile-interleave creates a multi-channel file taking audio data from two or more mono files as individual channels. The format of the output file is determined by its filename suffix. The audio parameters of the output file will be made so that the format can accommodate each of the mono inputs; for example, the samplerate will be the maximal samplerate occurring in the inputs. The output file will be overwritten if it already exists. sndfile-deinterleave creates two or more mono files from a multi-channel audio file, containing data from the individual channels. The names of the resulting mono files are of the form “name_XY.suf” where name and suf are the basename and suffix of the original file. If any file of such name already exists, it will be overwritten. Apart from the number of channels, the audio format of the resulting mono files is the same as that of the original file. EXIT STATUS The sndfile-interleave utility exits 0 on success, and >0 if an error occurs.
|
sndfile-interleave, sndfile-deinterleave – convert mono files into a multi-channel file and vice versa
|
sndfile-interleave input1 input2 ... -o output sndfile-deinterleave file
| null |
Merge a mono OGG file and a mono FLAC file into a stereo WAV file: $ sndfile-interleave left.ogg right.flac -o stereo.wav Split a multi-channel into individual mono files: $ sndfile-deinterleave multi.wav Input file : multi Output files : multi_00.wav multi_01.wav multi_02.wav multi_03.wav SEE ALSO http://libsndfile.github.io/libsndfile/ AUTHORS Erik de Castro Lopo <erikd@mega-nerd.com> macOS 14.5 November 2, 2014 macOS 14.5
|
get_gprof
| null | null | null | null | null |
toco
| null | null | null | null | null |
render_hlg
| null | null | null | null | null |
sndfile-convert
|
sndfile-convert converts sound files from one audio format to another. The output file is overwritten it it already exists. Formats The format of the output file is determined by the filename extension. The following file formats are currently recognized: wav WAV (Microsoft) aif AIFF (Apple/SGI) au AU (Sun/NeXT) snd AU (Sun/NeXT) raw RAW (header-less) gsm RAW (header-less) vox RAW (header-less) paf PAF (Ensoniq PARIS, big-endian) fap PAF (Ensoniq PARIS, little-endian) svx IFF (Amiga IFF/SVX8/SV16) nist SPHERE (NIST SPeech HEader Resources) sph SPHERE (NIST SPeech HEader Resources) voc VOC (Creative Labs) ircam SF (Berkeley/IRCAM/CARL) sf SF (Berkeley/IRCAM/CARL) w64 W64 (SoundFoundry WAVE 64) mat MAT4 (GNU Octave 2.0 / Matlab 4.2) mat4 MAT4 (GNU Octave 2.0 / Matlab 4.2) mat5 MAT5 (GNU Octave 2.1 / Matlab 5.0) pvf PVF (Portable Voice Format) xi XI (FastTracker 2) htk HTK (HMM Tool Kit) sds SDS (Midi Sample Dump Standard) avr AVR (Audio Visual Research) wavex WAVEX (MS WAVE with WAVEFORMATEX) sd2 SD2 (Sound Designer II) flac FLAC (FLAC Lossless Audio Codec) caf CAF (Apple Core Audio File) wve WVE (Psion Series 3) prc WVE (Psion Series 3) ogg OGG (OGG Container format) oga OGG (OGG Container format) mpc MPC (Akai MPC 2k) rf64 RF64 (RIFF 64)
|
sndfile-convert – convert sound files from one format to another
|
sndfile-convert [-override-sample-rate=rate] [-endian=little | big | cpu] [-normalize] [encoding] input output
|
The following options are recoginzed: -override-sample-rate=rate Make the input use sample rate of rate Hz. -endian=little Make the output file use little endian data. -endian=big Make the output file use big endian data. -endian=cpu Make the output file use CPU endianness. -normalize Normalize the audio data in the output file. Encodings The optional encoding parameter allows setting of the data encoding for the output file. The following encodings are currently supported: -pcms8 signed 8 bit pcm -pcmu8 unsigned 8 bit pcm -pcm16 16 bit pcm -pcm24 24 bit pcm -pcm32 32 bit pcm -float32 32 bit floating point -ulaw ULAW -alaw ALAW -ima-adpcm IMA ADPCM (WAV only) -ms-adpcm MS ADPCM (WAV only) -gsm610 GSM6.10 (WAV only) -dwvw12 12 bit DWVW (AIFF only) -dwvw16 16 bit DWVW (AIFF only) -dwvw24 24 bit DWVW (AIFF only) -vorbis Vorbis (OGG only) If no encoding is specified for the output file, sndfile-convert will try to use the encoding of the input file. This will not always work as most container formats (e.g. WAV, AIFF etc) only support a small subset of encodings (e.g. 16 bit PCM, a-law, Vorbis etc). EXIT STATUS The sndfile-convert utility exits 0 on success, and >0 if an error occurs. SEE ALSO http://libsndfile.github.io/libsndfile/ AUTHORS Erik de Castro Lopo <erikd@mega-nerd.com>. macOS 14.5 November 2, 2014 macOS 14.5
| null |
mysqldump
|
The mysqldump client utility performs logical backups, producing a set of SQL statements that can be executed to reproduce the original database object definitions and table data. It dumps one or more MySQL databases for backup or transfer to another SQL server. The mysqldump command can also generate output in CSV, other delimited text, or XML format. Tip Consider using the MySQL Shell dump utilities[1], which provide parallel dumping with multiple threads, file compression, and progress information display, as well as cloud features such as Oracle Cloud Infrastructure Object Storage streaming, and MySQL HeatWave Service compatibility checks and modifications. Dumps can be easily imported into a MySQL Server instance or a MySQL HeatWave Service DB System using the MySQL Shell load dump utilities[2]. Installation instructions for MySQL Shell can be found here[3]. • Performance and Scalability Considerations • Invocation Syntax • Option Syntax - Alphabetical Summary • Connection Options • Option-File Options • DDL Options • Debug Options • Help Options • Internationalization Options • Replication Options • Format Options • Filtering Options • Performance Options • Transactional Options • Option Groups • Examples • Restrictions mysqldump requires at least the SELECT privilege for dumped tables, SHOW VIEW for dumped views, TRIGGER for dumped triggers, LOCK TABLES if the --single-transaction option is not used, PROCESS if the --no-tablespaces option is not used, and the RELOAD or FLUSH_TABLES priviledge with --single-transaction if both gtid_mode=ON and --set-gtid=purged=ON|AUTO. Certain options might require other privileges as noted in the option descriptions. To reload a dump file, you must have the privileges required to execute the statements that it contains, such as the appropriate CREATE privileges for objects created by those statements. mysqldump output can include ALTER DATABASE statements that change the database collation. These may be used when dumping stored programs to preserve their character encodings. To reload a dump file containing such statements, the ALTER privilege for the affected database is required. Note A dump made using PowerShell on Windows with output redirection creates a file that has UTF-16 encoding: mysqldump [options] > dump.sql However, UTF-16 is not permitted as a connection character set (see the section called “Impermissible Client Character Sets”), so the dump file cannot be loaded correctly. To work around this issue, use the --result-file option, which creates the output in ASCII format: mysqldump [options] --result-file=dump.sql It is not recommended to load a dump file when GTIDs are enabled on the server (gtid_mode=ON), if your dump file includes system tables. mysqldump issues DML instructions for the system tables which use the non-transactional MyISAM storage engine, and this combination is not permitted when GTIDs are enabled. Performance and Scalability Considerations mysqldump advantages include the convenience and flexibility of viewing or even editing the output before restoring. You can clone databases for development and DBA work, or produce slight variations of an existing database for testing. It is not intended as a fast or scalable solution for backing up substantial amounts of data. With large data sizes, even if the backup step takes a reasonable time, restoring the data can be very slow because replaying the SQL statements involves disk I/O for insertion, index creation, and so on. For large-scale backup and restore, a physical backup is more appropriate, to copy the data files in their original format so that they can be restored quickly. If your tables are primarily InnoDB tables, or if you have a mix of InnoDB and MyISAM tables, consider using mysqlbackup, which is available as part of MySQL Enterprise. This tool provides high performance for InnoDB backups with minimal disruption; it can also back up tables from MyISAM and other storage engines; it also provides a number of convenient options to accommodate different backup scenarios. See Section 30.2, “MySQL Enterprise Backup Overview”. mysqldump can retrieve and dump table contents row by row, or it can retrieve the entire content from a table and buffer it in memory before dumping it. Buffering in memory can be a problem if you are dumping large tables. To dump tables row by row, use the --quick option (or --opt, which enables --quick). The --opt option (and hence --quick) is enabled by default, so to enable memory buffering, use --skip-quick. If you are using a recent version of mysqldump to generate a dump to be reloaded into a very old MySQL server, use the --skip-opt option instead of the --opt or --extended-insert option. For additional information about mysqldump, see Section 7.4, “Using mysqldump for Backups”. Invocation Syntax There are in general three ways to use mysqldump—in order to dump a set of one or more tables, a set of one or more complete databases, or an entire MySQL server—as shown here: mysqldump [options] db_name [tbl_name ...] mysqldump [options] --databases db_name ... mysqldump [options] --all-databases To dump entire databases, do not name any tables following db_name, or use the --databases or --all-databases option. To see a list of the options your version of mysqldump supports, issue the command mysqldump --help. Option Syntax - Alphabetical Summary mysqldump supports the following options, which can be specified on the command line or in the [mysqldump] 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”. Connection Options The mysqldump command logs into a MySQL server to extract information. The following options specify how to connect to the MySQL server, either on the same machine or a remote system. • --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. • --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”. • --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”.) • --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 │ └────────────────────┴────────┘ Dump data from the MySQL server on the given host. The default host is localhost. • --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”. • --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, mysqldump 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 mysqldump 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, mysqldump 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 mysqldump 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-authentication-kerberos-client-mode=value ┌────────────────────┬──────────────────────────────────────────────┐ │Command-Line Format │ --plugin-authentication-kerberos-client-mode │ ├────────────────────┼──────────────────────────────────────────────┤ │Type │ String │ ├────────────────────┼──────────────────────────────────────────────┤ │Default Value │ SSPI │ ├────────────────────┼──────────────────────────────────────────────┤ │Valid Values │ GSSAPI │ └────────────────────┴──────────────────────────────────────────────┘ On Windows, the authentication_kerberos_client authentication plugin supports this plugin option. It provides two possible values that the client user can set at runtime: SSPI and GSSAPI. The default value for the client-side plugin option uses Security Support Provider Interface (SSPI), which is capable of acquiring credentials from the Windows in-memory cache. Alternatively, the client user can select a mode that supports Generic Security Service Application Program Interface (GSSAPI) through the MIT Kerberos library on Windows. GSSAPI is capable of acquiring cached credentials previously generated by using the kinit command. For more information, see Commands for Windows Clients in GSSAPI Mode. • --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 mysqldump 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. • --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”. • --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”. • --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. If you are using the Rewriter plugin, you should grant this user the SKIP_QUERY_REWRITE privilege. • --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”. Option-File Options These options are used to control which option files to read. • --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, mysqldump normally reads the [client] and [mysqldump] groups. If this option is given as --defaults-group-suffix=_other, mysqldump also reads the [client_other] and [mysqldump_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”. • --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”. • --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”. DDL Options Usage scenarios for mysqldump include setting up an entire new MySQL instance (including database tables), and replacing data inside an existing instance with existing databases and tables. The following options let you specify which things to tear down and set up when restoring a dump, by encoding various DDL statements within the dump file. • --add-drop-database ┌────────────────────┬─────────────────────┐ │Command-Line Format │ --add-drop-database │ └────────────────────┴─────────────────────┘ Write a DROP DATABASE statement before each CREATE DATABASE statement. This option is typically used in conjunction with the --all-databases or --databases option because no CREATE DATABASE statements are written unless one of those options is specified. Note In MySQL 8.3, the mysql schema is considered a system schema that cannot be dropped by end users. If --add-drop-database is used with --all-databases or with --databases where the list of schemas to be dumped includes mysql, the dump file contains a DROP DATABASE `mysql` statement that causes an error when the dump file is reloaded. Instead, to use --add-drop-database, use --databases with a list of schemas to be dumped, where the list does not include mysql. • --add-drop-table ┌────────────────────┬──────────────────┐ │Command-Line Format │ --add-drop-table │ └────────────────────┴──────────────────┘ Write a DROP TABLE statement before each CREATE TABLE statement. • --add-drop-trigger ┌────────────────────┬────────────────────┐ │Command-Line Format │ --add-drop-trigger │ └────────────────────┴────────────────────┘ Write a DROP TRIGGER statement before each CREATE TRIGGER statement. • --all-tablespaces, -Y ┌────────────────────┬───────────────────┐ │Command-Line Format │ --all-tablespaces │ └────────────────────┴───────────────────┘ Adds to a table dump all SQL statements needed to create any tablespaces used by an NDB table. This information is not otherwise included in the output from mysqldump. This option is currently relevant only to NDB Cluster tables. • --no-create-db, -n ┌────────────────────┬────────────────┐ │Command-Line Format │ --no-create-db │ └────────────────────┴────────────────┘ Suppress the CREATE DATABASE statements that are otherwise included in the output if the --databases or --all-databases option is given. • --no-create-info, -t ┌────────────────────┬──────────────────┐ │Command-Line Format │ --no-create-info │ └────────────────────┴──────────────────┘ Do not write CREATE TABLE statements that create each dumped table. Note This option does not exclude statements creating log file groups or tablespaces from mysqldump output; however, you can use the --no-tablespaces option for this purpose. • --no-tablespaces, -y ┌────────────────────┬──────────────────┐ │Command-Line Format │ --no-tablespaces │ └────────────────────┴──────────────────┘ This option suppresses all CREATE LOGFILE GROUP and CREATE TABLESPACE statements in the output of mysqldump. • --replace ┌────────────────────┬───────────┐ │Command-Line Format │ --replace │ └────────────────────┴───────────┘ Write REPLACE statements rather than INSERT statements. Debug Options The following options print debugging information, encode debugging information in the dump file, or let the dump operation proceed regardless of potential problems. • --allow-keywords ┌────────────────────┬──────────────────┐ │Command-Line Format │ --allow-keywords │ └────────────────────┴──────────────────┘ Permit creation of column names that are keywords. This works by prefixing each column name with the table name. • --comments, -i ┌────────────────────┬────────────┐ │Command-Line Format │ --comments │ └────────────────────┴────────────┘ Write additional information in the dump file such as program version, server version, and host. This option is enabled by default. To suppress this additional information, use --skip-comments. • --debug[=debug_options], -# [debug_options] ┌────────────────────┬────────────────────────────┐ │Command-Line Format │ --debug[=debug_options] │ ├────────────────────┼────────────────────────────┤ │Type │ String │ ├────────────────────┼────────────────────────────┤ │Default Value │ d:t:o,/tmp/mysqldump.trace │ └────────────────────┴────────────────────────────┘ Write a debugging log. A typical debug_options string is d:t:o,file_name. The default value is d:t:o,/tmp/mysqldump.trace. 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. • --dump-date ┌────────────────────┬─────────────┐ │Command-Line Format │ --dump-date │ ├────────────────────┼─────────────┤ │Type │ Boolean │ ├────────────────────┼─────────────┤ │Default Value │ TRUE │ └────────────────────┴─────────────┘ If the --comments option is given, mysqldump produces a comment at the end of the dump of the following form: -- Dump completed on DATE However, the date causes dump files taken at different times to appear to be different, even if the data are otherwise identical. --dump-date and --skip-dump-date control whether the date is added to the comment. The default is --dump-date (include the date in the comment). --skip-dump-date suppresses date printing. • --force, -f ┌────────────────────┬─────────┐ │Command-Line Format │ --force │ └────────────────────┴─────────┘ Ignore all errors; continue even if an SQL error occurs during a table dump. One use for this option is to cause mysqldump to continue executing even when it encounters a view that has become invalid because the definition refers to a table that has been dropped. Without --force, mysqldump exits with an error message. With --force, mysqldump prints the error message, but it also writes an SQL comment containing the view definition to the dump output and continues executing. If the --ignore-error option is also given to ignore specific errors, --force takes precedence. • --log-error=file_name ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --log-error=file_name │ ├────────────────────┼───────────────────────┤ │Type │ File name │ └────────────────────┴───────────────────────┘ Log warnings and errors by appending them to the named file. The default is to do no logging. • --skip-comments ┌────────────────────┬─────────────────┐ │Command-Line Format │ --skip-comments │ └────────────────────┴─────────────────┘ See the description for the --comments option. • --verbose, -v ┌────────────────────┬───────────┐ │Command-Line Format │ --verbose │ └────────────────────┴───────────┘ Verbose mode. Print more information about what the program does. Help Options The following options display information about the mysqldump command itself. • --help, -? ┌────────────────────┬────────┐ │Command-Line Format │ --help │ └────────────────────┴────────┘ Display a help message and exit. • --version, -V ┌────────────────────┬───────────┐ │Command-Line Format │ --version │ └────────────────────┴───────────┘ Display version information and exit. Internationalization Options The following options change how the mysqldump command represents character data with national language settings. • --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”. • --default-character-set=charset_name ┌────────────────────┬──────────────────────────────────────┐ │Command-Line Format │ --default-character-set=charset_name │ ├────────────────────┼──────────────────────────────────────┤ │Type │ String │ ├────────────────────┼──────────────────────────────────────┤ │Default Value │ utf8 │ └────────────────────┴──────────────────────────────────────┘ Use charset_name as the default character set. See Section 10.15, “Character Set Configuration”. If no character set is specified, mysqldump uses utf8mb4. • --no-set-names, -N ┌────────────────────┬────────────────┐ │Command-Line Format │ --no-set-names │ ├────────────────────┼────────────────┤ │Deprecated │ Yes │ └────────────────────┴────────────────┘ Turns off the --set-charset setting, the same as specifying --skip-set-charset. • --set-charset ┌────────────────────┬──────────────────┐ │Command-Line Format │ --set-charset │ ├────────────────────┼──────────────────┤ │Disabled by │ skip-set-charset │ └────────────────────┴──────────────────┘ Write SET NAMES default_character_set to the output. This option is enabled by default. To suppress the SET NAMES statement, use --skip-set-charset. Replication Options The mysqldump command is frequently used to create an empty instance, or an instance including data, on a replica server in a replication configuration. The following options apply to dumping and restoring data on replication source servers and replicas. • --apply-replica-statements ┌────────────────────┬────────────────────────────┐ │Command-Line Format │ --apply-replica-statements │ ├────────────────────┼────────────────────────────┤ │Type │ Boolean │ ├────────────────────┼────────────────────────────┤ │Default Value │ FALSE │ └────────────────────┴────────────────────────────┘ For a replica dump produced with the --dump-replica option, this option adds a STOP REPLICA statement before the statement with the binary log coordinates, and a START REPLICA statement at the end of the output. • --apply-slave-statements ┌────────────────────┬──────────────────────────┐ │Command-Line Format │ --apply-slave-statements │ ├────────────────────┼──────────────────────────┤ │Deprecated │ Yes │ ├────────────────────┼──────────────────────────┤ │Type │ Boolean │ ├────────────────────┼──────────────────────────┤ │Default Value │ FALSE │ └────────────────────┴──────────────────────────┘ This is a deprecated alias for --apply-replica-statements. • --delete-source-logs ┌────────────────────┬──────────────────────┐ │Command-Line Format │ --delete-source-logs │ └────────────────────┴──────────────────────┘ On a replication source server, delete the binary logs by sending a PURGE BINARY LOGS statement to the server after performing the dump operation. The options require the RELOAD privilege as well as privileges sufficient to execute that statement. This option automatically enables --source-data. • --delete-master-logs ┌────────────────────┬──────────────────────┐ │Command-Line Format │ --delete-master-logs │ ├────────────────────┼──────────────────────┤ │Deprecated │ Yes │ └────────────────────┴──────────────────────┘ This is a deprecated alias for --delete-source-logs. • --dump-replica[=value] ┌────────────────────┬────────────────────────┐ │Command-Line Format │ --dump-replica[=value] │ ├────────────────────┼────────────────────────┤ │Type │ Numeric │ ├────────────────────┼────────────────────────┤ │Default Value │ 1 │ ├────────────────────┼────────────────────────┤ │Valid Values │ 1 2 │ └────────────────────┴────────────────────────┘ This option is similar to --source-data, except that it's used to dump a replica server to produce a dump file that can be used to set up another server as a replica that has the same source as the dumped server. The option causes the dump output to include a CHANGE REPLICATION SOURCE TO statement that indicates the binary log coordinates (file name and position) of the dumped replica's source. The CHANGE REPLICATION SOURCE TO statement reads the values of Relay_Master_Log_File and Exec_Master_Log_Pos from the SHOW REPLICA STATUS output and uses them for SOURCE_LOG_FILE and SOURCE_LOG_POS respectively. These are the replication source server coordinates from which the replica starts replicating. Note Inconsistencies in the sequence of transactions from the relay log which have been executed can cause the wrong position to be used. See Section 17.5.1.34, “Replication and Transaction Inconsistencies” for more information. --dump-replica causes the coordinates from the source to be used rather than those of the dumped server, as is done by the --source-data option. In addition, specifying this option overrides the --source-data option. Warning --dump-replica should not be used if the server where the dump is going to be applied uses gtid_mode=ON and SOURCE_AUTO_POSITION=1. The option value is handled the same way as for --source-data. Setting no value or 1 causes a CHANGE REPLICATION SOURCE TO statement to be written to the dump. Setting 2 causes the statement to be written but encased in SQL comments. It has the same effect as --source-data in terms of enabling or disabling other options and in how locking is handled. --dump-replica causes mysqldump to stop the replication SQL thread before the dump and restart it again after. --dump-replica sends a SHOW REPLICA STATUS statement to the server to obtain information, so they require privileges sufficient to execute that statement. --apply-replica-statements and --include-source-host-port options can be used in conjunction with --dump-replica. • --dump-slave[=value] ┌────────────────────┬──────────────────────┐ │Command-Line Format │ --dump-slave[=value] │ ├────────────────────┼──────────────────────┤ │Deprecated │ Yes │ ├────────────────────┼──────────────────────┤ │Type │ Numeric │ ├────────────────────┼──────────────────────┤ │Default Value │ 1 │ ├────────────────────┼──────────────────────┤ │Valid Values │ 1 2 │ └────────────────────┴──────────────────────┘ This is a deprecated alias for --dump-replica. • --include-source-host-port ┌────────────────────┬────────────────────────────┐ │Command-Line Format │ --include-source-host-port │ ├────────────────────┼────────────────────────────┤ │Type │ Boolean │ ├────────────────────┼────────────────────────────┤ │Default Value │ FALSE │ └────────────────────┴────────────────────────────┘ Adds the SOURCE_HOST and SOURCE_PORT options for the host name and TCP/IP port number of the replica's source, to the CHANGE REPLICATION SOURCE TO statement in a replica dump produced with the --dump-replica option. • --include-master-host-port ┌────────────────────┬────────────────────────────┐ │Command-Line Format │ --include-master-host-port │ ├────────────────────┼────────────────────────────┤ │Deprecated │ Yes │ ├────────────────────┼────────────────────────────┤ │Type │ Boolean │ ├────────────────────┼────────────────────────────┤ │Default Value │ FALSE │ └────────────────────┴────────────────────────────┘ This is a deprecated alias for --include-source-host-port. • --master-data[=value] ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --master-data[=value] │ ├────────────────────┼───────────────────────┤ │Deprecated │ Yes │ ├────────────────────┼───────────────────────┤ │Type │ Numeric │ ├────────────────────┼───────────────────────┤ │Default Value │ 1 │ ├────────────────────┼───────────────────────┤ │Valid Values │ 1 2 │ └────────────────────┴───────────────────────┘ This is a deprecated alias for --source-data. • --output-as-version=value ┌────────────────────┬────────────────────────────┐ │Command-Line Format │ --output-as-version=value │ ├────────────────────┼────────────────────────────┤ │Type │ Enumeration │ ├────────────────────┼────────────────────────────┤ │Default Value │ SERVER │ ├────────────────────┼────────────────────────────┤ │Valid Values │ BEFORE_8_0_23 │ │ │ BEFORE_8_2_0 │ └────────────────────┴────────────────────────────┘ Determines the level of terminology used for statements relating to replicas and events, making it possible to create dumps compatible with older versions of MySQL that do not accept the newer terminology. This option can take any one of the following values, with effects described as listed here: • SERVER: Reads the server version and uses the latest versions of statements compatible with that version. This is the default value. • BEFORE_8_0_23: Replication SQL statements using deprecated terms such as “slave” and “master” are written to the output in place of those using “replica” and “source”, as in MySQL versions prior to 8.0.23. This option also duplicates the effects of BEFORE_8_2_0 on the output of SHOW CREATE EVENT. • BEFORE_8_2_0: This option causes SHOW CREATE EVENT to reflect how the event would have been created in a MySQL server prior to version 8.2.0, displaying DISABLE ON SLAVE rather than DISABLE ON REPLICA. This option affects the output from --events, --dump-replica, --source-data, --apply-replica-statements, and --include-source-host-port. Added in MySQL 8.2.0. • --source-data[=value] ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --source-data[=value] │ ├────────────────────┼───────────────────────┤ │Type │ Numeric │ ├────────────────────┼───────────────────────┤ │Default Value │ 1 │ ├────────────────────┼───────────────────────┤ │Valid Values │ 1 2 │ └────────────────────┴───────────────────────┘ Used to dump a replication source server to produce a dump file that can be used to set up another server as a replica of the source. The options cause the dump output to include a CHANGE REPLICATION SOURCE TO statement that indicates the binary log coordinates (file name and position) of the dumped server. These are the replication source server coordinates from which the replica should start replicating after you load the dump file into the replica. If the option value is 2, the CHANGE REPLICATION SOURCE TO statement is written as an SQL comment, and thus is informative only; it has no effect when the dump file is reloaded. If the option value is 1, the statement is not written as a comment and takes effect when the dump file is reloaded. If no option value is specified, the default value is 1. --source-data sends a SHOW BINARY LOG STATUS statement to the server to obtain information, so they require privileges sufficient to execute that statement. This option also requires the RELOAD privilege and the binary log must be enabled. --source-data automatically turns off --lock-tables. They also turn on --lock-all-tables, unless --single-transaction also is specified, in which case, a global read lock is acquired only for a short time at the beginning of the dump (see the description for --single-transaction). In all cases, any action on logs happens at the exact moment of the dump. It is also possible to set up a replica by dumping an existing replica of the source, using the --dump-replica option, which overrides --source-data causing it to be ignored. • --set-gtid-purged=value ┌────────────────────┬─────────────────────────┐ │Command-Line Format │ --set-gtid-purged=value │ ├────────────────────┼─────────────────────────┤ │Type │ Enumeration │ ├────────────────────┼─────────────────────────┤ │Default Value │ AUTO │ ├────────────────────┼─────────────────────────┤ │Valid Values │ OFF ON AUTO │ └────────────────────┴─────────────────────────┘ This option is for servers that use GTID-based replication (gtid_mode=ON). It controls the inclusion of a SET @@GLOBAL.gtid_purged statement in the dump output, which updates the value of gtid_purged on a server where the dump file is reloaded, to add the GTID set from the source server's gtid_executed system variable. gtid_purged holds the GTIDs of all transactions that have been applied on the server, but do not exist on any binary log file on the server. mysqldump therefore adds the GTIDs for the transactions that were executed on the source server, so that the target server records these transactions as applied, although it does not have them in its binary logs. --set-gtid-purged also controls the inclusion of a SET @@SESSION.sql_log_bin=0 statement, which disables binary logging while the dump file is being reloaded. This statement prevents new GTIDs from being generated and assigned to the transactions in the dump file as they are executed, so that the original GTIDs for the transactions are used. If you do not set the --set-gtid-purged option, the default is that a SET @@GLOBAL.gtid_purged statement is included in the dump output if GTIDs are enabled on the server you are backing up, and the set of GTIDs in the global value of the gtid_executed system variable is not empty. A SET @@SESSION.sql_log_bin=0 statement is also included if GTIDs are enabled on the server. You can either replace the value of gtid_purged with a specified GTID set, or add a plus sign (+) to the statement to append a specified GTID set to the GTID set that is already held by gtid_purged. The SET @@GLOBAL.gtid_purged statement recorded by mysqldump includes a plus sign (+) in a version-specific comment, such that MySQL adds the GTID set from the dump file to the existing gtid_purged value. It is important to note that the value that is included by mysqldump for the SET @@GLOBAL.gtid_purged statement includes the GTIDs of all transactions in the gtid_executed set on the server, even those that changed suppressed parts of the database, or other databases on the server that were not included in a partial dump. This can mean that after the gtid_purged value has been updated on the server where the dump file is replayed, GTIDs are present that do not relate to any data on the target server. If you do not replay any further dump files on the target server, the extraneous GTIDs do not cause any problems with the future operation of the server, but they make it harder to compare or reconcile GTID sets on different servers in the replication topology. If you do replay a further dump file on the target server that contains the same GTIDs (for example, another partial dump from the same origin server), any SET @@GLOBAL.gtid_purged statement in the second dump file fails. In this case, either remove the statement manually before replaying the dump file, or output the dump file without the statement. If the SET @@GLOBAL.gtid_purged statement would not have the desired result on your target server, you can exclude the statement from the output, or include it but comment it out so that it is not actioned automatically. You can also include the statement but manually edit it in the dump file to achieve the desired result. The possible values for the --set-gtid-purged option are as follows: AUTO The default value. If GTIDs are enabled on the server you are backing up and gtid_executed is not empty, SET @@GLOBAL.gtid_purged is added to the output, containing the GTID set from gtid_executed. If GTIDs are enabled, SET @@SESSION.sql_log_bin=0 is added to the output. If GTIDs are not enabled on the server, the statements are not added to the output. OFF SET @@GLOBAL.gtid_purged is not added to the output, and SET @@SESSION.sql_log_bin=0 is not added to the output. For a server where GTIDs are not in use, use this option or AUTO. Only use this option for a server where GTIDs are in use if you are sure that the required GTID set is already present in gtid_purged on the target server and should not be changed, or if you plan to identify and add any missing GTIDs manually. ON If GTIDs are enabled on the server you are backing up, SET @@GLOBAL.gtid_purged is added to the output (unless gtid_executed is empty), and SET @@SESSION.sql_log_bin=0 is added to the output. An error occurs if you set this option but GTIDs are not enabled on the server. For a server where GTIDs are in use, use this option or AUTO, unless you are sure that the GTIDs in gtid_executed are not needed on the target server. COMMENTED If GTIDs are enabled on the server you are backing up, SET @@GLOBAL.gtid_purged is added to the output (unless gtid_executed is empty), but it is commented out. This means that the value of gtid_executed is available in the output, but no action is taken automatically when the dump file is reloaded. SET @@SESSION.sql_log_bin=0 is added to the output, and it is not commented out. With COMMENTED, you can control the use of the gtid_executed set manually or through automation. For example, you might prefer to do this if you are migrating data to another server that already has different active databases. Format Options The following options specify how to represent the entire dump file or certain kinds of data in the dump file. They also control whether certain optional information is written to the dump file. • --compact ┌────────────────────┬───────────┐ │Command-Line Format │ --compact │ └────────────────────┴───────────┘ Produce more compact output. This option enables the --skip-add-drop-table, --skip-add-locks, --skip-comments, --skip-disable-keys, and --skip-set-charset options. • --compatible=name ┌────────────────────┬──────────────────────────────┐ │Command-Line Format │ --compatible=name[,name,...] │ ├────────────────────┼──────────────────────────────┤ │Type │ String │ ├────────────────────┼──────────────────────────────┤ │Default Value │ │ ├────────────────────┼──────────────────────────────┤ │Valid Values │ ansi mysql323 mysql40 │ │ │ postgresql oracle mssql │ │ │ db2 maxdb no_key_options │ │ │ no_table_options │ │ │ no_key_options │ └────────────────────┴──────────────────────────────┘ Produce output that is more compatible with other database systems or with older MySQL servers. The only permitted value for this option is ansi, which has the same meaning as the corresponding option for setting the server SQL mode. See Section 5.1.11, “Server SQL Modes”. • --complete-insert, -c ┌────────────────────┬───────────────────┐ │Command-Line Format │ --complete-insert │ └────────────────────┴───────────────────┘ Use complete INSERT statements that include column names. • --create-options ┌────────────────────┬──────────────────┐ │Command-Line Format │ --create-options │ └────────────────────┴──────────────────┘ Include all MySQL-specific table options in the CREATE TABLE statements. • --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 are used with the --tab option and have the same meaning as the corresponding FIELDS clauses for LOAD DATA. See Section 13.2.9, “LOAD DATA Statement”. • --hex-blob ┌────────────────────┬────────────┐ │Command-Line Format │ --hex-blob │ └────────────────────┴────────────┘ Dump binary columns using hexadecimal notation (for example, 'abc' becomes 0x616263). The affected data types are BINARY, VARBINARY, BLOB types, BIT, all spatial data types, and other non-binary data types when used with the binary character set. The --hex-blob option is ignored when the --tab is used. • --lines-terminated-by=... ┌────────────────────┬──────────────────────────────┐ │Command-Line Format │ --lines-terminated-by=string │ ├────────────────────┼──────────────────────────────┤ │Type │ String │ └────────────────────┴──────────────────────────────┘ This option is used with the --tab option and has the same meaning as the corresponding LINES clause for LOAD DATA. See Section 13.2.9, “LOAD DATA Statement”. • --quote-names, -Q ┌────────────────────┬──────────────────┐ │Command-Line Format │ --quote-names │ ├────────────────────┼──────────────────┤ │Disabled by │ skip-quote-names │ └────────────────────┴──────────────────┘ Quote identifiers (such as database, table, and column names) within ` characters. If the ANSI_QUOTES SQL mode is enabled, identifiers are quoted within " characters. This option is enabled by default. It can be disabled with --skip-quote-names, but this option should be given after any option such as --compatible that may enable --quote-names. • --result-file=file_name, -r file_name ┌────────────────────┬─────────────────────────┐ │Command-Line Format │ --result-file=file_name │ ├────────────────────┼─────────────────────────┤ │Type │ File name │ └────────────────────┴─────────────────────────┘ Direct output to the named file. The result file is created and its previous contents overwritten, even if an error occurs while generating the dump. This option should be used on Windows to prevent newline \n characters from being converted to \r\n carriage return/newline sequences. • --show-create-skip-secondary-engine=value ┌────────────────────┬─────────────────────────────────────┐ │Command-Line Format │ --show-create-skip-secondary-engine │ └────────────────────┴─────────────────────────────────────┘ Excludes the SECONDARY ENGINE clause from CREATE TABLE statements. It does so by enabling the show_create_table_skip_secondary_engine system variable for the duration of the dump operation. Alternatively, you can enable the show_create_table_skip_secondary_engine system variable prior to using mysqldump. • --tab=dir_name, -T dir_name ┌────────────────────┬────────────────┐ │Command-Line Format │ --tab=dir_name │ ├────────────────────┼────────────────┤ │Type │ Directory name │ └────────────────────┴────────────────┘ Produce tab-separated text-format data files. For each dumped table, mysqldump creates a tbl_name.sql file that contains the CREATE TABLE statement that creates the table, and the server writes a tbl_name.txt file that contains its data. The option value is the directory in which to write the files. Note This option should be used only when mysqldump is run on the same machine as the mysqld server. Because the server creates *.txt files in the directory that you specify, the directory must be writable by the server and the MySQL account that you use must have the FILE privilege. Because mysqldump creates *.sql in the same directory, it must be writable by your system login account. By default, the .txt data files are formatted using tab characters between column values and a newline at the end of each line. The format can be specified explicitly using the --fields-xxx and --lines-terminated-by options. Column values are converted to the character set specified by the --default-character-set option. • --tz-utc ┌────────────────────┬─────────────┐ │Command-Line Format │ --tz-utc │ ├────────────────────┼─────────────┤ │Disabled by │ skip-tz-utc │ └────────────────────┴─────────────┘ This option enables TIMESTAMP columns to be dumped and reloaded between servers in different time zones. mysqldump sets its connection time zone to UTC and adds SET TIME_ZONE='+00:00' to the dump file. Without this option, TIMESTAMP columns are dumped and reloaded in the time zones local to the source and destination servers, which can cause the values to change if the servers are in different time zones. --tz-utc also protects against changes due to daylight saving time. --tz-utc is enabled by default. To disable it, use --skip-tz-utc. • --xml, -X ┌────────────────────┬───────┐ │Command-Line Format │ --xml │ └────────────────────┴───────┘ Write dump output as well-formed XML. NULL, 'NULL', and Empty Values: For a column named column_name, the NULL value, an empty string, and the string value 'NULL' are distinguished from one another in the output generated by this option as follows. ┌─────────────────────┬─────────────────────────────────┐ │Value: │ XML Representation: │ ├─────────────────────┼─────────────────────────────────┤ │NULL (unknown value) │ <field name="column_name" │ │ │ xsi:nil="true" /> │ ├─────────────────────┼─────────────────────────────────┤ │(empty string) │ <field │ │ │ name="column_name"></field> │ ├─────────────────────┼─────────────────────────────────┤ │(string value) │ <field │ │ │ name="column_name">NULL</field> │ └─────────────────────┴─────────────────────────────────┘ The output from the mysql client when run using the --xml option also follows the preceding rules. (See the section called “MYSQL CLIENT OPTIONS”.) XML output from mysqldump includes the XML namespace, as shown here: $> mysqldump --xml -u root world City <?xml version="1.0"?> <mysqldump xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <database name="world"> <table_structure name="City"> <field Field="ID" Type="int(11)" Null="NO" Key="PRI" Extra="auto_increment" /> <field Field="Name" Type="char(35)" Null="NO" Key="" Default="" Extra="" /> <field Field="CountryCode" Type="char(3)" Null="NO" Key="" Default="" Extra="" /> <field Field="District" Type="char(20)" Null="NO" Key="" Default="" Extra="" /> <field Field="Population" Type="int(11)" Null="NO" Key="" Default="0" Extra="" /> <key Table="City" Non_unique="0" Key_name="PRIMARY" Seq_in_index="1" Column_name="ID" Collation="A" Cardinality="4079" Null="" Index_type="BTREE" Comment="" /> <options Name="City" Engine="MyISAM" Version="10" Row_format="Fixed" Rows="4079" Avg_row_length="67" Data_length="273293" Max_data_length="18858823439613951" Index_length="43008" Data_free="0" Auto_increment="4080" Create_time="2007-03-31 01:47:01" Update_time="2007-03-31 01:47:02" Collation="latin1_swedish_ci" Create_options="" Comment="" /> </table_structure> <table_data name="City"> <row> <field name="ID">1</field> <field name="Name">Kabul</field> <field name="CountryCode">AFG</field> <field name="District">Kabol</field> <field name="Population">1780000</field> </row> ... <row> <field name="ID">4079</field> <field name="Name">Rafah</field> <field name="CountryCode">PSE</field> <field name="District">Rafah</field> <field name="Population">92020</field> </row> </table_data> </database> </mysqldump> Filtering Options The following options control which kinds of schema objects are written to the dump file: by category, such as triggers or events; by name, for example, choosing which databases and tables to dump; or even filtering rows from the table data using a WHERE clause. • --all-databases, -A ┌────────────────────┬─────────────────┐ │Command-Line Format │ --all-databases │ └────────────────────┴─────────────────┘ Dump all tables in all databases. This is the same as using the --databases option and naming all the databases on the command line. Note See the --add-drop-database description for information about an incompatibility of that option with --all-databases. Prior to MySQL 8.3, the --routines and --events options for mysqldump and mysqlpump were not required to include stored routines and events when using the --all-databases option: The dump included the mysql system database, and therefore also the mysql.proc and mysql.event tables containing stored routine and event definitions. As of MySQL 8.3, the mysql.event and mysql.proc tables are not used. Definitions for the corresponding objects are stored in data dictionary tables, but those tables are not dumped. To include stored routines and events in a dump made using --all-databases, use the --routines and --events options explicitly. • --databases, -B ┌────────────────────┬─────────────┐ │Command-Line Format │ --databases │ └────────────────────┴─────────────┘ Dump several databases. Normally, mysqldump treats the first name argument on the command line as a database name and following names as table names. With this option, it treats all name arguments as database names. CREATE DATABASE and USE statements are included in the output before each new database. This option may be used to dump the performance_schema database, which normally is not dumped even with the --all-databases option. (Also use the --skip-lock-tables option.) Note See the --add-drop-database description for information about an incompatibility of that option with --databases. • --events, -E ┌────────────────────┬──────────┐ │Command-Line Format │ --events │ └────────────────────┴──────────┘ Include Event Scheduler events for the dumped databases in the output. This option requires the EVENT privileges for those databases. The output generated by using --events contains CREATE EVENT statements to create the events. • --ignore-error=error[,error]... ┌────────────────────┬─────────────────────────────────┐ │Command-Line Format │ --ignore-error=error[,error]... │ ├────────────────────┼─────────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────────┘ Ignore the specified errors. The option value is a list of comma-separated error numbers specifying the errors to ignore during mysqldump execution. If the --force option is also given to ignore all errors, --force takes precedence. • --ignore-table=db_name.tbl_name ┌────────────────────┬─────────────────────────────────┐ │Command-Line Format │ --ignore-table=db_name.tbl_name │ ├────────────────────┼─────────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────────┘ Do not dump the given table, which must be specified using both the database and table names. To ignore multiple tables, use this option multiple times. This option also can be used to ignore views. • --ignore-views=boolean ┌────────────────────┬────────────────┐ │Command-Line Format │ --ignore-views │ ├────────────────────┼────────────────┤ │Type │ Boolean │ ├────────────────────┼────────────────┤ │Default Value │ FALSE │ └────────────────────┴────────────────┘ Skips table views in the dump file. Option added in MySQL 8.2.0. • --init-command=str ┌────────────────────┬────────────────────┐ │Command-Line Format │ --init-command=str │ ├────────────────────┼────────────────────┤ │Type │ String │ └────────────────────┴────────────────────┘ Single SQL statement to execute after connecting to the MySQL server. The definition resets existing statements defined by it or init-command-add. Option added in MySQL 8.2.0. • --init-command-add=str ┌────────────────────┬────────────────────────┐ │Command-Line Format │ --init-command-add=str │ ├────────────────────┼────────────────────────┤ │Type │ String │ └────────────────────┴────────────────────────┘ Add an additional SQL statement to execute after connecting or reconnecting to the MySQL server. It's usable without --init-command but has no effect if used before it because init-command resets the list of commands to call. Option added in MySQL 8.2.0. • --no-data, -d ┌────────────────────┬───────────┐ │Command-Line Format │ --no-data │ └────────────────────┴───────────┘ Do not write any table row information (that is, do not dump table contents). This is useful if you want to dump only the CREATE TABLE statement for the table (for example, to create an empty copy of the table by loading the dump file). • --routines, -R ┌────────────────────┬────────────┐ │Command-Line Format │ --routines │ └────────────────────┴────────────┘ Include stored routines (procedures and functions) for the dumped databases in the output. This option requires the global SELECT privilege. The output generated by using --routines contains CREATE PROCEDURE and CREATE FUNCTION statements to create the routines. • --skip-generated-invisible-primary-key ┌────────────────────┬────────────────────────────────────────┐ │Command-Line Format │ --skip-generated-invisible-primary-key │ ├────────────────────┼────────────────────────────────────────┤ │Type │ Boolean │ ├────────────────────┼────────────────────────────────────────┤ │Default Value │ FALSE │ └────────────────────┴────────────────────────────────────────┘ This option causes generated invisible primary keys to be excluded from the output. For more information, see Section 13.1.20.11, “Generated Invisible Primary Keys”. • --tables ┌────────────────────┬──────────┐ │Command-Line Format │ --tables │ └────────────────────┴──────────┘ Override the --databases or -B option. mysqldump regards all name arguments following the option as table names. • --triggers ┌────────────────────┬───────────────┐ │Command-Line Format │ --triggers │ ├────────────────────┼───────────────┤ │Disabled by │ skip-triggers │ └────────────────────┴───────────────┘ Include triggers for each dumped table in the output. This option is enabled by default; disable it with --skip-triggers. To be able to dump a table's triggers, you must have the TRIGGER privilege for the table. Multiple triggers are permitted. mysqldump dumps triggers in activation order so that when the dump file is reloaded, triggers are created in the same activation order. However, if a mysqldump dump file contains multiple triggers for a table that have the same trigger event and action time, an error occurs for attempts to load the dump file into an older server that does not support multiple triggers. (For a workaround, see Downgrade Notes[4]; you can convert triggers to be compatible with older servers.) • --where='where_condition', -w 'where_condition' ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --where='where_condition' │ └────────────────────┴───────────────────────────┘ Dump only rows selected by the given WHERE condition. Quotes around the condition are mandatory if it contains spaces or other characters that are special to your command interpreter. Examples: --where="user='jimf'" -w"userid>1" -w"userid<1" Performance Options The following options are the most relevant for the performance particularly of the restore operations. For large data sets, restore operation (processing the INSERT statements in the dump file) is the most time-consuming part. When it is urgent to restore data quickly, plan and test the performance of this stage in advance. For restore times measured in hours, you might prefer an alternative backup and restore solution, such as MySQL Enterprise Backup for InnoDB-only and mixed-use databases. Performance is also affected by the transactional options, primarily for the dump operation. • --column-statistics ┌────────────────────┬─────────────────────┐ │Command-Line Format │ --column-statistics │ ├────────────────────┼─────────────────────┤ │Type │ Boolean │ ├────────────────────┼─────────────────────┤ │Default Value │ OFF │ └────────────────────┴─────────────────────┘ Add ANALYZE TABLE statements to the output to generate histogram statistics for dumped tables when the dump file is reloaded. This option is disabled by default because histogram generation for large tables can take a long time. • --disable-keys, -K ┌────────────────────┬────────────────┐ │Command-Line Format │ --disable-keys │ └────────────────────┴────────────────┘ For each table, surround the INSERT statements with /*!40000 ALTER TABLE tbl_name DISABLE KEYS */; and /*!40000 ALTER TABLE tbl_name ENABLE KEYS */; statements. This makes loading the dump file faster because the indexes are created after all rows are inserted. This option is effective only for nonunique indexes of MyISAM tables. • --extended-insert, -e ┌────────────────────┬──────────────────────┐ │Command-Line Format │ --extended-insert │ ├────────────────────┼──────────────────────┤ │Disabled by │ skip-extended-insert │ └────────────────────┴──────────────────────┘ Write INSERT statements using multiple-row syntax that includes several VALUES lists. This results in a smaller dump file and speeds up inserts when the file is reloaded. • --insert-ignore ┌────────────────────┬─────────────────┐ │Command-Line Format │ --insert-ignore │ └────────────────────┴─────────────────┘ Write INSERT IGNORE statements rather than INSERT statements. • --max-allowed-packet=value ┌────────────────────┬────────────────────────────┐ │Command-Line Format │ --max-allowed-packet=value │ ├────────────────────┼────────────────────────────┤ │Type │ Numeric │ ├────────────────────┼────────────────────────────┤ │Default Value │ 25165824 │ └────────────────────┴────────────────────────────┘ The maximum size of the buffer for client/server communication. The default is 24MB, the maximum is 1GB. Note The value of this option is specific to mysqldump and should not be confused with the MySQL server's max_allowed_packet system variable; the server value cannot be exceeded by a single packet from mysqldump, regardless of any setting for the mysqldump option, even if the latter is larger. • --mysqld-long-query-time=value ┌────────────────────┬────────────────────────────────┐ │Command-Line Format │ --mysqld-long-query-time=value │ ├────────────────────┼────────────────────────────────┤ │Type │ Numeric │ ├────────────────────┼────────────────────────────────┤ │Default Value │ Server global setting │ └────────────────────┴────────────────────────────────┘ Set the session value of the long_query_time system variable. Use this option if you want to increase the time allowed for mysqldump's queries before they are logged to the slow query log file. mysqldump performs a full table scan, which means its queries can often exceed a global long_query_time setting that is useful for regular queries. The default global setting is 10 seconds. You can use --mysqld-long-query-time to specify a session value from 0 (meaning that every query from mysqldump is logged to the slow query log) to 31536000, which is 365 days in seconds. For mysqldump’s option, you can only specify whole seconds. When you do not specify this option, the server’s global setting applies to mysqldump’s queries. • --net-buffer-length=value ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --net-buffer-length=value │ ├────────────────────┼───────────────────────────┤ │Type │ Numeric │ ├────────────────────┼───────────────────────────┤ │Default Value │ 16384 │ └────────────────────┴───────────────────────────┘ The initial size of the buffer for client/server communication. When creating multiple-row INSERT statements (as with the --extended-insert or --opt option), mysqldump creates rows up to --net-buffer-length bytes long. If you increase this variable, ensure that the MySQL server net_buffer_length system variable has a value at least this large. • --network-timeout, -M ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --network-timeout[={0|1}] │ ├────────────────────┼───────────────────────────┤ │Type │ Boolean │ ├────────────────────┼───────────────────────────┤ │Default Value │ TRUE │ └────────────────────┴───────────────────────────┘ Enable large tables to be dumped by setting --max-allowed-packet to its maximum value and network read and write timeouts to a large value. This option is enabled by default. To disable it, use --skip-network-timeout. • --opt ┌────────────────────┬──────────┐ │Command-Line Format │ --opt │ ├────────────────────┼──────────┤ │Disabled by │ skip-opt │ └────────────────────┴──────────┘ This option, enabled by default, is shorthand for the combination of --add-drop-table --add-locks --create-options --disable-keys --extended-insert --lock-tables --quick --set-charset. It gives a fast dump operation and produces a dump file that can be reloaded into a MySQL server quickly. Because the --opt option is enabled by default, you only specify its converse, the --skip-opt to turn off several default settings. See the discussion of mysqldump option groups for information about selectively enabling or disabling a subset of the options affected by --opt. • --quick, -q ┌────────────────────┬────────────┐ │Command-Line Format │ --quick │ ├────────────────────┼────────────┤ │Disabled by │ skip-quick │ └────────────────────┴────────────┘ This option is useful for dumping large tables. It forces mysqldump to retrieve rows for a table from the server a row at a time rather than retrieving the entire row set and buffering it in memory before writing it out. • --skip-opt ┌────────────────────┬────────────┐ │Command-Line Format │ --skip-opt │ └────────────────────┴────────────┘ See the description for the --opt option. Transactional Options The following options trade off the performance of the dump operation, against the reliability and consistency of the exported data. • --add-locks ┌────────────────────┬─────────────┐ │Command-Line Format │ --add-locks │ └────────────────────┴─────────────┘ Surround each table dump with LOCK TABLES and UNLOCK TABLES statements. This results in faster inserts when the dump file is reloaded. See Section 8.2.5.1, “Optimizing INSERT Statements”. • --flush-logs, -F ┌────────────────────┬──────────────┐ │Command-Line Format │ --flush-logs │ └────────────────────┴──────────────┘ Flush the MySQL server log files before starting the dump. This option requires the RELOAD privilege. If you use this option in combination with the --all-databases option, the logs are flushed for each database dumped. The exception is when using --lock-all-tables, --source-data, or --single-transaction. In these cases, the logs are flushed only once, corresponding to the moment that all tables are locked by FLUSH TABLES WITH READ LOCK. If you want your dump and the log flush to happen at exactly the same moment, you should use --flush-logs together with --lock-all-tables, --source-data, or --single-transaction. • --flush-privileges ┌────────────────────┬────────────────────┐ │Command-Line Format │ --flush-privileges │ └────────────────────┴────────────────────┘ Add a FLUSH PRIVILEGES statement to the dump output after dumping the mysql database. This option should be used any time the dump contains the mysql database and any other database that depends on the data in the mysql database for proper restoration. Because the dump file contains a FLUSH PRIVILEGES statement, reloading the file requires privileges sufficient to execute that statement. Note For upgrades to MySQL 5.7 or higher from older versions, do not use --flush-privileges. For upgrade instructions in this case, see Section 2.10.4, “Changes in MySQL 8.3”. • --lock-all-tables, -x ┌────────────────────┬───────────────────┐ │Command-Line Format │ --lock-all-tables │ └────────────────────┴───────────────────┘ Lock all tables across all databases. This is achieved by acquiring a global read lock for the duration of the whole dump. This option automatically turns off --single-transaction and --lock-tables. • --lock-tables, -l ┌────────────────────┬───────────────┐ │Command-Line Format │ --lock-tables │ └────────────────────┴───────────────┘ For each dumped database, lock all tables to be dumped before dumping them. The tables are locked with READ LOCAL to permit concurrent inserts in the case of MyISAM tables. For transactional tables such as InnoDB, --single-transaction is a much better option than --lock-tables because it does not need to lock the tables at all. Because --lock-tables locks tables for each database separately, this option does not guarantee that the tables in the dump file are logically consistent between databases. Tables in different databases may be dumped in completely different states. Some options, such as --opt, automatically enable --lock-tables. If you want to override this, use --skip-lock-tables at the end of the option list. • --no-autocommit ┌────────────────────┬─────────────────┐ │Command-Line Format │ --no-autocommit │ └────────────────────┴─────────────────┘ Enclose the INSERT statements for each dumped table within SET autocommit = 0 and COMMIT statements. • --order-by-primary ┌────────────────────┬────────────────────┐ │Command-Line Format │ --order-by-primary │ └────────────────────┴────────────────────┘ Dump each table's rows sorted by its primary key, or by its first unique index, if such an index exists. This is useful when dumping a MyISAM table to be loaded into an InnoDB table, but makes the dump operation take considerably longer. • --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. • --single-transaction ┌────────────────────┬──────────────────────┐ │Command-Line Format │ --single-transaction │ └────────────────────┴──────────────────────┘ This option sets the transaction isolation mode to REPEATABLE READ and sends a START TRANSACTION SQL statement to the server before dumping data. It is useful only with transactional tables such as InnoDB, because then it dumps the consistent state of the database at the time when START TRANSACTION was issued without blocking any applications. The RELOAD or FLUSH_TABLES privilege is required with --single-transaction if both gtid_mode=ON and --set-gtid=purged=ON|AUTO. When using this option, you should keep in mind that only InnoDB tables are dumped in a consistent state. For example, any MyISAM or MEMORY tables dumped while using this option may still change state. While a --single-transaction dump is in process, to ensure a valid dump file (correct table contents and binary log coordinates), no other connection should use the following statements: ALTER TABLE, CREATE TABLE, DROP TABLE, RENAME TABLE, TRUNCATE TABLE. A consistent read is not isolated from those statements, so use of them on a table to be dumped can cause the SELECT that is performed by mysqldump to retrieve the table contents to obtain incorrect contents or fail. The --single-transaction option and the --lock-tables option are mutually exclusive because LOCK TABLES causes any pending transactions to be committed implicitly. To dump large tables, combine the --single-transaction option with the --quick option. Option Groups • The --opt option turns on several settings that work together to perform a fast dump operation. All of these settings are on by default, because --opt is on by default. Thus you rarely if ever specify --opt. Instead, you can turn these settings off as a group by specifying --skip-opt, then optionally re-enable certain settings by specifying the associated options later on the command line. • The --compact option turns off several settings that control whether optional statements and comments appear in the output. Again, you can follow this option with other options that re-enable certain settings, or turn all the settings on by using the --skip-compact form. When you selectively enable or disable the effect of a group option, order is important because options are processed first to last. For example, --disable-keys --lock-tables --skip-opt would not have the intended effect; it is the same as --skip-opt by itself. Examples To make a backup of an entire database: mysqldump db_name > backup-file.sql To load the dump file back into the server: mysql db_name < backup-file.sql Another way to reload the dump file: mysql -e "source /path-to-backup/backup-file.sql" db_name mysqldump is also very useful for populating databases by copying data from one MySQL server to another: mysqldump --opt db_name | mysql --host=remote_host -C db_name You can dump several databases with one command: mysqldump --databases db_name1 [db_name2 ...] > my_databases.sql To dump all databases, use the --all-databases option: mysqldump --all-databases > all_databases.sql For InnoDB tables, mysqldump provides a way of making an online backup: mysqldump --all-databases --source-data --single-transaction > all_databases.sql This backup acquires a global read lock on all tables (using FLUSH TABLES WITH READ LOCK) at the beginning of the dump. As soon as this lock has been acquired, the binary log coordinates are read and the lock is released. If long updating statements are running when the FLUSH statement is issued, the MySQL server may get stalled until those statements finish. After that, the dump becomes lock free and does not disturb reads and writes on the tables. If the update statements that the MySQL server receives are short (in terms of execution time), the initial lock period should not be noticeable, even with many updates. For point-in-time recovery (also known as “roll-forward,” when you need to restore an old backup and replay the changes that happened since that backup), it is often useful to rotate the binary log (see Section 5.4.4, “The Binary Log”) or at least know the binary log coordinates to which the dump corresponds: mysqldump --all-databases --source-data=2 > all_databases.sql Or: mysqldump --all-databases --flush-logs --source-data=2 > all_databases.sql The --source-data option can be used simultaneously with the --single-transaction option, which provides a convenient way to make an online backup suitable for use prior to point-in-time recovery if tables are stored using the InnoDB storage engine. For more information on making backups, see Section 7.2, “Database Backup Methods”, and Section 7.3, “Example Backup and Recovery Strategy”. • To select the effect of --opt except for some features, use the --skip option for each feature. To disable extended inserts and memory buffering, use --opt --skip-extended-insert --skip-quick. (Actually, --skip-extended-insert --skip-quick is sufficient because --opt is on by default.) • To reverse --opt for all features except disabling of indexes and table locking, use --skip-opt --disable-keys --lock-tables. Restrictions mysqldump does not dump the performance_schema or sys schema by default. To dump any of these, name them explicitly on the command line. You can also name them with the --databases option. For performance_schema, also use the --skip-lock-tables option. mysqldump does not dump the INFORMATION_SCHEMA schema. mysqldump does not dump InnoDB CREATE TABLESPACE statements. mysqldump does not dump the NDB Cluster ndbinfo information database. mysqldump includes statements to recreate the general_log and slow_query_log tables for dumps of the mysql database. Log table contents are not dumped. If you encounter problems backing up views due to insufficient privileges, see Section 25.9, “Restrictions on Views” for a workaround. 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/. NOTES 1. MySQL Shell dump utilities https://dev.mysql.com/doc/mysql-shell/8.1/en/mysql-shell-utilities- dump-instance-schema.html 2. MySQL Shell load dump utilities https://dev.mysql.com/doc/mysql-shell/8.1/en/mysql-shell-utilities- load-dump.html 3. here https://dev.mysql.com/doc/mysql-shell/8.1/en/mysql-shell- install.html 4. Downgrade Notes https://dev.mysql.com/doc/refman/5.7/en/downgrading-to-previous- series.html 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 MYSQLDUMP(1)
|
mysqldump - a database backup program
|
mysqldump [options] [db_name [tbl_name ...]]
| null | null |
pinentry-curses
| null | null | null | null | null |
yat2m
| null | null | null | null | null |
tone_map
| null | null | null | null | null |
xzgrep
|
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 |
gpgme-config
| null | null | null | null | null |
pydoc3
| null | null | null | null | null |
hb-shape
| null | null | null | null | null |
aarch64-apple-darwin23-c++-13
| null | null | null | null | null |
ggroups
|
Print group memberships for each USERNAME or, if no USERNAME is specified, for the current process (which may differ if the groups database has changed). --help display this help and exit --version output version information and exit AUTHOR Written by David MacKenzie and James Youngman. 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 getent(1) Full documentation <https://www.gnu.org/software/coreutils/groups> or available locally via: info '(coreutils) groups invocation' GNU coreutils 9.3 April 2023 GROUPS(1)
|
groups - print the groups a user is in
|
groups [OPTION]... [USERNAME]...
| null | null |
precat
| null | null | null | null | null |
mysql.server
|
MySQL distributions on Unix and Unix-like system include a script named mysql.server, which starts the MySQL server using mysqld_safe. It can be used on systems such as Linux and Solaris that use System V-style run directories to start and stop system services. It is also used by the macOS Startup Item for MySQL. mysql.server is the script name as used within the MySQL source tree. The installed name might be different (for example, mysqld or mysql). In the following discussion, adjust the name mysql.server as appropriate for your system. 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, mysql.server and mysqld_safe are not installed because they are unnecessary. For more information, see Section 2.5.9, “Managing MySQL Server with systemd”. To start or stop the server manually using the mysql.server script, invoke it from the command line with start or stop arguments: mysql.server start mysql.server stop mysql.server changes location to the MySQL installation directory, then invokes mysqld_safe. To run the server as some specific user, add an appropriate user option to the [mysqld] group of the global /etc/my.cnf option file, as shown later in this section. (It is possible that you must edit mysql.server if you've installed a binary distribution of MySQL in a nonstandard location. Modify it to change location into the proper directory before it runs mysqld_safe. If you do this, your modified version of mysql.server may be overwritten if you upgrade MySQL in the future; make a copy of your edited version that you can reinstall.) mysql.server stop stops the server by sending a signal to it. You can also stop the server manually by executing mysqladmin shutdown. To start and stop MySQL automatically on your server, you must add start and stop commands to the appropriate places in your /etc/rc* files: • If you use the Linux server RPM package (MySQL-server-VERSION.rpm), or a native Linux package installation, the mysql.server script may be installed in the /etc/init.d directory with the name mysqld or mysql. See Section 2.5.4, “Installing MySQL on Linux Using RPM Packages from Oracle”, for more information on the Linux RPM packages. • If you install MySQL from a source distribution or using a binary distribution format that does not install mysql.server automatically, you can install the script manually. It can be found in the support-files directory under the MySQL installation directory or in a MySQL source tree. Copy the script to the /etc/init.d directory with the name mysql and make it executable: cp mysql.server /etc/init.d/mysql chmod +x /etc/init.d/mysql After installing the script, the commands needed to activate it to run at system startup depend on your operating system. On Linux, you can use chkconfig: chkconfig --add mysql On some Linux systems, the following command also seems to be necessary to fully enable the mysql script: chkconfig --level 345 mysql on • On FreeBSD, startup scripts generally should go in /usr/local/etc/rc.d/. Install the mysql.server script as /usr/local/etc/rc.d/mysql.server.sh to enable automatic startup. The rc(8) manual page states that scripts in this directory are executed only if their base name matches the *.sh shell file name pattern. Any other files or directories present within the directory are silently ignored. • As an alternative to the preceding setup, some operating systems also use /etc/rc.local or /etc/init.d/boot.local to start additional services on startup. To start up MySQL using this method, append a command like the one following to the appropriate startup file: /bin/sh -c 'cd /usr/local/mysql; ./bin/mysqld_safe --user=mysql &' • For other systems, consult your operating system documentation to see how to install startup scripts. mysql.server reads options from the [mysql.server] and [mysqld] sections of option files. For backward compatibility, it also reads [mysql_server] sections, but to be current you should rename such sections to [mysql.server]. You can add options for mysql.server in a global /etc/my.cnf file. A typical my.cnf file might look like this: [mysqld] datadir=/usr/local/mysql/var socket=/var/tmp/mysql.sock port=3306 user=mysql [mysql.server] basedir=/usr/local/mysql The mysql.server script supports the options shown in the following table. If specified, they must be placed in an option file, not on the command line. mysql.server supports only start and stop as command-line arguments. Table 4.3. mysql.server Option-File Options ┌────────────────────────┬─────────────────────┬────────────────┐ │Option Name │ Description │ Type │ ├────────────────────────┼─────────────────────┼────────────────┤ │basedir │ Path to MySQL │ Directory name │ │ │ installation │ │ │ │ directory │ │ ├────────────────────────┼─────────────────────┼────────────────┤ │datadir │ Path to MySQL data │ Directory name │ │ │ directory │ │ ├────────────────────────┼─────────────────────┼────────────────┤ │pid-file │ File in which │ File name │ │ │ server should write │ │ │ │ its process ID │ │ ├────────────────────────┼─────────────────────┼────────────────┤ │service-startup-timeout │ How long to wait │ Integer │ │ │ for server startup │ │ └────────────────────────┴─────────────────────┴────────────────┘ • basedir=dir_name The path to the MySQL installation directory. • datadir=dir_name The path to the MySQL data directory. • pid-file=file_name The path name of the file in which the server should write its process ID. The server creates the file in the data directory unless an absolute path name is given to specify a different directory. If this option is not given, mysql.server uses a default value of host_name.pid. The PID file value passed to mysqld_safe overrides any value specified in the [mysqld_safe] option file group. Because mysql.server reads the [mysqld] option file group but not the [mysqld_safe] group, you can ensure that mysqld_safe gets the same value when invoked from mysql.server as when invoked manually by putting the same pid-file setting in both the [mysqld_safe] and [mysqld] groups. • service-startup-timeout=seconds How long in seconds to wait for confirmation of server startup. If the server does not start within this time, mysql.server exits with an error. The default value is 900. A value of 0 means not to wait at all for startup. Negative values mean to wait forever (no timeout). 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 MYSQL.SERVER(1)
|
mysql.server - MySQL server startup script
|
mysql {start|stop}
| null | null |
libgcrypt-config
| null | null | null | null | null |
mindflow
| null | null | null | null | null |
ssl_context_info
| null | null | null | null | null |
pk_encrypt
| null | null | null | null | null |
rsa_decrypt
| null | null | null | null | null |
rist2rist
| null | null | null | null | null |
rust-demangler
| null | null | null | null | null |
pyrsa-verify
| null | null | null | null | null |
mysqlxtest
| null | null | null | null | null |
coverage
| null | null | null | null | null |
lzma
|
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)
|
mpicalc
| null | null | null | null | null |
gdbm_load
|
Create a gdbm database file DB_FILE from the dump file FILE. If the FILE argument is not supplied, output the created database to the standard error. If the input file is in ASCII dump format, the mode and ownership of the created database are restored from the information in the dump. This can be overridden using the command line options (see below).
|
gdbm_load - re-create a GDBM database from a dump file.
|
gdbm_load [-MUnr] [-b NUM] [-c NUM] [-m MODE] [-u NAME|UID[:NAME|GID]] [--block-size=NUM] [--cache-size=NUM] [--mmap=NUM] [--mode=MODE] [--no-meta] [--replace] [--update] [--user=NAME|UID[:NAME|GID]] FILE [DB_FILE] gdbm_load [-Vh] [--help] [--usage] [--version]
|
-b, --block-size=NUM Sets block size. -c, --cache-size=NUM Sets cache size. -M, --mmap Use memory mapping. -m, --mode=MODE Set database file mode (octal number). -n, --no-meta Do not attempt to restore database meta-data (mode and ownership). -r, --replace Replace existing keys. This must be used together with the -U (--update) option. -U, --update Update an existing database. Key/value pairs from the dump file will be added to that database, without removing the existing keys. To overwrite keys that are duplicated in the dump file, use the --replace option. If the database does not exist, it will be created. -u, --user=NAME|UID[:NAME|GID] Set file ownership. -h, --help Print a short usage summary. --usage Print a list of available options. -V, --version Print program version SEE ALSO gdbm_dump(1), gdbmtool(1), gdbm(3). For a detailed description of gdbm_load 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 July 1, 2024 GDBM_LOAD(1)
| null |
gsleep
|
Pause for NUMBER seconds. SUFFIX may be 's' for seconds (the default), 'm' for minutes, 'h' for hours or 'd' for days. NUMBER need not be an integer. Given two or more arguments, pause for the amount of time specified by the sum of their values. --help display this help and exit --version output version information and exit AUTHOR Written by Jim Meyering and Paul Eggert. 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 sleep(3) Full documentation <https://www.gnu.org/software/coreutils/sleep> or available locally via: info '(coreutils) sleep invocation' GNU coreutils 9.3 April 2023 SLEEP(1)
|
sleep - delay for a specified amount of time
|
sleep NUMBER[SUFFIX]... sleep OPTION
| null | null |
tiffcomment
| null | null | null | null | null |
hmac256
|
This is a standalone HMAC-SHA-256 implementation used to compute an HMAC-SHA-256 message authentication code. The tool has originally been developed as a second implementation for Libgcrypt to allow comparing against the primary implementation and to be used for internal consistency checks. It should not be used for sensitive data because no mechanisms to clear the stack etc are used. The code has been written in a highly portable manner and requires only a few standard definitions to be provided in a config.h file. hmac256 is commonly invoked as hmac256 "This is my key" foo.txt This compute the MAC on the file ‘foo.txt’ using the key given on the command line.
|
hmac256 - Compute an HMAC-SHA-256 MAC
|
hmac256 [--binary] key [FILENAME]
|
hmac256 understands these options: --binary Print the MAC as a binary string. The default is to print the MAC encoded as lower case hex digits. --version Print version of the program and exit. SEE ALSO sha256sum(1) Libgcrypt 1.10.3 2023-11-14 HMAC256(1)
| null |
modutil
| null | null | null | null | null |
decode_and_encode
| null | null | null | null | null |
sha512sum
|
Print or check SHA512 (512-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/sha512sum> or available locally via: info '(coreutils) sha2 utilities' GNU coreutils 9.3 April 2023 SHA512SUM(1)
|
sha512sum - compute and check SHA512 message digest
|
sha512sum [OPTION]... [FILE]...
| null | null |
p11-kit
| null | null | null | null | null |
curve_keygen
| null | null | null | null | null |
sndfile-play
|
sndfile-play plays one or more sound files on various operating systems using standard audio output APIs. The following table summarizes which audio API is used where: Linux ALSA or OSS OpenBSD sndio FreeBSD /dev/dsp (OSS) NetBSD /dev/audio Solaris /dev/audio MacOSX 10.6 CoreAudio MacOSX 10.7 AudioToolbox Win32 waveOut SEE ALSO http://libsndfile.github.io/libsndfile/ AUTHORS Erik de Castro Lopo <erikd@mega-nerd.com> macOS 14.5 September 10, 2021 macOS 14.5
|
sndfile-play – play a sound file
|
sndfile-play file ...
| null | null |
gfactor
|
Print the prime factors of each specified integer NUMBER. If none are specified on the command line, read them from standard input. -h, --exponents print repeated factors in form p^e unless e is 1 --help display this help and exit --version output version information and exit AUTHOR Written by Paul Rubin, Torbj"orn Granlund, and Niels M"oller. 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/factor> or available locally via: info '(coreutils) factor invocation' GNU coreutils 9.3 April 2023 FACTOR(1)
|
factor - factor numbers
|
factor [OPTION] [NUMBER]...
| null | null |
accelerate-config
| null | null | null | null | null |
py.test
| null | null | null | null | null |
gpg-wks-server
|
The gpg-wks-server is a server side implementation of the Web Key Service. It receives requests for publication, sends confirmation requests, receives confirmations, and published the key. It also has features to ease the setup and maintenance of a Web Key Directory. When used with the command --receive a single Web Key Service mail is processed. Commonly this command is used with the option --send to directly send the created mails back. See below for an installation example. The command --cron is used for regular cleanup tasks. For example non- confirmed requested should be removed after their expire time. It is best to run this command once a day from a cronjob. The command --list-domains prints all configured domains. Further it creates missing directories for the configuration and prints warnings pertaining to problems in the configuration. The command --check-key (or just --check) checks whether a key with the given user-id is installed. The process returns success in this case; to also print a diagnostic use the option -v. If the key is not installed a diagnostic is printed and the process returns failure; to suppress the diagnostic, use option -q. More than one user-id can be given; see also option with-file. The command --install-key manually installs a key into the WKD. The arguments are a file with the keyblock and the user-id to install. If the first argument resembles a fingerprint the key is taken from the current keyring; to force the use of a file, prefix the first argument with "./". If no arguments are given the parameters are read from stdin; the expected format are lines with the fingerprint and the mailbox separated by a space. The command --remove-key uninstalls a key from the WKD. The process returns success in this case; to also print a diagnostic, use option -v. If the key is not installed a diagnostic is printed and the process returns failure; to suppress the diagnostic, use option -q. The command --revoke-key is not yet functional.
|
gpg-wks-server - Server providing the Web Key Service
|
gpg-wks-server [options] --receive gpg-wks-server [options] --cron gpg-wks-server [options] --list-domains gpg-wks-server [options] --check-key user-id gpg-wks-server [options] --install-key file user-id gpg-wks-server [options] --remove-key user-id gpg-wks-server [options] --revoke-key user-id
|
gpg-wks-server understands these options: -C dir --directory dir Use dir as top level directory for domains. The default is ‘/var/lib/gnupg/wks’. --from mailaddr Use mailaddr as the default sender address. --header name=value Add the mail header "name: value" to all outgoing mails. --send Directly send created mails using the sendmail command. Requires installation of that command. -o file --output file Write the created mail also to file. Note that the value - for file would write it to stdout. --with-dir When used with the command --list-domains print for each installed domain the domain name and its directory name. --with-file When used with the command --check-key print for each user-id, the address, 'i' for installed key or 'n' for not installed key, and the filename. --verbose Enable extra informational output. --quiet Disable almost all informational output. --version Print version of the program and exit. --help Display a brief help page and exit.
|
The Web Key Service requires a working directory to store keys pending for publication. As root create a working directory: # mkdir /var/lib/gnupg/wks # chown webkey:webkey /var/lib/gnupg/wks # chmod 2750 /var/lib/gnupg/wks Then under your webkey account create directories for all your domains. Here we do it for "example.net": $ mkdir /var/lib/gnupg/wks/example.net Finally run $ gpg-wks-server --list-domains to create the required sub-directories with the permissions set correctly. For each domain a submission address needs to be configured. All service mails are directed to that address. It can be the same address for all configured domains, for example: $ cd /var/lib/gnupg/wks/example.net $ echo key-submission@example.net >submission-address The protocol requires that the key to be published is sent with an encrypted mail to the service. Thus you need to create a key for the submission address: $ gpg --batch --passphrase '' --quick-gen-key key-submission@example.net $ gpg -K key-submission@example.net The output of the last command looks similar to this: sec rsa3072 2016-08-30 [SC] C0FCF8642D830C53246211400346653590B3795B uid [ultimate] key-submission@example.net bxzcxpxk8h87z1k7bzk86xn5aj47intu@example.net ssb rsa3072 2016-08-30 [E] Take the fingerprint from that output and manually publish the key: $ gpg-wks-server --install-key C0FCF8642D830C53246211400346653590B3795B \ > key-submission@example.net Finally that submission address needs to be redirected to a script running gpg-wks-server. The procmail command can be used for this: Redirect the submission address to the user "webkey" and put this into webkey's ‘.procmailrc’: :0 * !^From: webkey@example.net * !^X-WKS-Loop: webkey.example.net |gpg-wks-server -v --receive \ --header X-WKS-Loop=webkey.example.net \ --from webkey@example.net --send SEE ALSO gpg-wks-client(1) GnuPG 2.4.5 2024-03-04 GPG-WKS-SERVER(1)
|
nss-config
| null | null | null | null | null |
fisql
|
fisql is very similar to the ‘isql’ utility programs distributed by Sybase and Microsoft. Like them, fisql uses the command ‘go’ on a line by itself as a separator between batches.
|
fisql – interactive SQL shell
|
fisql [-eFgpnvXY] [-a display_charset] [-A packet_size] [-c cmdend] [-D database] [-E editor] [-h headers] [-H hostname] [-i inputfile] [-I interfaces_file] [-J client_charset] [-l login_timeout] [-m errorlevel] [-o outputfile] [-P password] [-s colseparator] [-S server] [-t timeout] [-U username] [-w width] [-y sybase_dir] [-z language]
|
-a display_charset The client charset name. Not implemented. -A packet_size Set protocol packet size. You should not need to set this parameter. -c cmdend Command terminator, defaults to ‘go’. -D Database name on the server to use. -e Echo SQL input (usually in outputfile) -E editor Specify an editor to invoke. Defaults to vi. -F FIPS mode ON. Server returns a message (but processes the query anyway) when it encounters a non-standard SQL command. -g Display a brief help message -h headers Number of rows after which to repeat the column headers. Default is once per resultset. -H hostname Hostname of the client machine as it will be told to the server. -I interfaces_file Name of the interfaces or freetds.conf file to use. -i inputfile Name of script file, containing SQL. -J client_charset Not implemented. -l login_timeout How long to wait for the server to acknowledge a login attempt. -m errorlevel For errors of the severity level specified or higher, print only the message number, state, and error level. Below that level, print nothing. -n Suppress line numbers in echoed output. -o outputfile Name of output file, holding result data. -p Prints performance statistics. Not implemented. -P password Database server password. -s colseparator The column separator. Default is space. Shell metacharacters require quoting. -S server Database server to which to connect. -t timeout The query timeout, in seconds. How long to wait for a query to be processed. The default is indefinitely, or as determined by freetds.conf. -U username Database server login name. -v Display version and copyright. -w width How many characters wide to print the output. Defaults to 80. -X Use encrypted login. Not implemented in FreeTDS. -y sybase_dir Sets the SYBASE environment variable. Not used by FreeTDS. -Y Use chained transactions. -z language Name of a language for fisql's prompts and messages. Cf. DBSETLNATLANG. NOTES fisql is a filter; it reads from standard input, writes to standard output, and writes errors to standard error. The -i, and -e options override these defaults. fisql uses the DB-Library API provided by FreeTDS. It was first implemented using Sybase's own library and continues to work with it. Before (and after) modifying it, it would be well to test it with Sybase's library to assure compatibility between it and FreeTDS. EXIT STATUS fisql exits 0 on success, and >0 if the server cannot process the query. fisql will report any errors returned by the server, but will continue processing. In a production environment, this behavior may be insufficiently stringent. To make it extremely intolerant of errors, change the message and error handlers to call exit(3). HISTORY fisql first appeared in FreeTDS 0.65. AUTHORS The fisql utility was written by Nicholas S. Castellano ⟨entropy@freetds.org⟩, who contributed it to the FreeTDS project under the terms of the GPL. BUGS Requires the GNU readline library. FreeTDS 1.4.21 March 25, 2015 FreeTDS 1.4.21
| null |
autotrain
| null | null | null | null | null |
ffplay
|
FFplay is a very simple and portable media player using the FFmpeg libraries and the SDL library. It is mostly used as a testbed for the various FFmpeg APIs.
|
ffplay - FFplay media player
|
ffplay [options] [input_url]
|
All the numerical options, if not specified otherwise, accept a string representing a number as input, which may be followed by one of the SI unit prefixes, for example: 'K', 'M', or 'G'. If 'i' is appended to the SI unit prefix, the complete prefix will be interpreted as a unit prefix for binary multiples, which are based on powers of 1024 instead of powers of 1000. Appending 'B' to the SI unit prefix multiplies the value by 8. This allows using, for example: 'KB', 'MiB', 'G' and 'B' as number suffixes. Options which do not take arguments are boolean options, and set the corresponding value to true. They can be set to false by prefixing the option name with "no". For example using "-nofoo" will set the boolean option with name "foo" to false. Options that take arguments support a special syntax where the argument given on the command line is interpreted as a path to the file from which the actual argument value is loaded. To use this feature, add a forward slash '/' immediately before the option name (after the leading dash). E.g. ffmpeg -i INPUT -/filter:v filter.script OUTPUT will load a filtergraph description from the file named filter.script. Stream specifiers Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers are used to precisely specify which stream(s) a given option belongs to. A stream specifier is a string generally appended to the option name and separated from it by a colon. E.g. "-codec:a:1 ac3" contains the "a:1" stream specifier, which matches the second audio stream. Therefore, it would select the ac3 codec for the second audio stream. A stream specifier can match several streams, so that the option is applied to all of them. E.g. the stream specifier in "-b:a 128k" matches all audio streams. An empty stream specifier matches all streams. For example, "-codec copy" or "-codec: copy" would copy all the streams without reencoding. Possible forms of stream specifiers are: stream_index Matches the stream with this index. E.g. "-threads:1 4" would set the thread count for the second stream to 4. If stream_index is used as an additional stream specifier (see below), then it selects stream number stream_index from the matching streams. Stream numbering is based on the order of the streams as detected by libavformat except when a stream group specifier or program ID is also specified. In this case it is based on the ordering of the streams in the group or program. stream_type[:additional_stream_specifier] stream_type is one of following: 'v' or 'V' for video, 'a' for audio, 's' for subtitle, 'd' for data, and 't' for attachments. 'v' matches all video streams, 'V' only matches video streams which are not attached pictures, video thumbnails or cover arts. If additional_stream_specifier is used, then it matches streams which both have this type and match the additional_stream_specifier. Otherwise, it matches all streams of the specified type. g:group_specifier[:additional_stream_specifier] Matches streams which are in the group with the specifier group_specifier. if additional_stream_specifier is used, then it matches streams which both are part of the group and match the additional_stream_specifier. group_specifier may be one of the following: group_index Match the stream with this group index. #group_id or i:group_id Match the stream with this group id. p:program_id[:additional_stream_specifier] Matches streams which are in the program with the id program_id. If additional_stream_specifier is used, then it matches streams which both are part of the program and match the additional_stream_specifier. #stream_id or i:stream_id Match the stream by stream id (e.g. PID in MPEG-TS container). m:key[:value] Matches streams with the metadata tag key having the specified value. If value is not given, matches streams that contain the given tag with any value. u Matches streams with usable configuration, the codec must be defined and the essential information such as video dimension or audio sample rate must be present. Note that in ffmpeg, matching by metadata will only work properly for input files. Generic options These options are shared amongst the ff* tools. -L Show license. -h, -?, -help, --help [arg] Show help. An optional parameter may be specified to print help about a specific item. If no argument is specified, only basic (non advanced) tool options are shown. Possible values of arg are: long Print advanced tool options in addition to the basic tool options. full Print complete list of options, including shared and private options for encoders, decoders, demuxers, muxers, filters, etc. decoder=decoder_name Print detailed information about the decoder named decoder_name. Use the -decoders option to get a list of all decoders. encoder=encoder_name Print detailed information about the encoder named encoder_name. Use the -encoders option to get a list of all encoders. demuxer=demuxer_name Print detailed information about the demuxer named demuxer_name. Use the -formats option to get a list of all demuxers and muxers. muxer=muxer_name Print detailed information about the muxer named muxer_name. Use the -formats option to get a list of all muxers and demuxers. filter=filter_name Print detailed information about the filter named filter_name. Use the -filters option to get a list of all filters. bsf=bitstream_filter_name Print detailed information about the bitstream filter named bitstream_filter_name. Use the -bsfs option to get a list of all bitstream filters. protocol=protocol_name Print detailed information about the protocol named protocol_name. Use the -protocols option to get a list of all protocols. -version Show version. -buildconf Show the build configuration, one option per line. -formats Show available formats (including devices). -demuxers Show available demuxers. -muxers Show available muxers. -devices Show available devices. -codecs Show all codecs known to libavcodec. Note that the term 'codec' is used throughout this documentation as a shortcut for what is more correctly called a media bitstream format. -decoders Show available decoders. -encoders Show all available encoders. -bsfs Show available bitstream filters. -protocols Show available protocols. -filters Show available libavfilter filters. -pix_fmts Show available pixel formats. -sample_fmts Show available sample formats. -layouts Show channel names and standard channel layouts. -dispositions Show stream dispositions. -colors Show recognized color names. -sources device[,opt1=val1[,opt2=val2]...] Show autodetected sources of the input device. Some devices may provide system-dependent source names that cannot be autodetected. The returned list cannot be assumed to be always complete. ffmpeg -sources pulse,server=192.168.0.4 -sinks device[,opt1=val1[,opt2=val2]...] Show autodetected sinks of the output device. Some devices may provide system-dependent sink names that cannot be autodetected. The returned list cannot be assumed to be always complete. ffmpeg -sinks pulse,server=192.168.0.4 -loglevel [flags+]loglevel | -v [flags+]loglevel Set logging level and flags used by the library. The optional flags prefix can consist of the following values: repeat Indicates that repeated log output should not be compressed to the first line and the "Last message repeated n times" line will be omitted. level Indicates that log output should add a "[level]" prefix to each message line. This can be used as an alternative to log coloring, e.g. when dumping the log to file. Flags can also be used alone by adding a '+'/'-' prefix to set/reset a single flag without affecting other flags or changing loglevel. When setting both flags and loglevel, a '+' separator is expected between the last flags value and before loglevel. loglevel is a string or a number containing one of the following values: quiet, -8 Show nothing at all; be silent. panic, 0 Only show fatal errors which could lead the process to crash, such as an assertion failure. This is not currently used for anything. fatal, 8 Only show fatal errors. These are errors after which the process absolutely cannot continue. error, 16 Show all errors, including ones which can be recovered from. warning, 24 Show all warnings and errors. Any message related to possibly incorrect or unexpected events will be shown. info, 32 Show informative messages during processing. This is in addition to warnings and errors. This is the default value. verbose, 40 Same as "info", except more verbose. debug, 48 Show everything, including debugging information. trace, 56 For example to enable repeated log output, add the "level" prefix, and set loglevel to "verbose": ffmpeg -loglevel repeat+level+verbose -i input output Another example that enables repeated log output without affecting current state of "level" prefix flag or loglevel: ffmpeg [...] -loglevel +repeat By default the program logs to stderr. If coloring is supported by the terminal, colors are used to mark errors and warnings. Log coloring can be disabled setting the environment variable AV_LOG_FORCE_NOCOLOR, or can be forced setting the environment variable AV_LOG_FORCE_COLOR. -report Dump full command line and log output to a file named "program-YYYYMMDD-HHMMSS.log" in the current directory. This file can be useful for bug reports. It also implies "-loglevel debug". Setting the environment variable FFREPORT to any value has the same effect. If the value is a ':'-separated key=value sequence, these options will affect the report; option values must be escaped if they contain special characters or the options delimiter ':' (see the ``Quoting and escaping'' section in the ffmpeg-utils manual). The following options are recognized: file set the file name to use for the report; %p is expanded to the name of the program, %t is expanded to a timestamp, "%%" is expanded to a plain "%" level set the log verbosity level using a numerical value (see "-loglevel"). For example, to output a report to a file named ffreport.log using a log level of 32 (alias for log level "info"): FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output Errors in parsing the environment variable are not fatal, and will not appear in the report. -hide_banner Suppress printing banner. All FFmpeg tools will normally show a copyright notice, build options and library versions. This option can be used to suppress printing this information. -cpuflags flags (global) Allows setting and clearing cpu flags. This option is intended for testing. Do not use it unless you know what you're doing. ffmpeg -cpuflags -sse+mmx ... ffmpeg -cpuflags mmx ... ffmpeg -cpuflags 0 ... Possible flags for this option are: x86 mmx mmxext sse sse2 sse2slow sse3 sse3slow ssse3 atom sse4.1 sse4.2 avx avx2 xop fma3 fma4 3dnow 3dnowext bmi1 bmi2 cmov ARM armv5te armv6 armv6t2 vfp vfpv3 neon setend AArch64 armv8 vfp neon PowerPC altivec Specific Processors pentium2 pentium3 pentium4 k6 k62 athlon athlonxp k8 -cpucount count (global) Override detection of CPU count. This option is intended for testing. Do not use it unless you know what you're doing. ffmpeg -cpucount 2 -max_alloc bytes Set the maximum size limit for allocating a block on the heap by ffmpeg's family of malloc functions. Exercise extreme caution when using this option. Don't use if you do not understand the full consequence of doing so. Default is INT_MAX. AVOptions These options are provided directly by the libavformat, libavdevice and libavcodec libraries. To see the list of available AVOptions, use the -help option. They are separated into two categories: generic These options can be set for any container, codec or device. Generic options are listed under AVFormatContext options for containers/devices and under AVCodecContext options for codecs. private These options are specific to the given container, device or codec. Private options are listed under their corresponding containers/devices/codecs. For example to write an ID3v2.3 header instead of a default ID3v2.4 to an MP3 file, use the id3v2_version private option of the MP3 muxer: ffmpeg -i input.flac -id3v2_version 3 out.mp3 All codec AVOptions are per-stream, and thus a stream specifier should be attached to them: ffmpeg -i multichannel.mxf -map 0:v:0 -map 0:a:0 -map 0:a:0 -c:a:0 ac3 -b:a:0 640k -ac:a:1 2 -c:a:1 aac -b:2 128k out.mp4 In the above example, a multichannel audio stream is mapped twice for output. The first instance is encoded with codec ac3 and bitrate 640k. The second instance is downmixed to 2 channels and encoded with codec aac. A bitrate of 128k is specified for it using absolute index of the output stream. Note: the -nooption syntax cannot be used for boolean AVOptions, use -option 0/-option 1. Note: the old undocumented way of specifying per-stream AVOptions by prepending v/a/s to the options name is now obsolete and will be removed soon. Main options -x width Force displayed width. -y height Force displayed height. -fs Start in fullscreen mode. -an Disable audio. -vn Disable video. -sn Disable subtitles. -ss pos Seek to pos. Note that in most formats it is not possible to seek exactly, so ffplay will seek to the nearest seek point to pos. pos must be a time duration specification, see the Time duration section in the ffmpeg-utils(1) manual. -t duration Play duration seconds of audio/video. duration must be a time duration specification, see the Time duration section in the ffmpeg-utils(1) manual. -bytes Seek by bytes. -seek_interval Set custom interval, in seconds, for seeking using left/right keys. Default is 10 seconds. -nodisp Disable graphical display. -noborder Borderless window. -alwaysontop Window always on top. Available on: X11 with SDL >= 2.0.5, Windows SDL >= 2.0.6. -volume Set the startup volume. 0 means silence, 100 means no volume reduction or amplification. Negative values are treated as 0, values above 100 are treated as 100. -f fmt Force format. -window_title title Set window title (default is the input filename). -left title Set the x position for the left of the window (default is a centered window). -top title Set the y position for the top of the window (default is a centered window). -loop number Loops movie playback <number> times. 0 means forever. -showmode mode Set the show mode to use. Available values for mode are: 0, video show video 1, waves show audio waves 2, rdft show audio frequency band using RDFT ((Inverse) Real Discrete Fourier Transform) Default value is "video", if video is not present or cannot be played "rdft" is automatically selected. You can interactively cycle through the available show modes by pressing the key w. -vf filtergraph Create the filtergraph specified by filtergraph and use it to filter the video stream. filtergraph is a description of the filtergraph to apply to the stream, and must have a single video input and a single video output. In the filtergraph, the input is associated to the label "in", and the output to the label "out". See the ffmpeg-filters manual for more information about the filtergraph syntax. You can specify this parameter multiple times and cycle through the specified filtergraphs along with the show modes by pressing the key w. -af filtergraph filtergraph is a description of the filtergraph to apply to the input audio. Use the option "-filters" to show all the available filters (including sources and sinks). -i input_url Read input_url. Advanced options -stats Print several playback statistics, in particular show the stream duration, the codec parameters, the current position in the stream and the audio/video synchronisation drift. It is shown by default, unless the log level is lower than "info". Its display can be forced by manually specifying this option. To disable it, you need to specify "-nostats". -fast Non-spec-compliant optimizations. -genpts Generate pts. -sync type Set the master clock to audio ("type=audio"), video ("type=video") or external ("type=ext"). Default is audio. The master clock is used to control audio-video synchronization. Most media players use audio as master clock, but in some cases (streaming or high quality broadcast) it is necessary to change that. This option is mainly used for debugging purposes. -ast audio_stream_specifier Select the desired audio stream using the given stream specifier. The stream specifiers are described in the Stream specifiers chapter. If this option is not specified, the "best" audio stream is selected in the program of the already selected video stream. -vst video_stream_specifier Select the desired video stream using the given stream specifier. The stream specifiers are described in the Stream specifiers chapter. If this option is not specified, the "best" video stream is selected. -sst subtitle_stream_specifier Select the desired subtitle stream using the given stream specifier. The stream specifiers are described in the Stream specifiers chapter. If this option is not specified, the "best" subtitle stream is selected in the program of the already selected video or audio stream. -autoexit Exit when video is done playing. -exitonkeydown Exit if any key is pressed. -exitonmousedown Exit if any mouse button is pressed. -codec:media_specifier codec_name Force a specific decoder implementation for the stream identified by media_specifier, which can assume the values "a" (audio), "v" (video), and "s" subtitle. -acodec codec_name Force a specific audio decoder. -vcodec codec_name Force a specific video decoder. -scodec codec_name Force a specific subtitle decoder. -autorotate Automatically rotate the video according to file metadata. Enabled by default, use -noautorotate to disable it. -framedrop Drop video frames if video is out of sync. Enabled by default if the master clock is not set to video. Use this option to enable frame dropping for all master clock sources, use -noframedrop to disable it. -infbuf Do not limit the input buffer size, read as much data as possible from the input as soon as possible. Enabled by default for realtime streams, where data may be dropped if not read in time. Use this option to enable infinite buffers for all inputs, use -noinfbuf to disable it. -filter_threads nb_threads Defines how many threads are used to process a filter pipeline. Each pipeline will produce a thread pool with this many threads available for parallel processing. The default is 0 which means that the thread count will be determined by the number of available CPUs. -enable_vulkan Use vulkan renderer rather than SDL builtin renderer. Depends on libplacebo. -vulkan_params Vulkan configuration using a list of key=value pairs separated by ":". -hwaccel Use HW accelerated decoding. Enable this option will enable vulkan renderer automatically. While playing q, ESC Quit. f Toggle full screen. p, SPC Pause. m Toggle mute. 9, 0 /, * Decrease and increase volume respectively. a Cycle audio channel in the current program. v Cycle video channel. t Cycle subtitle channel in the current program. c Cycle program. w Cycle video filters or show modes. s Step to the next frame. Pause if the stream is not already paused, step to the next video frame, and pause. left/right Seek backward/forward 10 seconds. down/up Seek backward/forward 1 minute. page down/page up Seek to the previous/next chapter. or if there are no chapters Seek backward/forward 10 minutes. right mouse click Seek to percentage in file corresponding to fraction of width. left mouse double-click Toggle full screen. SEE ALSO ffplay-all(1), ffmpeg(1), ffprobe(1), ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1), ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1), ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1) AUTHORS The FFmpeg developers. For details about the authorship, see the Git history of the project (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command git log in the FFmpeg source directory, or browsing the online repository at <https://git.ffmpeg.org/ffmpeg>. Maintainers for the specific components are listed in the file MAINTAINERS in the source code tree. FFPLAY(1)
| null |
pyftmerge
| null | null | null | null | null |
ristreceiver
| null | null | null | null | null |
tstclnt
| null | null | null | null | null |
zipcmp
|
zipcmp compares the zip archives or directories archive1 and archive2 and checks if they contain the same files, comparing their names, uncompressed sizes, and CRCs. File order and compressed size differences are ignored. Supported options: -C Check consistency of archives. Results in an error if archive is inconsistent or not valid according to the zip specification. -h Display a short help message and exit. -i Compare names ignoring case distinctions. -p Enable paranoid checks. Compares extra fields, comments, and other meta data. (Automatically disabled if one of the archives is a directory.) These checks are skipped for files where the data differs. -q Quiet mode. Compare -v. -s Print a summary of how many files where added and removed. -t Test zip files by comparing the contents to their checksums. -V Display version information and exit. -v Verbose mode. Print details about differences to stdout. (This is the default.) EXIT STATUS zipcmp exits 0 if the two archives contain the same files, 1 if they differ, and >1 if an error occurred. SEE ALSO zipmerge(1), ziptool(1), libzip(3) HISTORY zipcmp was added in libzip 0.6. AUTHORS Dieter Baron <dillo@nih.at> and Thomas Klausner <tk@giga.or.at> macOS 14.5 March 19, 2022 macOS 14.5
|
zipcmp – compare contents of zip archives
|
zipcmp [-ChipqstVv] archive1 archive2
| null | null |
mysql_upgrade
|
Note The MySQL server performs the upgrade tasks previously handled by mysql_upgrade (for details, see Section 2.10.3, “What the MySQL Upgrade Process Upgrades”). Consequently, mysql_upgrade is unneeded and is deprecated; expect it to be removed in a future version of MySQL. Because mysql_upgrade no longer performs upgrade tasks, it exits with status 0 unconditionally. 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 MYSQL_UPGRADE(1)
|
mysql_upgrade - Deprecated; performs no tasks and exists with status 0
|
mysql_upgrade
| null | null |
mysqltest
| null | null | null | null | null |
rdjpgcom
|
rdjpgcom reads the named JPEG/JFIF file, or the standard input if no file is named, and prints any text comments found in the file on the standard output. The JPEG standard allows "comment" (COM) blocks to occur within a JPEG file. Although the standard doesn't actually define what COM blocks are for, they are widely used to hold user-supplied text strings. This lets you add annotations, titles, index terms, etc to your JPEG files, and later retrieve them as text. COM blocks do not interfere with the image stored in the JPEG file. The maximum size of a COM block is 64K, but you can have as many of them as you like in one JPEG file.
|
rdjpgcom - display text comments from a JPEG file
|
rdjpgcom [ -raw ] [ -verbose ] [ filename ]
|
-raw Normally rdjpgcom escapes non-printable characters in comments, for security reasons. This option avoids that. -verbose Causes rdjpgcom to also display the JPEG image dimensions. Switch names may be abbreviated, and are not case sensitive. HINTS rdjpgcom does not depend on the IJG JPEG library. Its source code is intended as an illustration of the minimum amount of code required to parse a JPEG file header correctly. In -verbose mode, rdjpgcom will also attempt to print the contents of any "APP12" markers as text. Some digital cameras produce APP12 markers containing useful textual information. If you like, you can modify the source code to print other APPn marker types as well. SEE ALSO cjpeg(1), djpeg(1), jpegtran(1), wrjpgcom(1) AUTHOR Independent JPEG Group 02 April 2009 RDJPGCOM(1)
| null |
python3.11-config
| null | null | null | null | null |
rbenv
| null | null | null | null | null |
sdl2-config
| null | null | null | null | null |
mysqld_safe
|
mysqld_safe is the recommended way to start a mysqld server on Unix. mysqld_safe adds some safety features such as restarting the server when an error occurs and logging runtime information to an error log. A description of error logging is given later in this section. 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_safe is not installed because it is unnecessary. For more information, see Section 2.5.9, “Managing MySQL Server with systemd”. One implication of the non-use of mysqld_safe on platforms that use systemd for server management is that use of [mysqld_safe] or [safe_mysqld] sections in option files is not supported and might lead to unexpected behavior. mysqld_safe tries to start an executable named mysqld. To override the default behavior and specify explicitly the name of the server you want to run, specify a --mysqld or --mysqld-version option to mysqld_safe. You can also use --ledir to indicate the directory where mysqld_safe should look for the server. Many of the options to mysqld_safe are the same as the options to mysqld. See Section 5.1.7, “Server Command Options”. Options unknown to mysqld_safe are passed to mysqld if they are specified on the command line, but ignored if they are specified in the [mysqld_safe] group of an option file. See Section 4.2.2.2, “Using Option Files”. mysqld_safe reads all options from the [mysqld], [server], and [mysqld_safe] sections in option files. For example, if you specify a [mysqld] section like this, mysqld_safe finds and uses the --log-error option: [mysqld] log-error=error.log For backward compatibility, mysqld_safe also reads [safe_mysqld] sections, but to be current you should rename such sections to [mysqld_safe]. mysqld_safe accepts options on the command line and in option files, as described in the following table. 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. • --basedir=dir_name ┌────────────────────┬────────────────────┐ │Command-Line Format │ --basedir=dir_name │ ├────────────────────┼────────────────────┤ │Type │ Directory name │ └────────────────────┴────────────────────┘ The path to the MySQL installation directory. • --core-file-size=size ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --core-file-size=size │ ├────────────────────┼───────────────────────┤ │Type │ String │ └────────────────────┴───────────────────────┘ The size of the core file that mysqld should be able to create. The option value is passed to ulimit -c. Note The innodb_buffer_pool_in_core_file variable can be used to reduce the size of core files on operating systems that support it. For more information, see Section 15.8.3.7, “Excluding Buffer Pool Pages from Core Files”. • --datadir=dir_name ┌────────────────────┬────────────────────┐ │Command-Line Format │ --datadir=dir_name │ ├────────────────────┼────────────────────┤ │Type │ Directory name │ └────────────────────┴────────────────────┘ The path to the data directory. • --defaults-extra-file=file_name ┌────────────────────┬─────────────────────────────────┐ │Command-Line Format │ --defaults-extra-file=file_name │ ├────────────────────┼─────────────────────────────────┤ │Type │ File name │ └────────────────────┴─────────────────────────────────┘ Read this option file in addition to the usual option files. If the file does not exist or is otherwise inaccessible, the server exits with an error. If file_name is not an absolute path name, it is interpreted relative to the current directory. This must be the first option on the command line if it is used. 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, the server exits with an error. If file_name is not an absolute path name, it is interpreted relative to the current directory. This must be the first option on the command line if it is used. For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --ledir=dir_name ┌────────────────────┬──────────────────┐ │Command-Line Format │ --ledir=dir_name │ ├────────────────────┼──────────────────┤ │Type │ Directory name │ └────────────────────┴──────────────────┘ If mysqld_safe cannot find the server, use this option to indicate the path name to the directory where the server is located. This option is accepted only on the command line, not in option files. On platforms that use systemd, the value can be specified in the value of MYSQLD_OPTS. See Section 2.5.9, “Managing MySQL Server with systemd”. • --log-error=file_name ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --log-error=file_name │ ├────────────────────┼───────────────────────┤ │Type │ File name │ └────────────────────┴───────────────────────┘ Write the error log to the given file. See Section 5.4.2, “The Error Log”. • --mysqld-safe-log-timestamps ┌────────────────────┬───────────────────────────────────┐ │Command-Line Format │ --mysqld-safe-log-timestamps=type │ ├────────────────────┼───────────────────────────────────┤ │Type │ Enumeration │ ├────────────────────┼───────────────────────────────────┤ │Default Value │ utc │ ├────────────────────┼───────────────────────────────────┤ │Valid Values │ system hyphen legacy │ └────────────────────┴───────────────────────────────────┘ This option controls the format for timestamps in log output produced by mysqld_safe. The following list describes the permitted values. For any other value, mysqld_safe logs a warning and uses UTC format. • UTC, utc ISO 8601 UTC format (same as --log_timestamps=UTC for the server). This is the default. • SYSTEM, system ISO 8601 local time format (same as --log_timestamps=SYSTEM for the server). • HYPHEN, hyphen YY-MM-DD h:mm:ss format, as in mysqld_safe for MySQL 5.6. • LEGACY, legacy YYMMDD hh:mm:ss format, as in mysqld_safe prior to MySQL 5.6. • --malloc-lib=[lib_name] ┌────────────────────┬─────────────────────────┐ │Command-Line Format │ --malloc-lib=[lib-name] │ ├────────────────────┼─────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────┘ The name of the library to use for memory allocation instead of the system malloc() library. The option value must be one of the directories /usr/lib, /usr/lib64, /usr/lib/i386-linux-gnu, or /usr/lib/x86_64-linux-gnu. The --malloc-lib option works by modifying the LD_PRELOAD environment value to affect dynamic linking to enable the loader to find the memory-allocation library when mysqld runs: • If the option is not given, or is given without a value (--malloc-lib=), LD_PRELOAD is not modified and no attempt is made to use tcmalloc. • Prior to MySQL 8.0.21, if the option is given as --malloc-lib=tcmalloc, mysqld_safe looks for a tcmalloc library in /usr/lib. If tmalloc is found, its path name is added to the beginning of the LD_PRELOAD value for mysqld. If tcmalloc is not found, mysqld_safe aborts with an error. As of MySQL 8.0.21, tcmalloc is not a permitted value for the --malloc-lib option. • If the option is given as --malloc-lib=/path/to/some/library, that full path is added to the beginning of the LD_PRELOAD value. If the full path points to a nonexistent or unreadable file, mysqld_safe aborts with an error. • For cases where mysqld_safe adds a path name to LD_PRELOAD, it adds the path to the beginning of any existing value the variable already has. Note On systems that manage the server using systemd, mysqld_safe is not available. Instead, specify the allocation library by setting LD_PRELOAD in /etc/sysconfig/mysql. Linux users can use the libtcmalloc_minimal.so library on any platform for which a tcmalloc package is installed in /usr/lib by adding these lines to the my.cnf file: [mysqld_safe] malloc-lib=tcmalloc To use a specific tcmalloc library, specify its full path name. Example: [mysqld_safe] malloc-lib=/opt/lib/libtcmalloc_minimal.so • --mysqld=prog_name ┌────────────────────┬────────────────────┐ │Command-Line Format │ --mysqld=file_name │ ├────────────────────┼────────────────────┤ │Type │ File name │ └────────────────────┴────────────────────┘ The name of the server program (in the ledir directory) that you want to start. This option is needed if you use the MySQL binary distribution but have the data directory outside of the binary distribution. If mysqld_safe cannot find the server, use the --ledir option to indicate the path name to the directory where the server is located. This option is accepted only on the command line, not in option files. On platforms that use systemd, the value can be specified in the value of MYSQLD_OPTS. See Section 2.5.9, “Managing MySQL Server with systemd”. • --mysqld-version=suffix ┌────────────────────┬─────────────────────────┐ │Command-Line Format │ --mysqld-version=suffix │ ├────────────────────┼─────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────┘ This option is similar to the --mysqld option, but you specify only the suffix for the server program name. The base name is assumed to be mysqld. For example, if you use --mysqld-version=debug, mysqld_safe starts the mysqld-debug program in the ledir directory. If the argument to --mysqld-version is empty, mysqld_safe uses mysqld in the ledir directory. This option is accepted only on the command line, not in option files. On platforms that use systemd, the value can be specified in the value of MYSQLD_OPTS. See Section 2.5.9, “Managing MySQL Server with systemd”. • --nice=priority ┌────────────────────┬─────────────────┐ │Command-Line Format │ --nice=priority │ ├────────────────────┼─────────────────┤ │Type │ Numeric │ └────────────────────┴─────────────────┘ Use the nice program to set the server's scheduling priority to the given value. • --no-defaults ┌────────────────────┬───────────────┐ │Command-Line Format │ --no-defaults │ ├────────────────────┼───────────────┤ │Type │ String │ └────────────────────┴───────────────┘ 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. This must be the first option on the command line if it is used. For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --open-files-limit=count ┌────────────────────┬──────────────────────────┐ │Command-Line Format │ --open-files-limit=count │ ├────────────────────┼──────────────────────────┤ │Type │ String │ └────────────────────┴──────────────────────────┘ The number of files that mysqld should be able to open. The option value is passed to ulimit -n. Note You must start mysqld_safe as root for this to function properly. • --pid-file=file_name ┌────────────────────┬──────────────────────┐ │Command-Line Format │ --pid-file=file_name │ ├────────────────────┼──────────────────────┤ │Type │ File name │ └────────────────────┴──────────────────────┘ The path name that mysqld should use for its process ID file. • --plugin-dir=dir_name ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --plugin-dir=dir_name │ ├────────────────────┼───────────────────────┤ │Type │ Directory name │ └────────────────────┴───────────────────────┘ The path name of the plugin directory. • --port=port_num ┌────────────────────┬───────────────┐ │Command-Line Format │ --port=number │ ├────────────────────┼───────────────┤ │Type │ Numeric │ └────────────────────┴───────────────┘ The port number that the server should use when listening for TCP/IP connections. The port number must be 1024 or higher unless the server is started by the root operating system user. • --skip-kill-mysqld ┌────────────────────┬────────────────────┐ │Command-Line Format │ --skip-kill-mysqld │ └────────────────────┴────────────────────┘ Do not try to kill stray mysqld processes at startup. This option works only on Linux. • --socket=path ┌────────────────────┬────────────────────┐ │Command-Line Format │ --socket=file_name │ ├────────────────────┼────────────────────┤ │Type │ File name │ └────────────────────┴────────────────────┘ The Unix socket file that the server should use when listening for local connections. • --syslog, --skip-syslog ┌────────────────────┬──────────┐ │Command-Line Format │ --syslog │ ├────────────────────┼──────────┤ │Deprecated │ Yes │ └────────────────────┴──────────┘ ┌────────────────────┬───────────────┐ │Command-Line Format │ --skip-syslog │ ├────────────────────┼───────────────┤ │Deprecated │ Yes │ └────────────────────┴───────────────┘ --syslog causes error messages to be sent to syslog on systems that support the logger program. --skip-syslog suppresses the use of syslog; messages are written to an error log file. When syslog is used for error logging, the daemon.err facility/severity is used for all log messages. Using these options to control mysqld logging is deprecated. To write error log output to the system log, use the instructions at Section 5.4.2.8, “Error Logging to the System Log”. To control the facility, use the server log_syslog_facility system variable. • --syslog-tag=tag ┌────────────────────┬──────────────────┐ │Command-Line Format │ --syslog-tag=tag │ ├────────────────────┼──────────────────┤ │Deprecated │ Yes │ └────────────────────┴──────────────────┘ For logging to syslog, messages from mysqld_safe and mysqld are written with identifiers of mysqld_safe and mysqld, respectively. To specify a suffix for the identifiers, use --syslog-tag=tag, which modifies the identifiers to be mysqld_safe-tag and mysqld-tag. Using this option to control mysqld logging is deprecated. Use the server log_syslog_tag system variable instead. See Section 5.4.2.8, “Error Logging to the System Log”. • --timezone=timezone ┌────────────────────┬─────────────────────┐ │Command-Line Format │ --timezone=timezone │ ├────────────────────┼─────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────┘ Set the TZ time zone environment variable to the given option value. Consult your operating system documentation for legal time zone specification formats. • --user={user_name|user_id} ┌────────────────────┬────────────────────────────┐ │Command-Line Format │ --user={user_name|user_id} │ ├────────────────────┼────────────────────────────┤ │Type │ String │ ├────────────────────┼────────────────────────────┤ │Type │ Numeric │ └────────────────────┴────────────────────────────┘ Run the mysqld server as the user having the name user_name or the numeric user ID user_id. (“User” in this context refers to a system login account, not a MySQL user listed in the grant tables.) If you execute mysqld_safe with the --defaults-file or --defaults-extra-file option to name an option file, the option must be the first one given on the command line or the option file is not used. For example, this command does not use the named option file: mysql> mysqld_safe --port=port_num --defaults-file=file_name Instead, use the following command: mysql> mysqld_safe --defaults-file=file_name --port=port_num The mysqld_safe script is written so that it normally can start a server that was installed from either a source or a binary distribution of MySQL, even though these types of distributions typically install the server in slightly different locations. (See Section 2.1.5, “Installation Layouts”.) mysqld_safe expects one of the following conditions to be true: • The server and databases can be found relative to the working directory (the directory from which mysqld_safe is invoked). For binary distributions, mysqld_safe looks under its working directory for bin and data directories. For source distributions, it looks for libexec and var directories. This condition should be met if you execute mysqld_safe from your MySQL installation directory (for example, /usr/local/mysql for a binary distribution). • If the server and databases cannot be found relative to the working directory, mysqld_safe attempts to locate them by absolute path names. Typical locations are /usr/local/libexec and /usr/local/var. The actual locations are determined from the values configured into the distribution at the time it was built. They should be correct if MySQL is installed in the location specified at configuration time. Because mysqld_safe tries to find the server and databases relative to its own working directory, you can install a binary distribution of MySQL anywhere, as long as you run mysqld_safe from the MySQL installation directory: cd mysql_installation_directory bin/mysqld_safe & If mysqld_safe fails, even when invoked from the MySQL installation directory, specify the --ledir and --datadir options to indicate the directories in which the server and databases are located on your system. mysqld_safe tries to use the sleep and date system utilities to determine how many times per second it has attempted to start. If these utilities are present and the attempted starts per second is greater than 5, mysqld_safe waits 1 full second before starting again. This is intended to prevent excessive CPU usage in the event of repeated failures. (Bug #11761530, Bug #54035) When you use mysqld_safe to start mysqld, mysqld_safe arranges for error (and notice) messages from itself and from mysqld to go to the same destination. There are several mysqld_safe options for controlling the destination of these messages: • --log-error=file_name: Write error messages to the named error file. • --syslog: Write error messages to syslog on systems that support the logger program. • --skip-syslog: Do not write error messages to syslog. Messages are written to the default error log file (host_name.err in the data directory), or to a named file if the --log-error option is given. If none of these options is given, the default is --skip-syslog. When mysqld_safe writes a message, notices go to the logging destination (syslog or the error log file) and stdout. Errors go to the logging destination and stderr. Note Controlling mysqld logging from mysqld_safe is deprecated. Use the server's native syslog support instead. For more information, see Section 5.4.2.8, “Error Logging to the System Log”. 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_SAFE(1)
|
mysqld_safe - MySQL server startup script
|
mysqld_safe options
| null | null |
automake
| null | null | null | null | null |
phpdbg
|
phpdbg is a lightweight, powerful, easy to use debugging platform for PHP.
|
phpdbg - The interactive PHP debugger
|
phpdbg [options] [file] [args...]
|
-c path|file Look for php.ini file in the directory path or use the specified file -d foo[=bar] Define INI entry foo with value bar -n No php.ini file will be used -z file Load Zend extension file -q Do not print banner on startup -v Enable oplog output -b Disables use of color on the console -i path|file Override .phpgdbinit location (implies -I) -I Ignore .phpdbginit (default init file) -r Jump straight to run -e Generate extended information for debugger/profiler -E Enable step through eval() -s delimiter Read code to execute from stdin with an optional delimiter -S sapi_name Override SAPI name -p opcode Output opcodes and quit -h Print the help overview -V Version number args... Arguments passed to script. Use '--' args when first argument starts with '-' or script is read from stdin NOTES Passing -rr will cause phpdbg to quit after execution, rather than returning to the console FILES php.ini The standard configuration file .phpdbginit The init file SEE ALSO The online manual can be found at http://php.net/manual/book.phpdbg.php 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 Written by Felipe Pena, Joe Watkins and Bob Weinand, formatted by Ondřej Surý for Debian project. A List of active developers can be found at 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 phpdbg, for PHP 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 phpdbg(1)
| null |
ristsrppasswd
| null | null | null | null | null |
lzegrep
|
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 |
git
|
Git is a fast, scalable, distributed revision control system with an unusually rich command set that provides both high-level operations and full access to internals. See gittutorial(7) to get started, then see giteveryday(7) for a useful minimum set of commands. The Git User’s Manual[1] has a more in-depth introduction. After you mastered the basic concepts, you can come back to this page to learn what commands Git offers. You can learn more about individual Git commands with "git help command". gitcli(7) manual page gives you an overview of the command-line command syntax. A formatted and hyperlinked copy of the latest Git documentation can be viewed at https://git.github.io/htmldocs/git.html or https://git-scm.com/docs.
|
git - the stupid content tracker
|
git [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>] [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path] [-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare] [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>] [--config-env=<name>=<envvar>] <command> [<args>]
|
-v, --version Prints the Git suite version that the git program came from. This option is internally converted to git version ... and accepts the same options as the git-version(1) command. If --help is also given, it takes precedence over --version. -h, --help Prints the synopsis and a list of the most commonly used commands. If the option --all or -a is given then all available commands are printed. If a Git command is named this option will bring up the manual page for that command. Other options are available to control how the manual page is displayed. See git-help(1) for more information, because git --help ... is converted internally into git help .... -C <path> Run as if git was started in <path> instead of the current working directory. When multiple -C options are given, each subsequent non-absolute -C <path> is interpreted relative to the preceding -C <path>. If <path> is present but empty, e.g. -C "", then the current working directory is left unchanged. This option affects options that expect path name like --git-dir and --work-tree in that their interpretations of the path names would be made relative to the working directory caused by the -C option. For example the following invocations are equivalent: git --git-dir=a.git --work-tree=b -C c status git --git-dir=c/a.git --work-tree=c/b status -c <name>=<value> Pass a configuration parameter to the command. The value given will override values from configuration files. The <name> is expected in the same format as listed by git config (subkeys separated by dots). Note that omitting the = in git -c foo.bar ... is allowed and sets foo.bar to the boolean true value (just like [foo]bar would in a config file). Including the equals but with an empty value (like git -c foo.bar= ...) sets foo.bar to the empty string which git config --type=bool will convert to false. --config-env=<name>=<envvar> Like -c <name>=<value>, give configuration variable <name> a value, where <envvar> is the name of an environment variable from which to retrieve the value. Unlike -c there is no shortcut for directly setting the value to an empty string, instead the environment variable itself must be set to the empty string. It is an error if the <envvar> does not exist in the environment. <envvar> may not contain an equals sign to avoid ambiguity with <name> containing one. This is useful for cases where you want to pass transitory configuration options to git, but are doing so on OS’s where other processes might be able to read your cmdline (e.g. /proc/self/cmdline), but not your environ (e.g. /proc/self/environ). That behavior is the default on Linux, but may not be on your system. Note that this might add security for variables such as http.extraHeader where the sensitive information is part of the value, but not e.g. url.<base>.insteadOf where the sensitive information can be part of the key. --exec-path[=<path>] Path to wherever your core Git programs are installed. This can also be controlled by setting the GIT_EXEC_PATH environment variable. If no path is given, git will print the current setting and then exit. --html-path Print the path, without trailing slash, where Git’s HTML documentation is installed and exit. --man-path Print the manpath (see man(1)) for the man pages for this version of Git and exit. --info-path Print the path where the Info files documenting this version of Git are installed and exit. -p, --paginate Pipe all output into less (or if set, $PAGER) if standard output is a terminal. This overrides the pager.<cmd> configuration options (see the "Configuration Mechanism" section below). -P, --no-pager Do not pipe Git output into a pager. --git-dir=<path> Set the path to the repository (".git" directory). This can also be controlled by setting the GIT_DIR environment variable. It can be an absolute path or relative path to current working directory. Specifying the location of the ".git" directory using this option (or GIT_DIR environment variable) turns off the repository discovery that tries to find a directory with ".git" subdirectory (which is how the repository and the top-level of the working tree are discovered), and tells Git that you are at the top level of the working tree. If you are not at the top-level directory of the working tree, you should tell Git where the top-level of the working tree is, with the --work-tree=<path> option (or GIT_WORK_TREE environment variable) If you just want to run git as if it was started in <path> then use git -C <path>. --work-tree=<path> Set the path to the working tree. It can be an absolute path or a path relative to the current working directory. This can also be controlled by setting the GIT_WORK_TREE environment variable and the core.worktree configuration variable (see core.worktree in git- config(1) for a more detailed discussion). --namespace=<path> Set the Git namespace. See gitnamespaces(7) for more details. Equivalent to setting the GIT_NAMESPACE environment variable. --bare Treat the repository as a bare repository. If GIT_DIR environment is not set, it is set to the current working directory. --no-replace-objects Do not use replacement refs to replace Git objects. See git- replace(1) for more information. --literal-pathspecs Treat pathspecs literally (i.e. no globbing, no pathspec magic). This is equivalent to setting the GIT_LITERAL_PATHSPECS environment variable to 1. --glob-pathspecs Add "glob" magic to all pathspec. This is equivalent to setting the GIT_GLOB_PATHSPECS environment variable to 1. Disabling globbing on individual pathspecs can be done using pathspec magic ":(literal)" --noglob-pathspecs Add "literal" magic to all pathspec. This is equivalent to setting the GIT_NOGLOB_PATHSPECS environment variable to 1. Enabling globbing on individual pathspecs can be done using pathspec magic ":(glob)" --icase-pathspecs Add "icase" magic to all pathspec. This is equivalent to setting the GIT_ICASE_PATHSPECS environment variable to 1. --no-optional-locks Do not perform optional operations that require locks. This is equivalent to setting the GIT_OPTIONAL_LOCKS to 0. --list-cmds=group[,group...] List commands by group. This is an internal/experimental option and may change or be removed in the future. Supported groups are: builtins, parseopt (builtin commands that use parse-options), main (all commands in libexec directory), others (all other commands in $PATH that have git- prefix), list-<category> (see categories in command-list.txt), nohelpers (exclude helper commands), alias and config (retrieve command list from config variable completion.commands) --attr-source=<tree-ish> Read gitattributes from <tree-ish> instead of the worktree. See gitattributes(5). This is equivalent to setting the GIT_ATTR_SOURCE environment variable. GIT COMMANDS We divide Git into high level ("porcelain") commands and low level ("plumbing") commands. HIGH-LEVEL COMMANDS (PORCELAIN) We separate the porcelain commands into the main commands and some ancillary user utilities. Main porcelain commands git-add(1) Add file contents to the index. git-am(1) Apply a series of patches from a mailbox. git-archive(1) Create an archive of files from a named tree. git-bisect(1) Use binary search to find the commit that introduced a bug. git-branch(1) List, create, or delete branches. git-bundle(1) Move objects and refs by archive. git-checkout(1) Switch branches or restore working tree files. git-cherry-pick(1) Apply the changes introduced by some existing commits. git-citool(1) Graphical alternative to git-commit. git-clean(1) Remove untracked files from the working tree. git-clone(1) Clone a repository into a new directory. git-commit(1) Record changes to the repository. git-describe(1) Give an object a human readable name based on an available ref. git-diff(1) Show changes between commits, commit and working tree, etc. git-fetch(1) Download objects and refs from another repository. git-format-patch(1) Prepare patches for e-mail submission. git-gc(1) Cleanup unnecessary files and optimize the local repository. git-grep(1) Print lines matching a pattern. git-gui(1) A portable graphical interface to Git. git-init(1) Create an empty Git repository or reinitialize an existing one. git-log(1) Show commit logs. git-maintenance(1) Run tasks to optimize Git repository data. git-merge(1) Join two or more development histories together. git-mv(1) Move or rename a file, a directory, or a symlink. git-notes(1) Add or inspect object notes. git-pull(1) Fetch from and integrate with another repository or a local branch. git-push(1) Update remote refs along with associated objects. git-range-diff(1) Compare two commit ranges (e.g. two versions of a branch). git-rebase(1) Reapply commits on top of another base tip. git-reset(1) Reset current HEAD to the specified state. git-restore(1) Restore working tree files. git-revert(1) Revert some existing commits. git-rm(1) Remove files from the working tree and from the index. git-shortlog(1) Summarize git log output. git-show(1) Show various types of objects. git-sparse-checkout(1) Reduce your working tree to a subset of tracked files. git-stash(1) Stash the changes in a dirty working directory away. git-status(1) Show the working tree status. git-submodule(1) Initialize, update or inspect submodules. git-switch(1) Switch branches. git-tag(1) Create, list, delete or verify a tag object signed with GPG. git-worktree(1) Manage multiple working trees. gitk(1) The Git repository browser. scalar(1) A tool for managing large Git repositories. Ancillary Commands Manipulators: git-config(1) Get and set repository or global options. git-fast-export(1) Git data exporter. git-fast-import(1) Backend for fast Git data importers. git-filter-branch(1) Rewrite branches. git-mergetool(1) Run merge conflict resolution tools to resolve merge conflicts. git-pack-refs(1) Pack heads and tags for efficient repository access. git-prune(1) Prune all unreachable objects from the object database. git-reflog(1) Manage reflog information. git-remote(1) Manage set of tracked repositories. git-repack(1) Pack unpacked objects in a repository. git-replace(1) Create, list, delete refs to replace objects. Interrogators: git-annotate(1) Annotate file lines with commit information. git-blame(1) Show what revision and author last modified each line of a file. git-bugreport(1) Collect information for user to file a bug report. git-count-objects(1) Count unpacked number of objects and their disk consumption. git-diagnose(1) Generate a zip archive of diagnostic information. git-difftool(1) Show changes using common diff tools. git-fsck(1) Verifies the connectivity and validity of the objects in the database. git-help(1) Display help information about Git. git-instaweb(1) Instantly browse your working repository in gitweb. git-merge-tree(1) Perform merge without touching index or working tree. git-rerere(1) Reuse recorded resolution of conflicted merges. git-show-branch(1) Show branches and their commits. git-verify-commit(1) Check the GPG signature of commits. git-verify-tag(1) Check the GPG signature of tags. git-version(1) Display version information about Git. git-whatchanged(1) Show logs with difference each commit introduces. gitweb(1) Git web interface (web frontend to Git repositories). Interacting with Others These commands are to interact with foreign SCM and with other people via patch over e-mail. git-archimport(1) Import a GNU Arch repository into Git. git-cvsexportcommit(1) Export a single commit to a CVS checkout. git-cvsimport(1) Salvage your data out of another SCM people love to hate. git-cvsserver(1) A CVS server emulator for Git. git-imap-send(1) Send a collection of patches from stdin to an IMAP folder. git-p4(1) Import from and submit to Perforce repositories. git-quiltimport(1) Applies a quilt patchset onto the current branch. git-request-pull(1) Generates a summary of pending changes. git-send-email(1) Send a collection of patches as emails. git-svn(1) Bidirectional operation between a Subversion repository and Git. Reset, restore and revert There are three commands with similar names: git reset, git restore and git revert. • git-revert(1) is about making a new commit that reverts the changes made by other commits. • git-restore(1) is about restoring files in the working tree from either the index or another commit. This command does not update your branch. The command can also be used to restore files in the index from another commit. • git-reset(1) is about updating your branch, moving the tip in order to add or remove commits from the branch. This operation changes the commit history. git reset can also be used to restore the index, overlapping with git restore. LOW-LEVEL COMMANDS (PLUMBING) Although Git includes its own porcelain layer, its low-level commands are sufficient to support development of alternative porcelains. Developers of such porcelains might start by reading about git-update- index(1) and git-read-tree(1). The interface (input, output, set of options and the semantics) to these low-level commands are meant to be a lot more stable than Porcelain level commands, because these commands are primarily for scripted use. The interface to Porcelain commands on the other hand are subject to change in order to improve the end user experience. The following description divides the low-level commands into commands that manipulate objects (in the repository, index, and working tree), commands that interrogate and compare objects, and commands that move objects and references between repositories. Manipulation commands git-apply(1) Apply a patch to files and/or to the index. git-checkout-index(1) Copy files from the index to the working tree. git-commit-graph(1) Write and verify Git commit-graph files. git-commit-tree(1) Create a new commit object. git-hash-object(1) Compute object ID and optionally creates a blob from a file. git-index-pack(1) Build pack index file for an existing packed archive. git-merge-file(1) Run a three-way file merge. git-merge-index(1) Run a merge for files needing merging. git-mktag(1) Creates a tag object with extra validation. git-mktree(1) Build a tree-object from ls-tree formatted text. git-multi-pack-index(1) Write and verify multi-pack-indexes. git-pack-objects(1) Create a packed archive of objects. git-prune-packed(1) Remove extra objects that are already in pack files. git-read-tree(1) Reads tree information into the index. git-symbolic-ref(1) Read, modify and delete symbolic refs. git-unpack-objects(1) Unpack objects from a packed archive. git-update-index(1) Register file contents in the working tree to the index. git-update-ref(1) Update the object name stored in a ref safely. git-write-tree(1) Create a tree object from the current index. Interrogation commands git-cat-file(1) Provide content or type and size information for repository objects. git-cherry(1) Find commits yet to be applied to upstream. git-diff-files(1) Compares files in the working tree and the index. git-diff-index(1) Compare a tree to the working tree or index. git-diff-tree(1) Compares the content and mode of blobs found via two tree objects. git-for-each-ref(1) Output information on each ref. git-for-each-repo(1) Run a Git command on a list of repositories. git-get-tar-commit-id(1) Extract commit ID from an archive created using git-archive. git-ls-files(1) Show information about files in the index and the working tree. git-ls-remote(1) List references in a remote repository. git-ls-tree(1) List the contents of a tree object. git-merge-base(1) Find as good common ancestors as possible for a merge. git-name-rev(1) Find symbolic names for given revs. git-pack-redundant(1) Find redundant pack files. git-rev-list(1) Lists commit objects in reverse chronological order. git-rev-parse(1) Pick out and massage parameters. git-show-index(1) Show packed archive index. git-show-ref(1) List references in a local repository. git-unpack-file(1) Creates a temporary file with a blob’s contents. git-var(1) Show a Git logical variable. git-verify-pack(1) Validate packed Git archive files. In general, the interrogate commands do not touch the files in the working tree. Syncing repositories git-daemon(1) A really simple server for Git repositories. git-fetch-pack(1) Receive missing objects from another repository. git-http-backend(1) Server side implementation of Git over HTTP. git-send-pack(1) Push objects over Git protocol to another repository. git-update-server-info(1) Update auxiliary info file to help dumb servers. The following are helper commands used by the above; end users typically do not use them directly. git-http-fetch(1) Download from a remote Git repository via HTTP. git-http-push(1) Push objects over HTTP/DAV to another repository. git-receive-pack(1) Receive what is pushed into the repository. git-shell(1) Restricted login shell for Git-only SSH access. git-upload-archive(1) Send archive back to git-archive. git-upload-pack(1) Send objects packed back to git-fetch-pack. Internal helper commands These are internal helper commands used by other commands; end users typically do not use them directly. git-check-attr(1) Display gitattributes information. git-check-ignore(1) Debug gitignore / exclude files. git-check-mailmap(1) Show canonical names and email addresses of contacts. git-check-ref-format(1) Ensures that a reference name is well formed. git-column(1) Display data in columns. git-credential(1) Retrieve and store user credentials. git-credential-cache(1) Helper to temporarily store passwords in memory. git-credential-store(1) Helper to store credentials on disk. git-fmt-merge-msg(1) Produce a merge commit message. git-hook(1) Run git hooks. git-interpret-trailers(1) Add or parse structured information in commit messages. git-mailinfo(1) Extracts patch and authorship from a single e-mail message. git-mailsplit(1) Simple UNIX mbox splitter program. git-merge-one-file(1) The standard helper program to use with git-merge-index. git-patch-id(1) Compute unique ID for a patch. git-sh-i18n(1) Git’s i18n setup code for shell scripts. git-sh-setup(1) Common Git shell script setup code. git-stripspace(1) Remove unnecessary whitespace. GUIDES The following documentation pages are guides about Git concepts. gitcore-tutorial(7) A Git core tutorial for developers. gitcredentials(7) Providing usernames and passwords to Git. gitcvs-migration(7) Git for CVS users. gitdiffcore(7) Tweaking diff output. giteveryday(7) A useful minimum set of commands for Everyday Git. gitfaq(7) Frequently asked questions about using Git. gitglossary(7) A Git Glossary. gitnamespaces(7) Git namespaces. gitremote-helpers(7) Helper programs to interact with remote repositories. gitsubmodules(7) Mounting one repository inside another. gittutorial(7) A tutorial introduction to Git. gittutorial-2(7) A tutorial introduction to Git: part two. gitworkflows(7) An overview of recommended workflows with Git. REPOSITORY, COMMAND AND FILE INTERFACES This documentation discusses repository and command interfaces which users are expected to interact with directly. See --user-formats in git-help(1) for more details on the criteria. gitattributes(5) Defining attributes per path. gitcli(7) Git command-line interface and conventions. githooks(5) Hooks used by Git. gitignore(5) Specifies intentionally untracked files to ignore. gitmailmap(5) Map author/committer names and/or E-Mail addresses. gitmodules(5) Defining submodule properties. gitrepository-layout(5) Git Repository Layout. gitrevisions(7) Specifying revisions and ranges for Git. FILE FORMATS, PROTOCOLS AND OTHER DEVELOPER INTERFACES This documentation discusses file formats, over-the-wire protocols and other git developer interfaces. See --developer-interfaces in git- help(1). gitformat-bundle(5) The bundle file format. gitformat-chunk(5) Chunk-based file formats. gitformat-commit-graph(5) Git commit-graph format. gitformat-index(5) Git index format. gitformat-pack(5) Git pack format. gitformat-signature(5) Git cryptographic signature formats. gitprotocol-capabilities(5) Protocol v0 and v1 capabilities. gitprotocol-common(5) Things common to various protocols. gitprotocol-http(5) Git HTTP-based protocols. gitprotocol-pack(5) How packs are transferred over-the-wire. gitprotocol-v2(5) Git Wire Protocol, Version 2. CONFIGURATION MECHANISM Git uses a simple text format to store customizations that are per repository and are per user. Such a configuration file may look like this: # # A '#' or ';' character indicates a comment. # ; core variables [core] ; Don't trust file modes filemode = false ; user identity [user] name = "Junio C Hamano" email = "gitster@pobox.com" Various commands read from the configuration file and adjust their operation accordingly. See git-config(1) for a list and more details about the configuration mechanism. IDENTIFIER TERMINOLOGY <object> Indicates the object name for any type of object. <blob> Indicates a blob object name. <tree> Indicates a tree object name. <commit> Indicates a commit object name. <tree-ish> Indicates a tree, commit or tag object name. A command that takes a <tree-ish> argument ultimately wants to operate on a <tree> object but automatically dereferences <commit> and <tag> objects that point at a <tree>. <commit-ish> Indicates a commit or tag object name. A command that takes a <commit-ish> argument ultimately wants to operate on a <commit> object but automatically dereferences <tag> objects that point at a <commit>. <type> Indicates that an object type is required. Currently one of: blob, tree, commit, or tag. <file> Indicates a filename - almost always relative to the root of the tree structure GIT_INDEX_FILE describes. SYMBOLIC IDENTIFIERS Any Git command accepting any <object> can also use the following symbolic notation: HEAD indicates the head of the current branch. <tag> a valid tag name (i.e. a refs/tags/<tag> reference). <head> a valid head name (i.e. a refs/heads/<head> reference). For a more complete list of ways to spell object names, see "SPECIFYING REVISIONS" section in gitrevisions(7). FILE/DIRECTORY STRUCTURE Please see the gitrepository-layout(5) document. Read githooks(5) for more details about each hook. Higher level SCMs may provide and manage additional information in the $GIT_DIR. TERMINOLOGY Please see gitglossary(7). ENVIRONMENT VARIABLES Various Git commands pay attention to environment variables and change their behavior. The environment variables marked as "Boolean" take their values the same way as Boolean valued configuration variables, e.g. "true", "yes", "on" and positive numbers are taken as "yes". Here are the variables: The Git Repository These environment variables apply to all core Git commands. Nb: it is worth noting that they may be used/overridden by SCMS sitting above Git so take care if using a foreign front-end. GIT_INDEX_FILE This environment variable specifies an alternate index file. If not specified, the default of $GIT_DIR/index is used. GIT_INDEX_VERSION This environment variable specifies what index version is used when writing the index file out. It won’t affect existing index files. By default index file version 2 or 3 is used. See git-update- index(1) for more information. GIT_OBJECT_DIRECTORY If the object storage directory is specified via this environment variable then the sha1 directories are created underneath - otherwise the default $GIT_DIR/objects directory is used. GIT_ALTERNATE_OBJECT_DIRECTORIES Due to the immutable nature of Git objects, old objects can be archived into shared, read-only directories. This variable specifies a ":" separated (on Windows ";" separated) list of Git object directories which can be used to search for Git objects. New objects will not be written to these directories. Entries that begin with " (double-quote) will be interpreted as C-style quoted paths, removing leading and trailing double-quotes and respecting backslash escapes. E.g., the value "path-with-\"-and-:-in-it":vanilla-path has two paths: path-with-"-and-:-in-it and vanilla-path. GIT_DIR If the GIT_DIR environment variable is set then it specifies a path to use instead of the default .git for the base of the repository. The --git-dir command-line option also sets this value. GIT_WORK_TREE Set the path to the root of the working tree. This can also be controlled by the --work-tree command-line option and the core.worktree configuration variable. GIT_NAMESPACE Set the Git namespace; see gitnamespaces(7) for details. The --namespace command-line option also sets this value. GIT_CEILING_DIRECTORIES This should be a colon-separated list of absolute paths. If set, it is a list of directories that Git should not chdir up into while looking for a repository directory (useful for excluding slow-loading network directories). It will not exclude the current working directory or a GIT_DIR set on the command line or in the environment. Normally, Git has to read the entries in this list and resolve any symlink that might be present in order to compare them with the current directory. However, if even this access is slow, you can add an empty entry to the list to tell Git that the subsequent entries are not symlinks and needn’t be resolved; e.g., GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink. GIT_DISCOVERY_ACROSS_FILESYSTEM When run in a directory that does not have ".git" repository directory, Git tries to find such a directory in the parent directories to find the top of the working tree, but by default it does not cross filesystem boundaries. This Boolean environment variable can be set to true to tell Git not to stop at filesystem boundaries. Like GIT_CEILING_DIRECTORIES, this will not affect an explicit repository directory set via GIT_DIR or on the command line. GIT_COMMON_DIR If this variable is set to a path, non-worktree files that are normally in $GIT_DIR will be taken from this path instead. Worktree-specific files such as HEAD or index are taken from $GIT_DIR. See gitrepository-layout(5) and git-worktree(1) for details. This variable has lower precedence than other path variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY... GIT_DEFAULT_HASH If this variable is set, the default hash algorithm for new repositories will be set to this value. This value is ignored when cloning and the setting of the remote repository is always used. The default is "sha1". THIS VARIABLE IS EXPERIMENTAL! See --object-format in git-init(1). Git Commits GIT_AUTHOR_NAME The human-readable name used in the author identity when creating commit or tag objects, or when writing reflogs. Overrides the user.name and author.name configuration settings. GIT_AUTHOR_EMAIL The email address used in the author identity when creating commit or tag objects, or when writing reflogs. Overrides the user.email and author.email configuration settings. GIT_AUTHOR_DATE The date used for the author identity when creating commit or tag objects, or when writing reflogs. See git-commit(1) for valid formats. GIT_COMMITTER_NAME The human-readable name used in the committer identity when creating commit or tag objects, or when writing reflogs. Overrides the user.name and committer.name configuration settings. GIT_COMMITTER_EMAIL The email address used in the author identity when creating commit or tag objects, or when writing reflogs. Overrides the user.email and committer.email configuration settings. GIT_COMMITTER_DATE The date used for the committer identity when creating commit or tag objects, or when writing reflogs. See git-commit(1) for valid formats. EMAIL The email address used in the author and committer identities if no other relevant environment variable or configuration setting has been set. Git Diffs GIT_DIFF_OPTS Only valid setting is "--unified=??" or "-u??" to set the number of context lines shown when a unified diff is created. This takes precedence over any "-U" or "--unified" option value passed on the Git diff command line. GIT_EXTERNAL_DIFF When the environment variable GIT_EXTERNAL_DIFF is set, the program named by it is called to generate diffs, and Git does not use its builtin diff machinery. For a path that is added, removed, or modified, GIT_EXTERNAL_DIFF is called with 7 parameters: path old-file old-hex old-mode new-file new-hex new-mode where: <old|new>-file are files GIT_EXTERNAL_DIFF can use to read the contents of <old|new>, <old|new>-hex are the 40-hexdigit SHA-1 hashes, <old|new>-mode are the octal representation of the file modes. The file parameters can point at the user’s working file (e.g. new-file in "git-diff-files"), /dev/null (e.g. old-file when a new file is added), or a temporary file (e.g. old-file in the index). GIT_EXTERNAL_DIFF should not worry about unlinking the temporary file — it is removed when GIT_EXTERNAL_DIFF exits. For a path that is unmerged, GIT_EXTERNAL_DIFF is called with 1 parameter, <path>. For each path GIT_EXTERNAL_DIFF is called, two environment variables, GIT_DIFF_PATH_COUNTER and GIT_DIFF_PATH_TOTAL are set. GIT_DIFF_PATH_COUNTER A 1-based counter incremented by one for every path. GIT_DIFF_PATH_TOTAL The total number of paths. other GIT_MERGE_VERBOSITY A number controlling the amount of output shown by the recursive merge strategy. Overrides merge.verbosity. See git-merge(1) GIT_PAGER This environment variable overrides $PAGER. If it is set to an empty string or to the value "cat", Git will not launch a pager. See also the core.pager option in git-config(1). GIT_PROGRESS_DELAY A number controlling how many seconds to delay before showing optional progress indicators. Defaults to 2. GIT_EDITOR This environment variable overrides $EDITOR and $VISUAL. It is used by several Git commands when, on interactive mode, an editor is to be launched. See also git-var(1) and the core.editor option in git- config(1). GIT_SEQUENCE_EDITOR This environment variable overrides the configured Git editor when editing the todo list of an interactive rebase. See also git- rebase(1) and the sequence.editor option in git-config(1). GIT_SSH, GIT_SSH_COMMAND If either of these environment variables is set then git fetch and git push will use the specified command instead of ssh when they need to connect to a remote system. The command-line parameters passed to the configured command are determined by the ssh variant. See ssh.variant option in git-config(1) for details. $GIT_SSH_COMMAND takes precedence over $GIT_SSH, and is interpreted by the shell, which allows additional arguments to be included. $GIT_SSH on the other hand must be just the path to a program (which can be a wrapper shell script, if additional arguments are needed). Usually it is easier to configure any desired options through your personal .ssh/config file. Please consult your ssh documentation for further details. GIT_SSH_VARIANT If this environment variable is set, it overrides Git’s autodetection whether GIT_SSH/GIT_SSH_COMMAND/core.sshCommand refer to OpenSSH, plink or tortoiseplink. This variable overrides the config setting ssh.variant that serves the same purpose. GIT_SSL_NO_VERIFY Setting and exporting this environment variable to any value tells Git not to verify the SSL certificate when fetching or pushing over HTTPS. GIT_ATTR_SOURCE Sets the treeish that gitattributes will be read from. GIT_ASKPASS If this environment variable is set, then Git commands which need to acquire passwords or passphrases (e.g. for HTTP or IMAP authentication) will call this program with a suitable prompt as command-line argument and read the password from its STDOUT. See also the core.askPass option in git-config(1). GIT_TERMINAL_PROMPT If this Boolean environment variable is set to false, git will not prompt on the terminal (e.g., when asking for HTTP authentication). GIT_CONFIG_GLOBAL, GIT_CONFIG_SYSTEM Take the configuration from the given files instead from global or system-level configuration files. If GIT_CONFIG_SYSTEM is set, the system config file defined at build time (usually /etc/gitconfig) will not be read. Likewise, if GIT_CONFIG_GLOBAL is set, neither $HOME/.gitconfig nor $XDG_CONFIG_HOME/git/config will be read. Can be set to /dev/null to skip reading configuration files of the respective level. GIT_CONFIG_NOSYSTEM Whether to skip reading settings from the system-wide $(prefix)/etc/gitconfig file. This Boolean environment variable can be used along with $HOME and $XDG_CONFIG_HOME to create a predictable environment for a picky script, or you can set it to true to temporarily avoid using a buggy /etc/gitconfig file while waiting for someone with sufficient permissions to fix it. GIT_FLUSH If this environment variable is set to "1", then commands such as git blame (in incremental mode), git rev-list, git log, git check-attr and git check-ignore will force a flush of the output stream after each record have been flushed. If this variable is set to "0", the output of these commands will be done using completely buffered I/O. If this environment variable is not set, Git will choose buffered or record-oriented flushing based on whether stdout appears to be redirected to a file or not. GIT_TRACE Enables general trace messages, e.g. alias expansion, built-in command execution and external command execution. If this variable is set to "1", "2" or "true" (comparison is case insensitive), trace messages will be printed to stderr. If the variable is set to an integer value greater than 2 and lower than 10 (strictly) then Git will interpret this value as an open file descriptor and will try to write the trace messages into this file descriptor. Alternatively, if the variable is set to an absolute path (starting with a / character), Git will interpret this as a file path and will try to append the trace messages to it. Unsetting the variable, or setting it to empty, "0" or "false" (case insensitive) disables trace messages. GIT_TRACE_FSMONITOR Enables trace messages for the filesystem monitor extension. See GIT_TRACE for available trace output options. GIT_TRACE_PACK_ACCESS Enables trace messages for all accesses to any packs. For each access, the pack file name and an offset in the pack is recorded. This may be helpful for troubleshooting some pack-related performance problems. See GIT_TRACE for available trace output options. GIT_TRACE_PACKET Enables trace messages for all packets coming in or out of a given program. This can help with debugging object negotiation or other protocol issues. Tracing is turned off at a packet starting with "PACK" (but see GIT_TRACE_PACKFILE below). See GIT_TRACE for available trace output options. GIT_TRACE_PACKFILE Enables tracing of packfiles sent or received by a given program. Unlike other trace output, this trace is verbatim: no headers, and no quoting of binary data. You almost certainly want to direct into a file (e.g., GIT_TRACE_PACKFILE=/tmp/my.pack) rather than displaying it on the terminal or mixing it with other trace output. Note that this is currently only implemented for the client side of clones and fetches. GIT_TRACE_PERFORMANCE Enables performance related trace messages, e.g. total execution time of each Git command. See GIT_TRACE for available trace output options. GIT_TRACE_REFS Enables trace messages for operations on the ref database. See GIT_TRACE for available trace output options. GIT_TRACE_SETUP Enables trace messages printing the .git, working tree and current working directory after Git has completed its setup phase. See GIT_TRACE for available trace output options. GIT_TRACE_SHALLOW Enables trace messages that can help debugging fetching / cloning of shallow repositories. See GIT_TRACE for available trace output options. GIT_TRACE_CURL Enables a curl full trace dump of all incoming and outgoing data, including descriptive information, of the git transport protocol. This is similar to doing curl --trace-ascii on the command line. See GIT_TRACE for available trace output options. GIT_TRACE_CURL_NO_DATA When a curl trace is enabled (see GIT_TRACE_CURL above), do not dump data (that is, only dump info lines and headers). GIT_TRACE2 Enables more detailed trace messages from the "trace2" library. Output from GIT_TRACE2 is a simple text-based format for human readability. If this variable is set to "1", "2" or "true" (comparison is case insensitive), trace messages will be printed to stderr. If the variable is set to an integer value greater than 2 and lower than 10 (strictly) then Git will interpret this value as an open file descriptor and will try to write the trace messages into this file descriptor. Alternatively, if the variable is set to an absolute path (starting with a / character), Git will interpret this as a file path and will try to append the trace messages to it. If the path already exists and is a directory, the trace messages will be written to files (one per process) in that directory, named according to the last component of the SID and an optional counter (to avoid filename collisions). In addition, if the variable is set to af_unix:[<socket_type>:]<absolute-pathname>, Git will try to open the path as a Unix Domain Socket. The socket type can be either stream or dgram. Unsetting the variable, or setting it to empty, "0" or "false" (case insensitive) disables trace messages. See Trace2 documentation[2] for full details. GIT_TRACE2_EVENT This setting writes a JSON-based format that is suited for machine interpretation. See GIT_TRACE2 for available trace output options and Trace2 documentation[2] for full details. GIT_TRACE2_PERF In addition to the text-based messages available in GIT_TRACE2, this setting writes a column-based format for understanding nesting regions. See GIT_TRACE2 for available trace output options and Trace2 documentation[2] for full details. GIT_TRACE_REDACT By default, when tracing is activated, Git redacts the values of cookies, the "Authorization:" header, the "Proxy-Authorization:" header and packfile URIs. Set this Boolean environment variable to false to prevent this redaction. GIT_LITERAL_PATHSPECS Setting this Boolean environment variable to true will cause Git to treat all pathspecs literally, rather than as glob patterns. For example, running GIT_LITERAL_PATHSPECS=1 git log -- '*.c' will search for commits that touch the path *.c, not any paths that the glob *.c matches. You might want this if you are feeding literal paths to Git (e.g., paths previously given to you by git ls-tree, --raw diff output, etc). GIT_GLOB_PATHSPECS Setting this Boolean environment variable to true will cause Git to treat all pathspecs as glob patterns (aka "glob" magic). GIT_NOGLOB_PATHSPECS Setting this Boolean environment variable to true will cause Git to treat all pathspecs as literal (aka "literal" magic). GIT_ICASE_PATHSPECS Setting this Boolean environment variable to true will cause Git to treat all pathspecs as case-insensitive. GIT_REFLOG_ACTION When a ref is updated, reflog entries are created to keep track of the reason why the ref was updated (which is typically the name of the high-level command that updated the ref), in addition to the old and new values of the ref. A scripted Porcelain command can use set_reflog_action helper function in git-sh-setup to set its name to this variable when it is invoked as the top level command by the end user, to be recorded in the body of the reflog. GIT_REF_PARANOIA If this Boolean environment variable is set to false, ignore broken or badly named refs when iterating over lists of refs. Normally Git will try to include any such refs, which may cause some operations to fail. This is usually preferable, as potentially destructive operations (e.g., git-prune(1)) are better off aborting rather than ignoring broken refs (and thus considering the history they point to as not worth saving). The default value is 1 (i.e., be paranoid about detecting and aborting all operations). You should not normally need to set this to 0, but it may be useful when trying to salvage data from a corrupted repository. GIT_ALLOW_PROTOCOL If set to a colon-separated list of protocols, behave as if protocol.allow is set to never, and each of the listed protocols has protocol.<name>.allow set to always (overriding any existing configuration). See the description of protocol.allow in git- config(1) for more details. GIT_PROTOCOL_FROM_USER Set this Boolean environment variable to false to prevent protocols used by fetch/push/clone which are configured to the user state. This is useful to restrict recursive submodule initialization from an untrusted repository or for programs which feed potentially-untrusted URLS to git commands. See git-config(1) for more details. GIT_PROTOCOL For internal use only. Used in handshaking the wire protocol. Contains a colon : separated list of keys with optional values key[=value]. Presence of unknown keys and values must be ignored. Note that servers may need to be configured to allow this variable to pass over some transports. It will be propagated automatically when accessing local repositories (i.e., file:// or a filesystem path), as well as over the git:// protocol. For git-over-http, it should work automatically in most configurations, but see the discussion in git-http-backend(1). For git-over-ssh, the ssh server may need to be configured to allow clients to pass this variable (e.g., by using AcceptEnv GIT_PROTOCOL with OpenSSH). This configuration is optional. If the variable is not propagated, then clients will fall back to the original "v0" protocol (but may miss out on some performance improvements or features). This variable currently only affects clones and fetches; it is not yet used for pushes (but may be in the future). GIT_OPTIONAL_LOCKS If this Boolean environment variable is set to false, Git will complete any requested operation without performing any optional sub-operations that require taking a lock. For example, this will prevent git status from refreshing the index as a side effect. This is useful for processes running in the background which do not want to cause lock contention with other operations on the repository. Defaults to 1. GIT_REDIRECT_STDIN, GIT_REDIRECT_STDOUT, GIT_REDIRECT_STDERR Windows-only: allow redirecting the standard input/output/error handles to paths specified by the environment variables. This is particularly useful in multi-threaded applications where the canonical way to pass standard handles via CreateProcess() is not an option because it would require the handles to be marked inheritable (and consequently every spawned process would inherit them, possibly blocking regular Git operations). The primary intended use case is to use named pipes for communication (e.g. \\.\pipe\my-git-stdin-123). Two special values are supported: off will simply close the corresponding standard handle, and if GIT_REDIRECT_STDERR is 2>&1, standard error will be redirected to the same handle as standard output. GIT_PRINT_SHA1_ELLIPSIS (deprecated) If set to yes, print an ellipsis following an (abbreviated) SHA-1 value. This affects indications of detached HEADs (git-checkout(1)) and the raw diff output (git-diff(1)). Printing an ellipsis in the cases mentioned is no longer considered adequate and support for it is likely to be removed in the foreseeable future (along with the variable). DISCUSSION More detail on the following is available from the Git concepts chapter of the user-manual[3] and gitcore-tutorial(7). A Git project normally consists of a working directory with a ".git" subdirectory at the top level. The .git directory contains, among other things, a compressed object database representing the complete history of the project, an "index" file which links that history to the current contents of the working tree, and named pointers into that history such as tags and branch heads. The object database contains objects of three main types: blobs, which hold file data; trees, which point to blobs and other trees to build up directory hierarchies; and commits, which each reference a single tree and some number of parent commits. The commit, equivalent to what other systems call a "changeset" or "version", represents a step in the project’s history, and each parent represents an immediately preceding step. Commits with more than one parent represent merges of independent lines of development. All objects are named by the SHA-1 hash of their contents, normally written as a string of 40 hex digits. Such names are globally unique. The entire history leading up to a commit can be vouched for by signing just that commit. A fourth object type, the tag, is provided for this purpose. When first created, objects are stored in individual files, but for efficiency may later be compressed together into "pack files". Named pointers called refs mark interesting points in history. A ref may contain the SHA-1 name of an object or the name of another ref. Refs with names beginning ref/head/ contain the SHA-1 name of the most recent commit (or "head") of a branch under development. SHA-1 names of tags of interest are stored under ref/tags/. A special ref named HEAD contains the name of the currently checked-out branch. The index file is initialized with a list of all paths and, for each path, a blob object and a set of attributes. The blob object represents the contents of the file as of the head of the current branch. The attributes (last modified time, size, etc.) are taken from the corresponding file in the working tree. Subsequent changes to the working tree can be found by comparing these attributes. The index may be updated with new content, and new commits may be created from the content stored in the index. The index is also capable of storing multiple entries (called "stages") for a given pathname. These stages are used to hold the various unmerged version of a file when a merge is in progress. FURTHER DOCUMENTATION See the references in the "description" section to get started using Git. The following is probably more detail than necessary for a first-time user. The Git concepts chapter of the user-manual[3] and gitcore-tutorial(7) both provide introductions to the underlying Git architecture. See gitworkflows(7) for an overview of recommended workflows. See also the howto[4] documents for some useful examples. The internals are documented in the Git API documentation[5]. Users migrating from CVS may also want to read gitcvs-migration(7). AUTHORS Git was started by Linus Torvalds, and is currently maintained by Junio C Hamano. Numerous contributions have come from the Git mailing list <git@vger.kernel.org[6]>. http://www.openhub.net/p/git/contributors/summary gives you a more complete list of contributors. If you have a clone of git.git itself, the output of git-shortlog(1) and git-blame(1) can show you the authors for specific parts of the project. REPORTING BUGS Report bugs to the Git mailing list <git@vger.kernel.org[6]> where the development and maintenance is primarily done. You do not have to be subscribed to the list to send a message there. See the list archive at https://lore.kernel.org/git for previous bug reports and other discussions. Issues which are security relevant should be disclosed privately to the Git Security mailing list <git-security@googlegroups.com[7]>. SEE ALSO gittutorial(7), gittutorial-2(7), giteveryday(7), gitcvs-migration(7), gitglossary(7), gitcore-tutorial(7), gitcli(7), The Git User’s Manual[1], gitworkflows(7) GIT Part of the git(1) suite NOTES 1. Git User’s Manual git-htmldocs/user-manual.html 2. Trace2 documentation git-htmldocs/technical/api-trace2.html 3. Git concepts chapter of the user-manual git-htmldocs/user-manual.html#git-concepts 4. howto git-htmldocs/howto-index.html 5. Git API documentation git-htmldocs/technical/api-index.html 6. git@vger.kernel.org mailto:git@vger.kernel.org 7. git-security@googlegroups.com mailto:git-security@googlegroups.com Git 2.41.0 2023-06-01 GIT(1)
| null |
unterm
| null | null | null | null | null |
cpack
| null | null | null | null | null |
uncoded_frame
| null | null | null | null | null |
validation
| null | null | null | null | null |
rubberband-r3
| null | null | null | null | null |
mbedtls-benchmark
| null | null | null | null | null |
msgfmt
|
Generate binary message catalog from textual translation description. Mandatory arguments to long options are mandatory for short options too. Similarly for optional arguments. Input file location: filename.po ... input files -D, --directory=DIRECTORY add DIRECTORY to list for input files search If input file is -, standard input is read. Operation mode: -j, --java Java mode: generate a Java ResourceBundle class --java2 like --java, and assume Java2 (JDK 1.2 or higher) --csharp C# mode: generate a .NET .dll file --csharp-resources C# resources mode: generate a .NET .resources file --tcl Tcl mode: generate a tcl/msgcat .msg file --qt Qt mode: generate a Qt .qm file --desktop Desktop Entry mode: generate a .desktop file --xml XML mode: generate XML file Output file location: -o, --output-file=FILE write output to specified file --strict enable strict Uniforum mode If output file is -, output is written to standard output. Output file location in Java mode: -r, --resource=RESOURCE resource name -l, --locale=LOCALE locale name, either language or language_COUNTRY --source produce a .java file, instead of a .class file -d DIRECTORY base directory of classes directory hierarchy The class name is determined by appending the locale name to the resource name, separated with an underscore. The -d option is mandatory. The class is written under the specified directory. Output file location in C# mode: -r, --resource=RESOURCE resource name -l, --locale=LOCALE locale name, either language or language_COUNTRY -d DIRECTORY base directory for locale dependent .dll files The -l and -d options are mandatory. The .dll file is written in a subdirectory of the specified directory whose name depends on the locale. Output file location in Tcl mode: -l, --locale=LOCALE locale name, either language or language_COUNTRY -d DIRECTORY base directory of .msg message catalogs The -l and -d options are mandatory. The .msg file is written in the specified directory. Desktop Entry mode options: -l, --locale=LOCALE locale name, either language or language_COUNTRY -o, --output-file=FILE write output to specified file --template=TEMPLATE a .desktop file used as a template -d DIRECTORY base directory of .po files -kWORD, --keyword=WORD look for WORD as an additional keyword -k, --keyword do not to use default keywords The -l, -o, and --template options are mandatory. If -D is specified, input files are read from the directory instead of the command line arguments. XML mode options: -l, --locale=LOCALE locale name, either language or language_COUNTRY -L, --language=NAME recognise the specified XML language -o, --output-file=FILE write output to specified file --template=TEMPLATE an XML file used as a template -d DIRECTORY base directory of .po files The -l, -o, and --template options are mandatory. If -D is specified, input files are read from the directory instead of the command line arguments. Input file syntax: -P, --properties-input input files are in Java .properties syntax --stringtable-input input files are in NeXTstep/GNUstep .strings syntax Input file interpretation: -c, --check perform all the checks implied by --check-format, --check-header, --check-domain --check-format check language dependent format strings --check-header verify presence and contents of the header entry --check-domain check for conflicts between domain directives and the --output-file option -C, --check-compatibility check that GNU msgfmt behaves like X/Open msgfmt --check-accelerators[=CHAR] check presence of keyboard accelerators for menu items -f, --use-fuzzy use fuzzy entries in output Output details: --no-convert don't convert the messages to UTF-8 encoding --no-redundancy don't pre-expand ISO C 99 <inttypes.h> format string directive macros -a, --alignment=NUMBER align strings to NUMBER bytes (default: 1) --endianness=BYTEORDER write out 32-bit numbers in the given byte order (big or little, default depends on platform) --no-hash binary file will not include the hash table Informative output: -h, --help display this help and exit -V, --version output version information and exit --statistics print statistics about translations -v, --verbose increase verbosity level AUTHOR Written by Ulrich Drepper. REPORTING BUGS Report bugs in the bug tracker at <https://savannah.gnu.org/projects/gettext> or by email to <bug-gettext@gnu.org>. COPYRIGHT Copyright © 1995-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 The full documentation for msgfmt is maintained as a Texinfo manual. If the info and msgfmt programs are properly installed at your site, the command info msgfmt should give you access to the complete manual. GNU gettext-tools 0.22.5 February 2024 MSGFMT(1)
|
msgfmt - compile message catalog to binary format
|
msgfmt [OPTION] filename.po ...
| null | null |
god
|
Write an unambiguous representation, octal bytes by default, of FILE to standard output. With more than one FILE argument, concatenate them in the listed order to form the input. With no FILE, or when FILE is -, read standard input. If first and second call formats both apply, the second format is assumed if the last operand begins with + or (if there are 2 operands) a digit. An OFFSET operand means -j OFFSET. LABEL is the pseudo-address at first byte printed, incremented when dump is progressing. For OFFSET and LABEL, a 0x or 0X prefix indicates hexadecimal; suffixes may be . for octal and b for multiply by 512. Mandatory arguments to long options are mandatory for short options too. -A, --address-radix=RADIX output format for file offsets; RADIX is one of [doxn], for Decimal, Octal, Hex or None --endian={big|little} swap input bytes according the specified order -j, --skip-bytes=BYTES skip BYTES input bytes first -N, --read-bytes=BYTES limit dump to BYTES input bytes -S BYTES, --strings[=BYTES] output strings of at least BYTES graphic chars; 3 is implied when BYTES is not specified -t, --format=TYPE select output format or formats -v, --output-duplicates do not use * to mark line suppression -w[BYTES], --width[=BYTES] output BYTES bytes per output line; 32 is implied when BYTES is not specified --traditional accept arguments in third form above --help display this help and exit --version output version information and exit Traditional format specifications may be intermixed; they accumulate: -a same as -t a, select named characters, ignoring high-order bit -b same as -t o1, select octal bytes -c same as -t c, select printable characters or backslash escapes -d same as -t u2, select unsigned decimal 2-byte units -f same as -t fF, select floats -i same as -t dI, select decimal ints -l same as -t dL, select decimal longs -o same as -t o2, select octal 2-byte units -s same as -t d2, select decimal 2-byte units -x same as -t x2, select hexadecimal 2-byte units TYPE is made up of one or more of these specifications: a named character, ignoring high-order bit c printable character or backslash escape d[SIZE] signed decimal, SIZE bytes per integer f[SIZE] floating point, SIZE bytes per float o[SIZE] octal, SIZE bytes per integer u[SIZE] unsigned decimal, SIZE bytes per integer x[SIZE] hexadecimal, SIZE bytes per integer SIZE is a number. For TYPE in [doux], SIZE may also be C for sizeof(char), S for sizeof(short), I for sizeof(int) or L for sizeof(long). If TYPE is f, SIZE may also be F for sizeof(float), D for sizeof(double) or L for sizeof(long double). Adding a z suffix to any type displays printable characters at the end of each output line. BYTES is hex with 0x or 0X prefix, and may have a multiplier suffix: b 512 KB 1000 K 1024 MB 1000*1000 M 1024*1024 and so on for G, T, P, E, Z, Y, R, Q. Binary prefixes can be used, too: KiB=K, MiB=M, and so on.
|
od - dump files in octal and other formats
|
od [OPTION]... [FILE]... od [-abcdfilosx]... [FILE] [[+]OFFSET[.][b]] od --traditional [OPTION]... [FILE] [[+]OFFSET[.][b] [+][LABEL][.][b]]
| null |
od -A x -t x1z -v Display hexdump format output od -A o -t oS -w16 The default output format used by od 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/od> or available locally via: info '(coreutils) od invocation' GNU coreutils 9.3 April 2023 OD(1)
|
dbtest
| null | null | null | null | null |
gnutls-cli
|
Simple client program to set up a TLS connection to some other computer. It sets up a TLS connection and forwards data from the standard input to the secured socket and vice versa.
|
gnutls-cli - GnuTLS client
|
gnutls-cli [-flags] [-flag [value]] [--option-name[[=| ]value]] [hostname] Operands and options may be intermixed. They will be reordered.
|
-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. -V, --verbose More verbose output. --tofu, --no-tofu Enable trust on first use authentication. The no-tofu form will disable the option. This option will, in addition to certificate authentication, perform authentication based on previously seen public keys, a model similar to SSH authentication. Note that when tofu is specified (PKI) and DANE authentication will become advisory to assist the public key acceptance process. --strict-tofu, --no-strict-tofu Fail to connect if a certificate is unknown or a known certificate has changed. The no-strict-tofu form will disable the option. This option will perform authentication as with option --tofu; however, no questions shall be asked whatsoever, neither to accept an unknown certificate nor a changed one. --dane, --no-dane Enable DANE certificate verification (DNSSEC). The no-dane form will disable the option. This option will, in addition to certificate authentication using the trusted CAs, verify the server certificates using on the DANE information available via DNSSEC. --local-dns, --no-local-dns Use the local DNS server for DNSSEC resolving. The no-local-dns form will disable the option. This option will use the local DNS server for DNSSEC. This is disabled by default due to many servers not allowing DNSSEC. --ca-verification, --no-ca-verification Enable CA certificate verification. The no-ca-verification form will disable the option. This option is enabled by default. This option can be used to enable or disable CA certificate verification. It is to be used with the --dane or --tofu options. --ocsp, --no-ocsp Enable OCSP certificate verification. The no-ocsp form will disable the option. This option will enable verification of the peer's certificate using ocsp -r, --resume Establish a session and resume. Connect, establish a session, reconnect and resume. --earlydata=str Send early data on resumption from the specified file. -e, --rehandshake Establish a session and rehandshake. Connect, establish a session and rehandshake immediately. --sni-hostname=str Server's hostname for server name indication extension. Set explicitly the server name used in the TLS server name indication extension. That is useful when testing with servers setup on different DNS name than the intended. If not specified, the provided hostname is used. Even with this option server certificate verification still uses the hostname passed on the main commandline. Use --verify-hostname to change this. --verify-hostname=str Server's hostname to use for validation. Set explicitly the server name to be used when validating the server's certificate. -s, --starttls Connect, establish a plain session and start TLS. The TLS session will be initiated when EOF or a SIGALRM is received. --app-proto This is an alias for the --starttls-proto option. --starttls-proto=str The application protocol to be used to obtain the server's certificate (https, ftp, smtp, imap, ldap, xmpp, lmtp, pop3, nntp, sieve, postgres). This option must not appear in combination with any of the following options: starttls. Specify the application layer protocol for STARTTLS. If the protocol is supported, gnutls-cli will proceed to the TLS negotiation. --starttls-name=str The hostname presented to the application protocol for STARTTLS (for smtp, xmpp, lmtp). This option must not appear in combination with any of the following options: starttls. This option must appear in combination with the following options: starttls-proto. Specify the hostname presented to the application protocol for STARTTLS. -u, --udp Use DTLS (datagram TLS) over UDP. --mtu=num Set MTU for datagram TLS. This option takes an integer number as its argument. The value of num is constrained to being: in the range 0 through 17000 --crlf Send CR LF instead of LF. --fastopen Enable TCP Fast Open. --x509fmtder Use DER format for certificates to read from. --print-cert Print peer's certificate in PEM format. --save-cert=str Save the peer's certificate chain in the specified file in PEM format. --save-ocsp=str Save the peer's OCSP status response in the provided file. This option must not appear in combination with any of the following options: save-ocsp-multi. --save-ocsp-multi=str Save all OCSP responses provided by the peer in this file. This option must not appear in combination with any of the following options: save-ocsp. The file will contain a list of PEM encoded OCSP status responses if any were provided by the peer, starting with the one for the peer's server certificate. --save-server-trace=str Save the server-side TLS message trace in the provided file. --save-client-trace=str Save the client-side TLS message trace in the provided file. --dh-bits=num The minimum number of bits allowed for DH. This option takes an integer number as its argument. This option sets the minimum number of bits allowed for a Diffie-Hellman key exchange. You may want to lower the default value if the peer sends a weak prime and you get an connection error with unacceptable prime. --priority=str Priorities string. TLS algorithms and protocols to enable. You can use predefined sets of ciphersuites such as PERFORMANCE, NORMAL, PFS, SECURE128, SECURE256. The default is NORMAL. Check the GnuTLS manual on section “Priority strings” for more information on the allowed keywords --x509cafile=str Certificate file or PKCS #11 URL to use. --x509crlfile=file CRL file to use. --x509keyfile=str X.509 key file or PKCS #11 URL to use. --x509certfile=str X.509 Certificate file or PKCS #11 URL to use. This option must appear in combination with the following options: x509keyfile. --rawpkkeyfile=str Private key file (PKCS #8 or PKCS #12) or PKCS #11 URL to use. In order to instruct the application to negotiate raw public keys one must enable the respective certificate types via the priority strings (i.e. CTYPE-CLI-* and CTYPE-SRV-* flags). Check the GnuTLS manual on section “Priority strings” for more information on how to set certificate types. --rawpkfile=str Raw public-key file to use. This option must appear in combination with the following options: rawpkkeyfile. In order to instruct the application to negotiate raw public keys one must enable the respective certificate types via the priority strings (i.e. CTYPE-CLI-* and CTYPE-SRV-* flags). Check the GnuTLS manual on section “Priority strings” for more information on how to set certificate types. --srpusername=str SRP username to use. --srppasswd=str SRP password to use. --pskusername=str PSK username to use. --pskkey=str PSK key (in hex) to use. -p str, --port=str The port or service to connect to. --insecure Don't abort program if server certificate can't be validated. --verify-allow-broken Allow broken algorithms, such as MD5 for certificate verification. --ranges Use length-hiding padding to prevent traffic analysis. When possible (e.g., when using CBC ciphersuites), use length-hiding padding to prevent traffic analysis. NOTE: THIS OPTION IS DEPRECATED --benchmark-ciphers Benchmark individual ciphers. By default the benchmarked ciphers will utilize any capabilities of the local CPU to improve performance. To test against the raw software implementation set the environment variable GNUTLS_CPUID_OVERRIDE to 0x1. --benchmark-tls-kx Benchmark TLS key exchange methods. --benchmark-tls-ciphers Benchmark TLS ciphers. By default the benchmarked ciphers will utilize any capabilities of the local CPU to improve performance. To test against the raw software implementation set the environment variable GNUTLS_CPUID_OVERRIDE to 0x1. -l, --list Print a list of the supported algorithms and modes. This option must not appear in combination with any of the following options: port. Print a list of the supported algorithms and modes. If a priority string is given then only the enabled ciphersuites are shown. --priority-list Print a list of the supported priority strings. Print a list of the supported priority strings. The ciphersuites corresponding to each priority string can be examined using -l -p. --noticket Don't allow session tickets. Disable the request of receiving of session tickets under TLS1.2 or earlier --srtp-profiles=str Offer SRTP profiles. --alpn=str Application layer protocol. This option may appear an unlimited number of times. This option will set and enable the Application Layer Protocol Negotiation (ALPN) in the TLS protocol. --compress-cert=str Compress certificate. This option may appear an unlimited number of times. This option sets a supported compression method for certificate compression. -b, --heartbeat Activate heartbeat support. --recordsize=num The maximum record size to advertise. This option takes an integer number as its argument. The value of num is constrained to being: in the range 0 through 4096 --disable-sni Do not send a Server Name Indication (SNI). --disable-extensions Disable all the TLS extensions. This option disables all TLS extensions. Deprecated option. Use the priority string. NOTE: THIS OPTION IS DEPRECATED --single-key-share Send a single key share under TLS1.3. This option switches the default mode of sending multiple key shares, to send a single one (the top one). --post-handshake-auth Enable post-handshake authentication under TLS1.3. This option enables post-handshake authentication when under TLS1.3. --inline-commands Inline commands of the form ^<cmd>^. Enable inline commands of the form ^<cmd>^. The inline commands are expected to be in a line by themselves. The available commands are: resume, rekey1 (local rekey), rekey (rekey on both peers) and renegotiate. --inline-commands-prefix=str Change the default delimiter for inline commands. Change the default delimiter (^) used for inline commands. The delimiter is expected to be a single US-ASCII character (octets 0 - 127). This option is only relevant if inline commands are enabled via the inline-commands option --provider=file Specify the PKCS #11 provider library. This will override the default options in /etc/gnutls/pkcs11.conf --fips140-mode Reports the status of the FIPS140-2 mode in gnutls library. --list-config Reports the configuration of the library. --logfile=str Redirect informational messages to a specific file. Redirect informational messages to a specific file. The file may be /dev/null also to make the gnutls client quiet to use it in piped server connections where only the server communication may appear on stdout. --keymatexport=str Label used for exporting keying material. --keymatexportsize=num Size of the exported keying material. This option takes an integer number as its argument. --waitresumption Block waiting for the resumption data under TLS1.3. This option makes the client to block waiting for the resumption data under TLS1.3. The option has effect only when --resume is provided. --ca-auto-retrieve, --no-ca-auto-retrieve Enable automatic retrieval of missing CA certificates. The no-ca-auto-retrieve form will disable the option. This option enables the client to automatically retrieve the missing intermediate CA certificates in the certificate chain, based on the Authority Information Access (AIA) extension. --attime=timestamp Perform validation at the timestamp instead of the system time. timestamp is an instance in time encoded as Unix time or in a human readable timestring such as "29 Feb 2004", "2004-02-29". Full documentation available at <https://www.gnu.org/software/coreutils/manual/html_node/Date-input-formats.html> or locally via info '(coreutils) date invocation'. -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.
|
Connecting using PSK authentication To connect to a server using PSK authentication, you need to enable the choice of PSK by using a cipher priority parameter such as in the example below. $ ./gnutls-cli -p 5556 localhost --pskusername psk_identity --pskkey 88f3824b3e5659f52d00e959bacab954b6540344 --priority NORMAL:-KX-ALL:+ECDHE-PSK:+DHE-PSK:+PSK Resolving 'localhost'... Connecting to '127.0.0.1:5556'... - PSK authentication. - Version: TLS1.1 - Key Exchange: PSK - Cipher: AES-128-CBC - MAC: SHA1 - Compression: NULL - Handshake was completed - Simple Client Mode: By keeping the --pskusername parameter and removing the --pskkey parameter, it will query only for the password during the handshake. Connecting using raw public-key authentication To connect to a server using raw public-key authentication, you need to enable the option to negotiate raw public-keys via the priority strings such as in the example below. $ ./gnutls-cli -p 5556 localhost --priority NORMAL:-CTYPE-CLI-ALL:+CTYPE-CLI-RAWPK --rawpkkeyfile cli.key.pem --rawpkfile cli.rawpk.pem Processed 1 client raw public key pair... Resolving 'localhost'... Connecting to '127.0.0.1:5556'... - Successfully sent 1 certificate(s) to server. - Server has requested a certificate. - Certificate type: X.509 - Got a certificate list of 1 certificates. - Certificate[0] info: - skipped - Description: (TLS1.3-Raw Public Key-X.509)-(ECDHE-SECP256R1)-(RSA-PSS-RSAE-SHA256)-(AES-256-GCM) - Options: - Handshake was completed - Simple Client Mode: Connecting to STARTTLS services You could also use the client to connect to services with starttls capability. $ gnutls-cli --starttls-proto smtp --port 25 localhost Listing ciphersuites in a priority string To list the ciphersuites in a priority string: $ ./gnutls-cli --priority SECURE192 -l Cipher suites for SECURE192 TLS_ECDHE_ECDSA_AES_256_CBC_SHA384 0xc0, 0x24 TLS1.2 TLS_ECDHE_ECDSA_AES_256_GCM_SHA384 0xc0, 0x2e TLS1.2 TLS_ECDHE_RSA_AES_256_GCM_SHA384 0xc0, 0x30 TLS1.2 TLS_DHE_RSA_AES_256_CBC_SHA256 0x00, 0x6b TLS1.2 TLS_DHE_DSS_AES_256_CBC_SHA256 0x00, 0x6a TLS1.2 TLS_RSA_AES_256_CBC_SHA256 0x00, 0x3d TLS1.2 Certificate types: CTYPE-X.509 Protocols: VERS-TLS1.2, VERS-TLS1.1, VERS-TLS1.0, VERS-SSL3.0, VERS-DTLS1.0 Compression: COMP-NULL Elliptic curves: CURVE-SECP384R1, CURVE-SECP521R1 PK-signatures: SIGN-RSA-SHA384, SIGN-ECDSA-SHA384, SIGN-RSA-SHA512, SIGN-ECDSA-SHA512 Connecting using a PKCS #11 token To connect to a server using a certificate and a private key present in a PKCS #11 token you need to substitute the PKCS 11 URLs in the x509certfile and x509keyfile parameters. Those can be found using "p11tool --list-tokens" and then listing all the objects in the needed token, and using the appropriate. $ p11tool --list-tokens Token 0: URL: pkcs11:model=PKCS15;manufacturer=MyMan;serial=1234;token=Test Label: Test Manufacturer: EnterSafe Model: PKCS15 Serial: 1234 $ p11tool --login --list-certs "pkcs11:model=PKCS15;manufacturer=MyMan;serial=1234;token=Test" Object 0: URL: pkcs11:model=PKCS15;manufacturer=MyMan;serial=1234;token=Test;object=client;type=cert Type: X.509 Certificate Label: client ID: 2a:97:0d:58:d1:51:3c:23:07:ae:4e:0d:72:26:03:7d:99:06:02:6a $ MYCERT="pkcs11:model=PKCS15;manufacturer=MyMan;serial=1234;token=Test;object=client;type=cert" $ MYKEY="pkcs11:model=PKCS15;manufacturer=MyMan;serial=1234;token=Test;object=client;type=private" $ export MYCERT MYKEY $ gnutls-cli www.example.com --x509keyfile $MYKEY --x509certfile $MYCERT Notice that the private key only differs from the certificate in the type. 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) 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 gnutls-cli(1)
|
gpgme-tool
| null | null | null | null | null |
gprintf
|
Print ARGUMENT(s) according to FORMAT, or execute according to OPTION: --help display this help and exit --version output version information and exit FORMAT controls the output as in C printf. Interpreted sequences are: \" double quote \\ backslash \a alert (BEL) \b backspace \c produce no further output \e escape \f form feed \n new line \r carriage return \t horizontal tab \v vertical tab \NNN byte with octal value NNN (1 to 3 digits) \xHH byte with hexadecimal value HH (1 to 2 digits) \uHHHH Unicode (ISO/IEC 10646) character with hex value HHHH (4 digits) \UHHHHHHHH Unicode character with hex value HHHHHHHH (8 digits) %% a single % %b ARGUMENT as a string with '\' escapes interpreted, except that octal escapes are of the form \0 or \0NNN %q ARGUMENT is printed in a format that can be reused as shell input, escaping non-printable characters with the proposed POSIX $'' syntax. and all C format specifications ending with one of diouxXfeEgGcs, with ARGUMENTs converted to proper type first. Variable widths are handled. NOTE: your shell may have its own version of printf, which usually supersedes the version described here. Please refer to your shell's documentation for details about the options it supports. AUTHOR Written by 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 printf(3) Full documentation <https://www.gnu.org/software/coreutils/printf> or available locally via: info '(coreutils) printf invocation' GNU coreutils 9.3 April 2023 PRINTF(1)
|
printf - format and print data
|
printf FORMAT [ARGUMENT]... printf OPTION
| null | null |
bisect-create
| null | null | null | null | null |
srt-live-transmit
| null | null | null | null | null |
loudnorm.rb
| null | null | null | null | null |
php-config
|
php-config is a simple shell script for obtaining information about installed PHP configuration.
|
php-config - get information about PHP configuration and compile
|
php-config [options]
|
--prefix Directory prefix where PHP is installed, e.g. /usr/local --includes List of -I options with all include files --ldflags LD Flags which PHP was compiled with --libs Extra libraries which PHP was compiled with --man-dir The directory prefix where the manpages is installed --extension-dir Directory where extensions are searched by default --include-dir Directory prefix where header files are installed by default --php-binary Full path to php CLI or CGI binary --php-sapis Show all SAPI modules available --configure-options Configure options to recreate configuration of current PHP installation --version PHP version --vernum PHP version as integer SEE ALSO php(1) VERSION INFORMATION This manpage describes php, 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 php-config(1)
| null |
openai
| null | null | null | null | null |
sdrtest
| null | null | null | null | null |
xzdiff
|
xzcmp and xzdiff compare uncompressed contents of two files. Uncompressed data and options are passed to cmp(1) or diff(1) unless --help or --version is specified. If both file1 and file2 are specified, they can be uncompressed files or files in formats that xz(1), gzip(1), bzip2(1), lzop(1), zstd(1), or lz4(1) can decompress. The required decompression commands are determined from the filename suffixes of file1 and file2. A file with an unknown suffix is assumed to be either uncompressed or in a format that xz(1) can decompress. If only one filename is provided, file1 must have a suffix of a supported compression format and the name for file2 is assumed to be file1 with the compression format suffix removed. The commands lzcmp and lzdiff are provided for backward compatibility with LZMA Utils. EXIT STATUS If a decompression error occurs, the exit status is 2. Otherwise the exit status of cmp(1) or diff(1) is used. SEE ALSO cmp(1), diff(1), xz(1), gzip(1), bzip2(1), lzop(1), zstd(1), lz4(1) Tukaani 2024-02-13 XZDIFF(1)
|
xzcmp, xzdiff, lzcmp, lzdiff - compare compressed files
|
xzcmp [option...] file1 [file2] xzdiff ... lzcmp ... lzdiff ...
| null | null |
msgattrib
|
Filters the messages of a translation catalog according to their attributes, and manipulates the attributes. Mandatory arguments to long options are mandatory for short options too. Input file location: INPUTFILE input PO file -D, --directory=DIRECTORY add DIRECTORY to list for input files search If no input file is given or if it is -, standard input is read. Output file location: -o, --output-file=FILE write output to specified file The results are written to standard output if no output file is specified or if it is -. Message selection: --translated keep translated, remove untranslated messages --untranslated keep untranslated, remove translated messages --no-fuzzy remove 'fuzzy' marked messages --only-fuzzy keep 'fuzzy' marked messages --no-obsolete remove obsolete #~ messages --only-obsolete keep obsolete #~ messages Attribute manipulation: --set-fuzzy set all messages 'fuzzy' --clear-fuzzy set all messages non-'fuzzy' --set-obsolete set all messages obsolete --clear-obsolete set all messages non-obsolete --previous when setting 'fuzzy', keep previous msgids of translated messages. --clear-previous remove the "previous msgid" from all messages --empty when removing 'fuzzy', also set msgstr empty --only-file=FILE.po manipulate only entries listed in FILE.po --ignore-file=FILE.po manipulate only entries not listed in FILE.po --fuzzy synonym for --only-fuzzy --clear-fuzzy --obsolete synonym for --only-obsolete --clear-obsolete Input file syntax: -P, --properties-input input file is in Java .properties syntax --stringtable-input input file is in NeXTstep/GNUstep .strings syntax Output details: --color use colors and other text attributes always --color=WHEN use colors and other text attributes if WHEN. WHEN may be 'always', 'never', 'auto', or 'html'. --style=STYLEFILE specify CSS style rule file for --color -e, --no-escape do not use C escapes in output (default) -E, --escape use C escapes in output, no extended chars --force-po write PO file even if empty -i, --indent write the .po file using indented style --no-location do not write '#: filename:line' lines -n, --add-location generate '#: filename:line' lines (default) --strict write out strict Uniforum conforming .po file -p, --properties-output write out a Java .properties file --stringtable-output write out a NeXTstep/GNUstep .strings file -w, --width=NUMBER set output page width --no-wrap do not break long message lines, longer than the output page width, into several lines -s, --sort-output generate sorted output -F, --sort-by-file sort output by file location Informative output: -h, --help display this help and exit -V, --version output version information and exit AUTHOR Written by Bruno Haible. REPORTING BUGS Report bugs in the bug tracker at <https://savannah.gnu.org/projects/gettext> or by email to <bug-gettext@gnu.org>. COPYRIGHT Copyright © 2001-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 The full documentation for msgattrib is maintained as a Texinfo manual. If the info and msgattrib programs are properly installed at your site, the command info msgattrib should give you access to the complete manual. GNU gettext-tools 0.22.5 February 2024 MSGATTRIB(1)
|
msgattrib - attribute matching and manipulation on message catalog
|
msgattrib [OPTION] [INPUTFILE]
| null | null |
get_objgraph
| null | null | null | null | null |
supervisorctl
| null | null | null | null | null |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.