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
isql
isql and iusql are command-line tools allowing users to execute SQL interactively or in batches. The tools provide several useful features, including an option to generate output wrapped in an HTML table. iusql is the same as isql but includes built-in Unicode support. Some data sources only work with iusql. An important difference between the two tools is that isql connects using SQLConnect and iusql connects using SQLDriverConnect. ARGUMENTS DSN The Data Source Name (DSN) used to connect to the SQL database. unixODBC looks for the specified DSN in /etc/odbc.ini and $HOME/.odbc.ini, with the latter taking precedence. When searching the configuration files, unixODBC looks for a bare name. If the DSN begins with a semicolon, it is treated as a connection string. The connection string can contain a DSN and/or other semicolon-separated parameters. USER Specifies the database user or role under which the connection should be made. This parameter overrides any UID specified in the data source configuration files. PASSWORD Password required to access the database for the specified USER. This parameter overrides any PASSWORD specified in the data source configuration files. When using iusql, passwords containing semicolons should be escaped with braces (curly brackets) and terminated with a semicolon. Refer to the Examples section below for syntax. "ConnectionString" A connection string starting with DSN=, DRIVER= or FILEDSN= will be passed unchanged to SQLDriverConnect. This option allows for the use of more complex syntax in a connection string than would otherwise be possible by just using DSN, UID and PWD. It also (and this was the main reason for its inclusion) allows passwords to contain semicolons without having to add complex escape syntax to the existing code.
isql, iusql - unixODBC interactive SQL command-line tools
isql DSN [USER [PASSWORD]] [options] iusql DSN [USER [PASSWORD]] [options] iusql "ConnectionString" [options]
-b Run 'isql' in non-interactive batch mode. In this mode, 'isql' processes from standard input, expecting one SQL command per line. -dDELIMITER Delimit columns with the specified delimiter. -xHEX Delimit columns with the character represented in hexadecimal by HEX. The hexadecimal code must be in the format 0xNN (e.g. 0x09 for the TAB character). -w Format the result as an HTML table. -c Output the names of the columns on the first row. This option can only be used with the -d or -x options. -mNUM Limit the column display width to NUM characters. -lLOCALE Set the character locale to LOCALE. -q Wrap the character fields in double quotes. -3 Use calls from ODBC version 3. -n Process multiple lines of SQL, terminated with the GO command. -e Use SQLExecDirect instead of Prepare. -k Use SQLDriverConnect. -v Enable verbose mode, fully describing all errors. This option is useful for debugging. --version Display the program version. -LNUM Set the maximum number of characters displayed from a character field to NUM. The default value is 300 characters. COMMANDS This section briefly describes some isql and iusql run-time commands. help List all tables in the database. help table List all columns in the table. help help List all help options.
A bare DSN: $ iusql WebDB MyID MyPWD -w -b < My.sql Connects to the WebDB DSN as user MyID with password MyPWD, then executes the commands in the My.sql file and returns the results wrapped in an HTML table. Each line in My.sql must only contain one SQL command, except for the last line, which must be blank (unless the -n option is specified). A DSN in a connection string: Note the leading semicolon on the connection string. $ iusql ";DSN=WebDB" MyID MyPWD -w -b < My.sql Options in the DSN may be overridden in the connection string: $ iusql ";DSN=WebDB;Driver=PostgreSQL ODBC;UID=MyID;PASSWORD=secret;Debug=1;CommLog=1" -v A string DSN: A string DSN may be provided in its entirety, with no file DSN reference at all: $ iusql ";Driver=PostgreSQL Unicode;UID=MyID;PASSWORD=secret" -v A password containing a semicolon (iusql): $ iusql WebDB MyID '{My;PWD};' $ iusql 'DSN=WebDB;UID=MyID;PWD={My;PWD};' TROUBLESHOOTING Cryptic error messages Re-run isql or iusql with the -v flag to get more information from errors, and/or enable Trace mode in odbcinst.ini. Missing driver definition Check that the driver name specified by the Driver entry in the odbc.ini data-source definition is present in odbcinst.ini and exactly matches the odbcinst.ini [section name]. Unloadable or incompatible driver If the ODBC driver is properly specified for the data source, it is possible that the driver is not loadable. Check for mix-ups between Unicode and ANSI drivers, and verify the driver paths in the odbcinst.ini [section name]. Unicode data sources with ANSI clients Some data sources are Unicode-only and require the use of iusql. If isql reports [IM002][unixODBC][Driver Manager]Data source name not found and no default driver specified [ISQL]ERROR: Could not SQLConnect but the data source and driver required are listed by odbcinst -q -d and odbcinst -q -s then try iusql. FILES /etc/odbc.ini Configuration file containing system-wide Data Source Name (DSN) definitions. See odbc.ini(5) for more information. $HOME/.odbc.ini Configuration file containing user-specific Data Source Name (DSN) definitions. See odbc.ini(5) for more information. SEE ALSO unixODBC(7), odbcinst(1), odbc.ini(5) "The unixODBC Administrator Manual (HTML)" AUTHORS The authors of unixODBC are Peter Harvey <pharvey@codebydesign.com> and Nick Gorham <nick@lurcher.org>. For a full list of contributors, refer to the AUTHORS file. COPYRIGHT unixODBC is licensed under the GNU Lesser General Public License. For details about the license, see the COPYING file. version 2.3.12 Thu 14 Jan 2021 isql(1)
trial
null
null
null
null
null
arm64-apple-darwin20.0.0-ld
The ld command combines several object files and libraries, resolves references, and produces an ouput file. ld can produce a final linked image (executable, dylib, or bundle), or with the -r option, produce another object file. If the -o option is not used, the output file produced is named "a.out". Universal The linker accepts universal (multiple-architecture) input files, but always creates a "thin" (single-architecture), standard Mach-O output file. The architecture for the output file is specified using the -arch option. If this option is not used, ld attempts to determine the output architecture by examining the object files in command line order. The first "thin" architecture determines that of the output file. If no input object file is a "thin" file, the native 32-bit architecture for the host is used. Usually, ld is not used directly. Instead the compiler driver invokes ld. The compiler driver can be passed multiple -arch options and it will create a universal final linked image by invoking ld multiple times and then running lipo(1) merge the outputs into a universal file. Layout The object files are loaded in the order in which they are specified on the command line. The segments and the sections in those segments will appear in the output file in the order they are encountered in the object files being linked. All zero fill sections will appear after all non- zero fill sections in their segments. Sections created from files with the -sectcreate option will be laid out at after sections from .o files. The use of the -order_file option will alter the layout rules above, and move the symbols specified to start of their section. Libraries A static library (aka static archive) is a collection of .o files with a table of contents that lists the global symbols in the .o files. ld will only pull .o files out of a static library if needed to resolve some symbol reference. Unlike traditional linkers, ld will continually search a static library while linking. There is no need to specify a static library multiple times on the command line. A dynamic library (aka dylib or framework) is a final linked image. Putting a dynamic library on the command line causes two things: 1) The generated final linked image will have encoded that it depends on that dynamic library. 2) Exported symbols from the dynamic library are used to resolve references. Both dynamic and static libraries are searched as they appear on the command line. Search paths ld maintains a list of directories to search for a library or framework to use. The default library search path is /usr/lib then /usr/local/lib. The -L option will add a new library search path. The default framework search path is /Library/Frameworks then /System/Library/Frameworks. (Note: previously, /Network/Library/Frameworks was at the end of the default path. If you need that functionality, you need to explicitly add -F/Network/Library/Frameworks). The -F option will add a new framework search path. The -Z option will remove the standard search paths. The -syslibroot option will prepend a prefix to all search paths. Two-level namespace By default all references resolved to a dynamic library record the library to which they were resolved. At runtime, dyld uses that information to directly resolve symbols. The alternative is to use the -flat_namespace option. With flat namespace, the library is not recorded. At runtime, dyld will search each dynamic library in load order when resolving symbols. This is slower, but more like how other operating systems resolve symbols. Indirect dynamic libraries If the command line specifies to link against dylib A, and when dylib A was built it linked against dylib B, then B is considered an indirect dylib. When linking for two-level namespace, ld does not look at indirect dylibs, except when re-exported by a direct dylibs. On the other hand when linking for flat namespace, ld does load all indirect dylibs and uses them to resolve references. Even though indirect dylibs are specified via a full path, ld first uses the specified search paths to locate each indirect dylib. If one cannot be found using the search paths, the full path is used. Dynamic libraries undefines When linking for two-level namespace, ld does not verify that undefines in dylibs actually exist. But when linking for flat namespace, ld does check that all undefines from all loaded dylibs have a matching definition. This is sometimes used to force selected functions to be loaded from a static library.
ld – linker
ld files... [options] [-o outputfile]
Options that control the kind of output -execute The default. Produce a mach-o main executable that has file type MH_EXECUTE. -dylib Produce a mach-o shared library that has file type MH_DYLIB. -bundle Produce a mach-o bundle that has file type MH_BUNDLE. -r Merges object files to produce another mach-o object file with file type MH_OBJECT. -dylinker Produce a mach-o dylinker that has file type MH_DYLINKER. Only used when building dyld. -dynamic The default. Implied by -dylib, -bundle, or -execute -static Produces a mach-o file that does not use the dyld. Only used building the kernel. -preload Produces a mach-o file in which the mach_header, load commands, and symbol table are not in any segment. This output type is used for firmware or embedded development where the segments are copied out of the mach-o into ROM/Flash. -arch arch_name Specifies which architecture (e.g. ppc, ppc64, i386, x86_64) the output file should be. -o path Specifies the name and location of the output file. If not specified, `a.out' is used. Options that control libraries -lx This option tells the linker to search for libx.dylib or libx.a in the library search path. If string x is of the form y.o, then that file is searched for in the same places, but without prepending `lib' or appending `.a' or `.dylib' to the filename. -weak-lx This is the same as the -lx but forces the library and all references to it to be marked as weak imports. That is, the library is allowed to be missing at runtime. -weak_library path_to_library This is the same as listing a file name path to a library on the link line except that it forces the library and all references to it to be marked as weak imports. -reexport-lx This is the same as the -lx but specifies that the all symbols in library x should be available to clients linking to the library being created. This was previously done with a separate -sub_library option. -reexport_library path_to_library This is the same as listing a file name path to a library on the link line and it specifies that the all symbols in library path should be available to clients linking to the library being created. This was previously done with a separate -sub_library option. -upward-lx This is the same as the -lx but specifies that the dylib is an upward dependency. -upward_library path_to_library This is the same as listing a file name path to a library on the link line but also marks the dylib as an upward dependency. -Ldir Add dir to the list of directories in which to search for libraries. Directories specified with -L are searched in the order they appear on the command line and before the default search path. In Xcode4 and later, there can be a space between the -L and directory. -Z Do not search the standard directories when searching for libraries and frameworks. -syslibroot rootdir Prepend rootdir to all search paths when searching for libraries or frameworks. -search_paths_first This is now the default (in Xcode4 tools). When processing -lx the linker now searches each directory in its library search paths for `libx.dylib' then `libx.a' before the moving on to the next path in the library search path. -search_dylibs_first Changes the searching behavior for libraries. The default is that when processing -lx the linker searches each directory in its library search paths for `libx.dylib' then `libx.a'. This option changes the behavior to first search for a file of the form `libx.dylib' in each directory in the library search path, then a file of the form `libx.a' is searched for in the library search paths. This option restores the search behavior of the linker prior to Xcode4. -framework name[,suffix] This option tells the linker to search for `name.framework/name' the framework search path. If the optional suffix is specified the framework is first searched for the name with the suffix and then without (e.g. look for `name.framework/name_suffix' first, if not there try `name.framework/name'). -weak_framework name[,suffix] This is the same as the -framework name[,suffix] but forces the framework and all references to it to be marked as weak imports. -reexport_framework name[,suffix] This is the same as the -framework name[,suffix] but also specifies that the all symbols in that framework should be available to clients linking to the library being created. This was previously done with a separate -sub_umbrella option. -upward_framework name[,suffix] This is the same as the -framework name[,suffix] but also specifies that the framework is an upward dependency. -Fdir Add dir to the list of directories in which to search for frameworks. Directories specified with -F are searched in the order they appear on the command line and before the default search path. In Xcode4 and later, there can be a space between the -F and directory. -all_load Loads all members of static archive libraries. -ObjC Loads all members of static archive libraries that implement an Objective-C class or category. -force_load path_to_archive Loads all members of the specified static archive library. Note: -all_load forces all members of all archives to be loaded. This option allows you to target a specific archive. Options that control additional content -sectcreate segname sectname file The section sectname in the segment segname is created from the contents of file file. The combination of segname and sectname must be unique Ð there cannot already be a section (segname,sectname) from any other input. -filelist file[,dirname] Specifies that the linker should link the files listed in file. This is an alternative to listing the files on the command line. The file names are listed one per line separated only by newlines. (Spaces and tabs are assumed to be part of the file name.) If the optional directory name, dirname is specified, it is prepended to each name in the list file. -dtrace file Enables dtrace static probes when producing a final linked image. The file file must be a DTrace script which declares the static probes. Options that control optimizations -dead_strip Remove functions and data that are unreachable by the entry point or exported symbols. -order_file file Alters the order in which functions and data are laid out. For each section in the output file, any symbol in that section that are specified in the order file file is moved to the start of its section and laid out in the same order as in the order file file. Order files are text files with one symbol name per line. Lines starting with a # are comments. A symbol name may be optionally preceded with its object file leaf name and a colon (e.g. foo.o:_foo). This is useful for static functions/data that occur in multiple files. A symbol name may also be optionally preceded with the architecture (e.g. ppc:_foo or ppc:foo.o:_foo). This enables you to have one order file that works for multiple architectures. Literal c-strings may be ordered by by quoting the string (e.g. "Hello, world\n") in the order file. -no_order_inits When the -order_file option is not used, the linker lays out functions in object file order and it moves all initializer routines to the start of the __text section and terminator routines to the end. Use this option to disable the automatic rearrangement of initializers and terminators. -no_order_data By default the linker reorders global data in the __DATA segment so that all global variables that dyld will need to adjust at launch time will early in the __DATA segment. This reduces the number of dirty pages at launch time. This option disables that optimization. -platform_version platform min_version sdk_version This is set to indicate the platform, oldest supported version of that platform that output is to be used on, and the SDK that the output was built against. platform is a numeric value as defined in <mach-o/loader.h>, or it may be one of the following strings: • macos • ios • tvos • watchos • bridgeos • mac-catalyst • ios-sim • tvos-sim • watchos-sim • driverkit Specifying a newer min or SDK version enables the linker to assume features of that OS or SDK in the output file. The format of min_version and sdk_version is a version number such as 10.13 or 10.14 -macos_version_min version This is set to indicate the oldest macOS version that that the output is to be used on. Specifying a later version enables the linker to assumes features of that OS in the output file. The format of version is a macOS version number such as 10.9 or 10.14 -ios_version_min version This is set to indicate the oldest iOS version that that the output is to be used on. Specifying a later version enables the linker to assumes features of that OS in the output file. The format of version is an iOS version number such as 3.1 or 4.0 -image_base address Specifies the preferred load address for a dylib or bundle. The argument address is a hexadecimal number with an optional leading 0x. By choosing non-overlapping address for all dylibs and bundles that a program loads, launch time can be improved because dyld will not need to "rebase" the image (that is, adjust pointers within the image to work at the loaded address). It is often easier to not use this option, but instead use the rebase(1) tool, and give it a list of dylibs. It will then choose non-overlapping addresses for the list and rebase them all. This option is also called -seg1addr for compatibility. -no_implicit_dylibs When creating a two-level namespace final linked image, normally the linker will hoist up public dylibs that are implicitly linked to make the two-level namespace encoding more efficient for dyld. For example, Cocoa re-exports AppKit and AppKit re-exports Foundation. If you link with -framework Cocoa and use a symbol from Foundation, the linker will implicitly add a load command to load Foundation and encode the symbol as coming from Foundation. If you use this option, the linker will not add a load command for Foundation and encode the symbol as coming from Cocoa. Then at runtime dyld will have to search Cocoa and AppKit before finding the symbol in Foundation. -exported_symbols_order file When targeting Mac OS X 10.6 or later, the format of the exported symbol information can be optimized to make lookups of popular symbols faster. This option is used to pass a file containing a list of the symbols most frequently used by clients of the dynamic library being built. Not all exported symbols need to be listed. -no_zero_fill_sections By default the linker moves all zero fill sections to the end of the __DATA segment and configures them to use no space on disk. This option suppresses that optimization, so zero-filled data occupies space on disk in a final linked image. -merge_zero_fill_sections Causes all zero-fill sections in the __DATA segment to be merged into one __zerofill section. -no_branch_islands Disables linker creation of branch islands which allows images to be created that are larger than the maximum branch distance. Useful with -preload when code is in multiple sections but all are within the branch range. Options when creating a dynamic library (dylib) -install_name name Sets an internal "install path" (LC_ID_DYLIB) in a dynamic library. Any clients linked against the library will record that path as the way dyld should locate this library. If this option is not specified, then the -o path will be used. This option is also called -dylib_install_name for compatibility. -mark_dead_strippable_dylib Specifies that the dylib being built can be dead strip by any client. That is, the dylib has no initialization side effects. So if a client links against the dylib, but never uses any symbol from it, the linker can optimize away the use of the dylib. -compatibility_version number Specifies the compatibility version number of the library. When a library is loaded by dyld, the compatibility version is checked and if the program's version is greater that the library's version, it is an error. The format of number is X[.Y[.Z]] where X must be a positive non-zero number less than or equal to 65535, and .Y and .Z are optional and if present must be non-negative numbers less than or equal to 255. If the compatibility version number is not specified, it has a value of 0 and no checking is done when the library is used. This option is also called -dylib_compatibility_version for compatibility. -current_version number Specifies the current version number of the library. The current version of the library can be obtained programmatically by the user of the library so it can determine exactly which version of the library it is using. The format of number is X[.Y[.Z]] where X must be a positive non-zero number less than or equal to 65535, and .Y and .Z are optional and if present must be non-negative numbers less than or equal to 255. If the version number is not specified, it has a value of 0. This option is also called -dylib_current_version for compatibility. Options when creating a main executable -pie This makes a special kind of main executable that is position independent (PIE). On Mac OS X 10.5 and later, the OS the OS will load a PIE at a random address each time it is executed. You cannot create a PIE from .o files compiled with -mdynamic-no- pic. That means the codegen is less optimal, but the address randomization adds some security. When targeting Mac OS X 10.7 or later PIE is the default for main executables. -no_pie Do not make a position independent executable (PIE). This is the default, when targeting 10.6 and earlier. -pagezero_size size By default the linker creates an unreadable segment starting at address zero named __PAGEZERO. Its existence will cause a bus error if a NULL pointer is dereferenced. The argument size is a hexadecimal number with an optional leading 0x. If size is zero, the linker will not generate a page zero segment. By default on 32-bit architectures the page zero size is 4KB. On 64-bit architectures, the default size is 4GB. -stack_size size Specifies the maximum stack size for the main thread in a program. Without this option a program has a 8MB stack. The argument size is a hexadecimal number with an optional leading 0x. The size should be a multiple of the architecture's page size (4KB or 16KB). -allow_stack_execute Marks executable so that all stacks in the task will be given stack execution privilege. This includes pthread stacks. -export_dynamic Preserves all global symbols in main executables during LTO. Without this option, Link Time Optimization is allowed to inline and remove global functions. This option is used when a main executable may load a plug-in which requires certain symbols from the main executable. Options when creating a bundle -bundle_loader executable This specifies the executable that will be loading the bundle output file being linked. Undefined symbols from the bundle are checked against the specified executable like it was one of the dynamic libraries the bundle was linked with. Options when creating an object file -keep_private_externs Don't turn private external (aka visibility=hidden) symbols into static symbols, but rather leave them as private external in the resulting object file. -d Force definition of common symbols. That is, transform tentative definitions into real definitions. Options that control symbol resolution -exported_symbols_list filename The specified filename contains a list of global symbol names that will remain as global symbols in the output file. All other global symbols will be treated as if they were marked as __private_extern__ (aka visibility=hidden) and will not be global in the output file. The symbol names listed in filename must be one per line. Leading and trailing white space are not part of the symbol name. Lines starting with # are ignored, as are lines with only white space. Some wildcards (similar to shell file matching) are supported. The * matches zero or more characters. The ? matches one character. [abc] matches one character which must be an 'a', 'b', or 'c'. [a-z] matches any single lower case letter from 'a' to 'z'. -exported_symbol symbol The specified symbol is added to the list of global symbols names that will remain as global symbols in the output file. This option can be used multiple times. For short lists, this can be more convenient than creating a file and using -exported_symbols_list. -unexported_symbols_list file The specified filename contains a list of global symbol names that will not remain as global symbols in the output file. The symbols will be treated as if they were marked as __private_extern__ (aka visibility=hidden) and will not be global in the output file. The symbol names listed in filename must be one per line. Leading and trailing white space are not part of the symbol name. Lines starting with # are ignored, as are lines with only white space. Some wildcards (similar to shell file matching) are supported. The * matches zero or more characters. The ? matches one character. [abc] matches one character which must be an 'a', 'b', or 'c'. [a-z] matches any single lower case letter from 'a' to 'z'. -unexported_symbol symbol The specified symbol is added to the list of global symbols names that will not remain as global symbols in the output file. This option can be used multiple times. For short lists, this can be more convenient than creating a file and using -unexported_symbols_list. -reexported_symbols_list file The specified filename contains a list of symbol names that are implemented in a dependent dylib and should be re-exported through the dylib being created. -alias symbol_name alternate_symbol_name Create an alias named alternate_symbol_name for the symbol symbol_name. By default the alias symbol has global visibility. This option was previous the -idef:indir option. -alias_list filename The specified filename contains a list of aliases. The symbol name and its alias are on one line, separated by whitespace. Lines starting with # are ignored. -flat_namespace Alters how symbols are resolved at build time and runtime. With -two_levelnamespace (the default), the linker only searches dylibs on the command line for symbols, and records in which dylib they were found. With -flat_namespace, the linker searches all dylibs on the command line and all dylibs those original dylibs depend on. The linker does not record which dylib an external symbol came from, so at runtime dyld again searches all images and uses the first definition it finds. In addition, any undefines in loaded flat_namespace dylibs must be resolvable at build time. -u symbol_name Specified that symbol symbol_name must be defined for the link to succeed. This is useful to force selected functions to be loaded from a static library. -U symbol_name Specified that it is ok for symbol_name to have no definition. With -two_levelnamespace, the resulting symbol will be marked dynamic_lookup which means dyld will search all loaded images. -undefined treatment Specifies how undefined symbols are to be treated. Options are: error, warning, suppress, or dynamic_lookup. The default is error. -rpath path Add path to the runpath search path list for image being created. At runtime, dyld uses the runpath when searching for dylibs whose load path begins with @rpath/. -commons treatment Specifies how commons (aka tentative definitions) are resolved with respect to dylibs. Options are: ignore_dylibs, use_dylibs, error. The default is ignore_dylibs which means the linker will turn a tentative definition in an object file into a real definition and not even check dylibs for conflicts. The dylibs option means the linker should check linked dylibs for definitions and use them to replace tentative definitions from object files. The error option means the linker should issue an error whenever a tentative definition in an object file conflicts with an external symbol in a linked dylib. See also -warn_commons. Options for introspecting the linker -why_load Log why each object file in a static library is loaded. That is, what symbol was needed. Also called -whyload for compatibility. -why_live symbol_name Logs a chain of references to symbol_name. Only applicable with -dead_strip . It can help debug why something that you think should be dead strip removed is not removed. See -exported_symbols_list for syntax and use of wildcards. -print_statistics Logs information about the amount of memory and time the linker used. -t Logs each file (object, archive, or dylib) the linker loads. Useful for debugging problems with search paths where the wrong library is loaded. -whatsloaded Logs just object files the linker loads. -order_file_statistics Logs information about the processing of a -order_file. -map map_file_path Writes a map file to the specified path which details all symbols and their addresses in the output image. Options for controling symbol table optimizations -S Do not put debug information (STABS or DWARF) in the output file. -x Do not put non-global symbols in the output file's symbol table. Non-global symbols are useful when debugging and getting symbol names in back traces, but are not used at runtime. If -x is used with -r non-global symbol names are not removed, but instead replaced with a unique, dummy name that will be automatically removed when linked into a final linked image. This allows dead code stripping, which uses symbols to break up code and data, to work properly and provides the security of having source symbol names removed. -non_global_symbols_strip_list filename The specified filename contains a list of non-global symbol names that should be removed from the output file's symbol table. All other non-global symbol names will remain in the output files symbol table. See -exported_symbols_list for syntax and use of wildcards. -non_global_symbols_no_strip_list filename The specified filename contains a list of non-global symbol names that should be remain in the output file's symbol table. All other symbol names will be removed from the output file's symbol table. See -exported_symbols_list for syntax and use of wildcards. -oso_prefix prefix-path When generating the debug map, the linker will remove the specified prefix-path from the path in OSO symbols. This can be used so to help build servers generate identical binaries. Options for Bitcode build flow -bitcode_bundle Generates an embedded bitcode bundle in the output binary. The bitcode bundle is embedded in __LLVM, __bundle section. This option requires all the object files, static libraries and user frameworks/dylibs contain bitcode. Note: not all the linker options are supported to use together with -bitcode_bundle. -bitcode_hide_symbols Specifies this option together with -bitcode_bundle to hide all non-exported symbols from output bitcode bundle. The hide symbol process might not be reversible. To obtain a reverse mapping file to recover all the symbols, use -bitcode_symbol_map option. -bitcode_symbol_map path Specifies the output for bitcode symbol reverse mapping (.bcsymbolmap). If path is an existing directory, UUID.bcsymbolmap will be written to that directory. Otherwise, the reverse map will be written to a file at path. Rarely used Options -v Prints the version of the linker. -version_details Prints the version info about the linker in JSON -no_weak_imports Error if any symbols are weak imports (i.e. allowed to be unresolved (NULL) at runtime). Useful for config based projects that assume they are built and run on the same OS version. -no_deduplicate Don't run deduplication pass in linker -verbose_deduplicate Prints names of functions that are eliminated by deduplication and total code savings size. -no_inits Error if the output contains any static initializers -no_warn_inits Do not warn if the output contains any static initializers -debug_variant Do not warn about issues that are only problems for binaries shipping to customers. -unaligned_pointers treatment Specifies how unaligned pointers in __DATA segments should be handled. Options are: 'warning', 'error', or 'suppress'. The default for arm64e is 'error' and for all other architectures it is 'suppress'. -dirty_data_list filename Specifies a file containing the names of data symbols likely to be dirtied. If the linker is creating a __DATA_DIRTY segment, those symbols will be moved to that segment. -max_default_common_align value Any common symbols (aka tentative definitions, or uninitialized (zeroed) variables) that have no explicit alignment are normally aligned to their next power of two size (e.g. a 240 byte array is 256 aligned). This option lets you reduce the max alignment. For instance, a value of 0x40 would reduce the alignment for a 240 byte array to 64 bytes (instead of 256). The value specified must be a hexadecimal power of two If -max_default_common_align is not used, the default alignment is already limited to 0x8 (2^3) bytes for -preload and 0x8000 (2^15) for all other output types. -move_to_rw_segment segment_name filename Moves data symbols to another segment. The command line option specifies the target segment name and a path to a file containing a list of symbols to move. Comments can be added to the symbol file by starting a line with a #. If there are multiple instances of a symbol name (for instance a "static int foo=5;" in multiple files) the symbol name in the symbol list file can be prefixed with the object file name (e.g. "init.o:_foo") to move a specific instance. -move_to_ro_segment segment_name filename Moves code symbols to another segment. The command line option specifies the target segment name and a path to a file containing a list of symbols to move. Comments can be added to the symbol file by starting a line with a #. If there are multiple instances of a symbol name (for instance a "static int foo() {}" in multiple files) the symbol name in the symbol list file can be prefixed with the object file name (e.g. "init.o:_foo") to move a specific instance. -rename_section orgSegment orgSection newSegment newSection Renames section orgSegment/orgSection to newSegment/newSection. -rename_segment orgSegment newSegment Renames all sections with orgSegment segment name to have newSegment segment name. -trace_symbol_layout For using in debugging -rename_section, -rename_segment, -move_to_ro_segment, and -move_to_rw_segment. This option prints out a line show where and why each symbol was moved. Note: These options do chain. For each symbol, the linker first checks -move_to_ro_segment and -move_to_rw_segment. Next it applies any -rename_section options, and lastly and -rename_segment options. -section_order segname colon_separated_section_list Only for use with -preload. Specifies the order that sections with the specified segment should be layout out. For example: "-section_order __ROM __text:__const:__cstring". -segment_order colon_separated_segment_list Only for use with -preload. Specifies the order segments should be layout out. For example: "-segment_order __ROM:__ROM2:__RAM". -allow_heap_execute Normally i386 main executables will be marked so that the Mac OS X 10.7 and later kernel will only allow pages with the x-bit to execute instructions. This option overrides that behavior and allows instructions on any page to be executed. -application_extension Specifies that the code is being linked for use in an application extension. The linker will then validiate that any dynamic libraries linked against are safe for use in application extensions. -no_application_extension Specifies that the code is being linked is not safe for use in an application extension. For instance, can be used when creating a framework that should not be used in an application extension. -fatal_warnings Causes the linker to exit with a non-zero value if any warnings were emitted. -no_eh_labels Normally in -r mode, the linker produces .eh labels on all FDEs in the __eh_frame section. This option suppresses those labels. Those labels are not needed by the Mac OS X 10.6 linker but are needed by earlier linker tools. -warn_compact_unwind When producing a final linked image, the linker processes the __eh_frame section and produces an __unwind_info section. Most FDE entries in the __eh_frame can be represented by a 32-bit value in the __unwind_info section. The option issues a warning for any function whose FDE cannot be expressed in the compact unwind format. -warn_weak_exports Issue a warning if the resulting final linked image contains weak external symbols. Such symbols require dyld to do extra work at launch time to coalesce those symbols. -no_weak_exports Issue an erro if the resulting final linked image contains weak external symbols. Such symbols require dyld to do extra work at launch time to coalesce those symbols. -objc_gc_compaction Marks the Objective-C image info in the final linked image with the bit that says that the code was built to work the compacting garbage collection. -objc_gc Verifies all code was compiled with -fobjc-gc or -fobjc-gc-only. -objc_gc_only Verifies all code was compiled with -fobjc-gc-only. -dead_strip_dylibs Remove dylibs that are unreachable by the entry point or exported symbols. That is, suppresses the generation of load command commands for dylibs which supplied no symbols during the link. This option should not be used when linking against a dylib which is required at runtime for some indirect reason such as the dylib has an important initializer. -allow_sub_type_mismatches Normally the linker considers different cpu-subtype for ARM (e.g. armv4t and armv6) to be different different architectures that cannot be mixed at build time. This option relaxes that requirement, allowing you to mix object files compiled for different ARM subtypes. -no_uuid Do not generate an LC_UUID load command in the output file. -root_safe Sets the MH_ROOT_SAFE bit in the mach header of the output file. -setuid_safe Sets the MH_SETUID_SAFE bit in the mach header of the output file. -interposable Indirects access to all to exported symbols when creating a dynamic library. -init symbol_name The specified symbol_name will be run as the first initializer. Only used when creating a dynamic library. -sub_library library_name The specified dylib will be re-exported. For example the library_name for /usr/lib/libobjc_profile.A.dylib would be libobjc. Only used when creating a dynamic library. -sub_umbrella framework_name The specified framework will be re-exported. Only used when creating a dynamic library. -allowable_client name Restricts what can link against the dynamic library being created. By default any code can link against any dylib. But if a dylib is supposed to be private to a small set of clients, you can formalize that by adding a -allowable_client for each client. If a client is libfoo.1.dylib its -allowable_client name would be "foo". If a client is Foo.framework its -allowable_client name would be "Foo". For the degenerate case where you want no one to ever link against a dylib, you can set the -allowable_client to "!". -client_name name Enables a bundle to link against a dylib that was built with -allowable_client. The name specified must match one of the -allowable_client names specified when the dylib was created. -umbrella framework_name Specifies that the dylib being linked is re-exported through an umbrella framework of the specified name. -headerpad size Specifies the minimum space for future expansion of the load commands. Only useful if intend to run install_name_tool to alter the load commands later. Size is a hexadecimal number. -headerpad_max_install_names Automatically adds space for future expansion of load commands such that all paths could expand to MAXPATHLEN. Only useful if intend to run install_name_tool to alter the load commands later. -bind_at_load Sets a bit in the mach header of the resulting binary which tells dyld to bind all symbols when the binary is loaded, rather than lazily. -force_flat_namespace Sets a bit in the mach header of the resulting binary which tells dyld to not only use flat namespace for the binary, but force flat namespace binding on all dylibs and bundles loaded in the process. Can only be used when linking main executables. -sectalign segname sectname value The section named sectname in the segment segname will have its alignment set to value, where value is a hexadecimal number that must be an integral power of 2. -stack_addr address Specifies the initial address of the stack pointer value, where value is a hexadecimal number rounded to a page boundary. -segprot segname max_prot init_prot Specifies the maximum and initial virtual memory protection of the named segment, name, to be max and init ,respectively. The values for max and init are any combination of the characters `r' (for read), `w' (for write), `x' (for execute) and `-' (no access). -seg_addr_table filename Specifies a file containing base addresses for dynamic libraries. Each line of the file is a hexadecimal base address followed by whitespace then the install name of the corresponding dylib. The # character denotes a comment. -segs_read_write_addr address Allows a dynamic library to be built where the read-only and read-write segments are not contiguous. The address specified is a hexadecimal number that indicates the base address for the read-write segments. -segs_read_only_addr address Allows a dynamic library to be built where the read-only and read-write segments are not contiguous. The address specified is a hexadecimal number that indicates the base address for the read-only segments. -segaddr name address Specifies the starting address of the segment named name to be address. The address must be a hexadecimal number that is a multiple of 4K page size. -seg_page_size name size Specifies the page size used by the specified segment. By default the page size is 4096 for all segments. The linker will lay out segments such that size of a segment is always an even multiple of its page size. -dylib_file install_name:file_name Specifies that a dynamic shared library is in a different location than its standard location. Use this option when you link with a library that is dependent on a dynamic library, and the dynamic library is in a location other than its default location. install_name specifies the path where the library normally resides. file_name specifies the path of the library you want to use instead. For example, if you link to a library that depends upon the dynamic library libsys and you have libsys installed in a nondefault location, you would use this option: -dylib_file /lib/libsys_s.A.dylib:/me/lib/libsys_s.A.dylib. -prebind The created output file will be in the prebound format. This was used in Mac OS X 10.3 and earlier to improve launch performance. -weak_reference_mismatches treatment Specifies what to do if a symbol is weak-imported in one object file but not weak-imported in another. The valid treatments are: error, weak, or non-weak. The default is non-weak. -read_only_relocs treatment Enables the use of relocations which will cause dyld to modify (copy-on-write) read-only pages. The compiler will normally never generate such code. -force_cpusubtype_ALL The is only applicable with -arch ppc. It tells the linker to ignore the PowerPC cpu requirements (e.g. G3, G4 or G5) encoded in the object files and mark the resulting binary as runnable on any PowerPC cpu. -dylinker_install_name path Only used when building dyld. -no_arch_warnings Suppresses warning messages about files that have the wrong architecture for the -arch flag -arch_errors_fatal Turns into errors, warnings about files that have the wrong architecture for the -arch flag. -e symbol_name Specifies the entry point of a main executable. By default the entry name is "start" which is found in crt1.o which contains the glue code need to set up and call main(). -w Suppress all warning messages -final_output name Specifies the install name of a dylib if -install_name is not used. This option is used by compiler driver when it is invoked with multiple -arch arguments. -arch_multiple Specifes that the linker should augment error and warning messages with the architecture name. This option is used by compiler driver when it is invoked with multiple -arch arguments. -twolevel_namespace_hints Specifies that hints should be added to the resulting binary that can help speed up runtime binding by dyld as long as the libraries being linked against have not changed. -dot path Create a file at the specified path containing a graph of symbol dependencies. The .dot file can be viewed in GraphViz. -keep_relocs Add section based relocation records to a final linked image. These relocations are ignored at runtime by dyld. -warn_stabs Print a warning when the linker cannot do a BINCL/EINCL optimization because the compiler put a bad stab symbol inside a BINCL/EINCL range. -warn_commons Print a warning whenever the a tentative definition in an object file is found and a external symbol by the same name is also found in a linked dylib. This often means that the extern keyword is missing from a variable declaration in a header file. -read_only_stubs [i386 only] Makes the __IMPORT segment of a final linked images read-only. This option makes a program slightly more secure in that the JMP instructions in the i386 fast stubs cannot be easily overwritten by malicious code. The downside is the dyld must use mprotect() to temporarily make the segment writable while it is binding the stubs. -slow_stubs [i386 only] Instead of using single JMP instruction stubs, the linker creates code in the __TEXT segment which calls through a lazy pointer in the __DATA segment. -interposable_list filename The specified filename contains a list of global symbol names that should always be accessed indirectly. For instance, if libSystem.dylib is linked such that _malloc is interposable, then calls to malloc() from within libSystem will go through a dyld stub and could potentially indirected to an alternate malloc. If libSystem.dylib were built without making _malloc interposable then if _malloc was interposed at runtime, calls to malloc from with libSystem would be missed (not interposed) because they would be direct calls. -no_function_starts By default the linker creates a compress table of function start addresses in the LINKEDIT of final linked image. This option disables that behavior. -no_objc_category_merging By default when producing final linked image, the linker will optimize Objective-C classes by merging any categories on a class into the class. Both the class and its categories must be defined in the image being linked for the optimization to occur. Using this option disables that behavior. -object_path_lto filename When performing Link Time Optimization (LTO) and a temporary mach-o object file is needed, if this option is used, the temporary file will be stored at the specified path and remain after the link is complete. Without the option, the linker picks a path and deletes the object file before the linker tool completes, thus tools such as the debugger or dsymutil will not be able to access the DWARF debug info in the temporary object file. -lto_library path When performing Link Time Optimization (LTO), the linker normally loads libLTO.14.dylib relative to the linker binary (../lib/libLTO.14.dylib). This option allows the user to specify the path to a specific libLTO.14.dylib to load instead. -cache_path_lto path When performing Incremental Link Time Optimization (LTO), use this directory as a cache for incremental rebuild. -prune_interval_lto seconds When performing Incremental Link Time Optimization (LTO), the cache will pruned after the specified interval. A value 0 will force pruning to occur and a value of -1 will disable pruning. -prune_after_lto seconds When pruning the cache for Incremental Link Time Optimization (LTO), the cache entries are removed after the specificied interval. -max_relative_cache_size_lto percent When performing Incremental Link Time Optimization (LTO), the cache will be pruned to not go over this percentage of the free space. I.e. a value of 100 would indicate that the cache may fill the disk, and a value of 50 would indicate that the cache size will be kept under the free disk space. -page_align_data_atoms During development, this option can be used to space out all global variables so each is on a separate page. This is useful when analyzing dirty and resident pages. The information can then be used to create an order file to cluster commonly used/dirty globals onto the same page(s). -not_for_dyld_shared_cache Normally, the linker will add extra info to dylibs with -install_name starting with /usr/lib or /System/Library/ that allows the dylib to be placed into the dyld shared cache. Adding this option tells the linker to not add that extra info. Obsolete Options -segalign value All segments must be page aligned. -seglinkedit Object files (MH_OBJECT) with a LINKEDIT segment are no longer supported. This option is obsolete. -noseglinkedit This is the default. This option is obsolete. -fvmlib Fixed VM shared libraries (MH_FVMLIB) are no longer supported. This option is obsolete. -sectobjectsymbols segname sectname Adding a local label at a section start is no longer supported. This option is obsolete. -nofixprebinding The MH_NOFIXPREBINDING bit of mach_headers has been ignored since Mac OS X 10.3.9. This option is obsolete. -noprebind_all_twolevel_modules Multi-modules in dynamic libraries have been ignored at runtime since Mac OS X 10.4.0. This option is obsolete. -prebind_all_twolevel_modules Multi-modules in dynamic libraries have been ignored at runtime since Mac OS X 10.4.0. This option is obsolete. -prebind_allow_overlap When using -prebind, the linker allows overlapping by default, so this option is obsolete. -noprebind LD_PREBIND is no longer supported as a way to force on prebinding, so there no longer needs to be a command line way to override LD_PREBIND. This option is obsolete. -sect_diff_relocs treatment This option was an attempt to warn about linking .o files compiled without -mdynamic-no-pic into a main executable, but the false positive rate generated too much noise to make the option useful. This option is obsolete. -run_init_lazily This option was removed in Mac OS X 10.2. -single_module This is now the default so does not need to be specified. -multi_module Multi-modules in dynamic libraries have been ignored at runtime since Mac OS X 10.4.0. This option is obsolete. -no_dead_strip_inits_and_terms The linker never dead strips initialization and termination routines. They are considered "roots" of the dead strip graph. -A basefile Obsolete incremental load format. This option is obsolete. -b Used with -A option to strip base file's symbols. This option is obsolete. Obsolete option to produce a load map. Use -map option instead. -Sn Don't strip any symbols. This is the default. This option is obsolete. -Si Optimize stabs debug symbols to remove duplicates. This is the default. This option is obsolete. -Sp Write minimal stabs which causes the debugger to open and read the original .o file for full stabs. This style of debugging is obsolete in Mac OS X 10.5. This option is obsolete. -X Strip local symbols that begin with 'L'. This is the default. This option is obsolete. -s Completely strip the output, including removing the symbol table. This file format variant is no longer supported. This option is obsolete. -m Don't treat multiple definitions as an error. This is no longer supported. This option is obsolete. -ysymbol Display each file in which symbol is used. This was previously used to debug where an undefined symbol was used, but the linker now automatically prints out all usages. The -why_live option can also be used to display what kept a symbol from being dead striped. This option is obsolete. -Y number Used to control how many occurrences of each symbol specified with -y would be shown. This option is obsolete. -nomultidefs Only used when linking an umbrella framework. Sets the MH_NOMULTIDEFS bit in the mach_header. The MH_NOMULTIDEFS bit has been obsolete since Mac OS X 10.4. This option is obsolete. -multiply_defined_unused treatment Previously provided a way to warn or error if any of the symbol definitions in the output file matched any definitions in dynamic library being linked. This option is obsolete. -multiply_defined treatment Previously provided a way to warn or error if any of the symbols used from a dynamic library were also available in another linked dynamic library. This option is obsolete. -private_bundle Previously prevented errors when -flat_namespace, -bundle, and -bundle_loader were used and the bundle contained a definition that conflicted with a symbol in the main executable. The linker no longer errors on such conflicts. This option is obsolete. -noall_load This is the default. This option is obsolete. -seg_addr_table_filename path Use path instead of the install name of the library for matching an entry in the seg_addr_table. This option is obsolete. -sectorder segname sectname orderfile Replaced by more general -order_file option. -sectorder_detail Produced extra logging about which entries from a sectorder entries were used. Replaced by -order_file_statistics. This option is obsolete. -lazy_framework name[,suffix] This is the same as the -framework name[,suffix] except that the linker will construct glue code so that the framework is not loaded until the first function in it is called. You cannot directly access data or Objective-C classes in a framework linked this way. This option is deprecated. -lazy-lx This is the same as the -lx but it is only for shared libraries and the linker will construct glue code so that the shared library is not loaded until the first function in it is called. This option is deprecated. -lazy_library path_to_library This is the same as listing a file name path to a shared library on the link line except that the linker will construct glue code so that the shared library is not loaded until the first function in it is called. This option is deprecated. SEE ALSO as(1), ar(1), cc(1), nm(1), otool(1) lipo(1), arch(3), dyld(3), Mach- O(5), strip(1), rebase(1) Darwin March 7, 2018 Darwin
null
glib-compile-schemas
null
null
null
null
null
dumppdf.py
null
null
null
null
null
webpmux
This manual page documents the webpmux command. webpmux can be used to create/extract from animated WebP files, as well as to add/extract/strip XMP/EXIF metadata and ICC profile. If a single file name (not starting with the character '-') is supplied as the argument, the command line arguments are actually tokenized from this file. This allows for easy scripting or using a large number of arguments.
webpmux - create animated WebP files from non-animated WebP images, extract frames from animated WebP images, and manage XMP/EXIF metadata and ICC profile.
webpmux -get GET_OPTIONS INPUT -o OUTPUT webpmux -set SET_OPTIONS INPUT -o OUTPUT webpmux -strip STRIP_OPTIONS INPUT -o OUTPUT webpmux -frame FRAME_OPTIONS [ -frame ... ] [ -loop LOOP_COUNT ] [ -bgcolor BACKGROUND_COLOR ] -o OUTPUT webpmux -duration DURATION OPTIONS [ -duration ... ] INPUT -o OUTPUT webpmux -info INPUT webpmux [-h|-help] webpmux -version webpmux argument_file_name
GET_OPTIONS (-get): icc Get ICC profile. exif Get EXIF metadata. xmp Get XMP metadata. frame n Get nth frame from an animated image. (n = 0 has a special meaning: last frame). SET_OPTIONS (-set) loop loop_count Set loop count on an animated file. Where: 'loop_count' must be in range [0, 65535]. bgcolor A,R,G,B Set the background color of the canvas on an animated file. where: 'A', 'R', 'G' and 'B' are integers in the range 0 to 255 specifying the Alpha, Red, Green and Blue component values respectively. icc file.icc Set ICC profile. Where: 'file.icc' contains the ICC profile to be set. exif file.exif Set EXIF metadata. Where: 'file.exif' contains the EXIF metadata to be set. xmp file.xmp Set XMP metadata. Where: 'file.xmp' contains the XMP metadata to be set. STRIP_OPTIONS (-strip) icc Strip ICC profile. exif Strip EXIF metadata. xmp Strip XMP metadata. DURATION_OPTIONS (-duration) Amend the duration of a specific interval of frames. This option is only effective on animated WebP and has no effect on a single-frame file. duration[,start[,end]] Where: duration is the duration for the interval in milliseconds (mandatory). Must be non-negative. start is the starting frame index of the interval (optional). end is the ending frame index (inclusive) of the interval (optional). The three typical usages of this option are: -duration d set the duration to 'd' for the whole animation. -duration d,f set the duration of frame 'f' to 'd'. -duration d,start,end set the duration to 'd' for the whole [start,end] interval. Note that the frames outside of the [start, end] interval will remain untouched. The 'end' value '0' has the special meaning 'last frame of the animation'. Reminder: frame indexing starts at '1'. FRAME_OPTIONS (-frame) Create an animated WebP file from multiple (non-animated) WebP images. file_i +di[+xi+yi[+mi[bi]]] Where: 'file_i' is the i'th frame (WebP format), 'xi','yi' specify the image offset for this frame, 'di' is the pause duration before next frame, 'mi' is the dispose method for this frame (0 for NONE or 1 for BACKGROUND) and 'bi' is the blending method for this frame (+b for BLEND or -b for NO_BLEND). Argument 'bi' can be omitted and will default to +b (BLEND). Also, 'mi' can be omitted if 'bi' is omitted and will default to 0 (NONE). Finally, if 'mi' and 'bi' are omitted then 'xi' and 'yi' can be omitted and will default to +0+0. -loop n Loop the frames n number of times. 0 indicates the frames should loop forever. Valid range is 0 to 65535 [Default: 0 (infinite)]. -bgcolor A,R,G,B Background color of the canvas. where: 'A', 'R', 'G' and 'B' are integers in the range 0 to 255 specifying the Alpha, Red, Green and Blue component values respectively [Default: 255,255,255,255]. INPUT Input file in WebP format. OUTPUT (-o) Output file in WebP format. Note: The nature of EXIF, XMP and ICC data is not checked and is assumed to be valid. 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/
Add ICC profile: webpmux -set icc image_profile.icc in.webp -o icc_container.webp Extract ICC profile: webpmux -get icc icc_container.webp -o image_profile.icc Strip ICC profile: webpmux -strip icc icc_container.webp -o without_icc.webp Add XMP metadata: webpmux -set xmp image_metadata.xmp in.webp -o xmp_container.webp Extract XMP metadata: webpmux -get xmp xmp_container.webp -o image_metadata.xmp Strip XMP metadata: webpmux -strip xmp xmp_container.webp -o without_xmp.webp Add EXIF metadata: webpmux -set exif image_metadata.exif in.webp -o exif_container.webp Extract EXIF metadata: webpmux -get exif exif_container.webp -o image_metadata.exif Strip EXIF metadata: webpmux -strip exif exif_container.webp -o without_exif.webp Create an animated WebP file from 3 (non-animated) WebP images: webpmux -frame 1.webp +100 -frame 2.webp +100+50+50 -frame 3.webp +100+50+50+1+b -loop 10 -bgcolor 255,255,255,255 -o anim_container.webp Get the 2nd frame from an animated WebP file: webpmux -get frame 2 anim_container.webp -o frame_2.webp Using -get/-set/-strip with input file name starting with '-': webpmux -set icc image_profile.icc -o icc_container.webp -- ---in.webp webpmux -get icc -o image_profile.icc -- ---icc_container.webp webpmux -strip icc -o without_icc.webp -- ---icc_container.webp AUTHORS webpmux 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 Vikas Arora <vikaas.arora@gmail.com>, for the Debian project (and may be used by others). SEE ALSO cwebp(1), dwebp(1), gif2webp(1) Please refer to https://developers.google.com/speed/webp/ for additional information. November 17, 2021 WEBPMUX(1)
tiffcmp
null
null
null
null
null
brotli
null
null
null
null
null
opentelemetry-bootstrap
null
null
null
null
null
undill
null
null
null
null
null
uic
null
null
null
null
null
bzless
Bzmore is a filter which allows examination of compressed or plain text files one screenful at a time on a soft-copy terminal. bzmore works on files compressed with bzip2 and also on uncompressed files. If a file does not exist, bzmore looks for a file of the same name with the addition of a .bz2 suffix. Bzmore normally pauses after each screenful, printing --More-- at the bottom of the screen. If the user then types a carriage return, one more line is displayed. If the user hits a space, another screenful is displayed. Other possibilities are enumerated later. Bzmore looks in the file /etc/termcap to determine terminal characteristics, and to determine the default window size. On a terminal capable of displaying 24 lines, the default window size is 22 lines. Other sequences which may be typed when bzmore pauses, and their effects, are as follows (i is an optional integer argument, defaulting to 1) : i<space> display i more lines, (or another screenful if no argument is given) ^D display 11 more lines (a ``scroll''). If i is given, then the scroll size is set to i. d same as ^D (control-D) iz same as typing a space except that i, if present, becomes the new window size. Note that the window size reverts back to the default at the end of the current file. is skip i lines and print a screenful of lines if skip i screenfuls and print a screenful of lines q or Q quit reading the current file; go on to the next (if any) e or q When the prompt --More--(Next file: file) is printed, this command causes bzmore to exit. s When the prompt --More--(Next file: file) is printed, this command causes bzmore to skip the next file and continue. = Display the current line number. i/expr search for the i-th occurrence of the regular expression expr. If the pattern is not found, bzmore goes on to the next file (if any). Otherwise, a screenful is displayed, starting two lines before the place where the expression was found. The user's erase and kill characters may be used to edit the regular expression. Erasing back past the first column cancels the search command. in search for the i-th occurrence of the last regular expression entered. !command invoke a shell with command. The character `!' in "command" are replaced with the previous shell command. The sequence "\!" is replaced by "!". :q or :Q quit reading the current file; go on to the next (if any) (same as q or Q). . (dot) repeat the previous command. The commands take effect immediately, i.e., it is not necessary to type a carriage return. Up to the time when the command character itself is given, the user may hit the line kill character to cancel the numerical argument being formed. In addition, the user may hit the erase character to redisplay the --More-- message. At any time when output is being sent to the terminal, the user can hit the quit key (normally control-\). Bzmore will stop sending output, and will display the usual --More-- prompt. The user may then enter one of the above commands in the normal manner. Unfortunately, some output is lost when this is done, due to the fact that any characters waiting in the terminal's output queue are flushed when the quit signal occurs. The terminal is set to noecho mode by this program so that the output can be continuous. What you type will thus not show on your terminal, except for the / and ! commands. If the standard output is not a teletype, then bzmore acts just like bzcat, except that a header is printed before each file. FILES /etc/termcap Terminal data base SEE ALSO more(1), less(1), bzip2(1), bzdiff(1), bzgrep(1) BZMORE(1)
bzmore, bzless - file perusal filter for crt viewing of bzip2 compressed text
bzmore [ name ... ] bzless [ name ... ] NOTE In the following description, bzless and less can be used interchangeably with bzmore and more.
null
null
tset
Tset initializes terminals. Tset first determines the type of terminal that you are using. This determination is done as follows, using the first terminal type found. 1. The terminal argument specified on the command line. 2. The value of the TERM environmental variable. 3. (BSD systems only.) The terminal type associated with the standard error output device in the /etc/ttys file. (On System-V-like UNIXes and systems using that convention, getty does this job by setting TERM according to the type passed to it by /etc/inittab.) 4. The default terminal type, “unknown”. If the terminal type was not specified on the command-line, the -m option mappings are then applied (see the section TERMINAL TYPE MAPPING for more information). Then, if the terminal type begins with a question mark (“?”), the user is prompted for confirmation of the terminal type. An empty response confirms the type, or, another type can be entered to specify a new type. Once the terminal type has been determined, the terminfo entry for the terminal is retrieved. If no terminfo entry is found for the type, the user is prompted for another terminal type. Once the terminfo entry is retrieved, the window size, backspace, interrupt and line kill characters (among many other things) are set and the terminal and tab initialization strings are sent to the standard error output. Finally, if the erase, interrupt and line kill characters have changed, or are not set to their default values, their values are displayed to the standard error output. Use the -c or -w option to select only the window sizing versus the other initialization. If neither option is given, both are assumed. When invoked as reset, @TSET@ sets cooked and echo modes, turns off cbreak and raw modes, turns on newline translation and resets any unset special characters to their default values before doing the terminal initialization described above. This is useful after a program dies leaving a terminal in an abnormal state. Note, you may have to type <LF>reset<LF> (the line-feed character is normally control-J) to get the terminal to work, as carriage-return may no longer work in the abnormal state. Also, the terminal will often not echo the command. The options are as follows: -c Set control characters and modes. -e Set the erase character to ch. -I Do not send the terminal or tab initialization strings to the terminal. -i Set the interrupt character to ch. -k Set the line kill character to ch. -m Specify a mapping from a port type to a terminal. See the section TERMINAL TYPE MAPPING for more information. -Q Do not display any values for the erase, interrupt and line kill characters. Normally @TSET@ displays the values for control characters which differ from the system's default values. -q The terminal type is displayed to the standard output, and the terminal is not initialized in any way. The option `-' by itself is equivalent but archaic. -r Print the terminal type to the standard error output. -s Print the sequence of shell commands to initialize the environment variable TERM to the standard output. See the section SETTING THE ENVIRONMENT for details. -V reports the version of ncurses which was used in this program, and exits. -w Resize the window to match the size deduced via setupterm. Normally this has no effect, unless setupterm is not able to detect the window size. The arguments for the -e, -i, and -k options may either be entered as actual characters or by using the `hat' notation, i.e., control-h may be specified as “^H” or “^h”. SETTING THE ENVIRONMENT It is often desirable to enter the terminal type and information about the terminal's capabilities into the shell's environment. This is done using the -s option. When the -s option is specified, the commands to enter the information into the shell's environment are written to the standard output. If the SHELL environmental variable ends in “csh”, the commands are for csh, otherwise, they are for sh. Note, the csh commands set and unset the shell variable noglob, leaving it unset. The following line in the .login or .profile files will initialize the environment correctly: eval `@TSET@ -s options ... ` TERMINAL TYPE MAPPING When the terminal is not hardwired into the system (or the current system information is incorrect) the terminal type derived from the /etc/ttys file or the TERM environmental variable is often something generic like network, dialup, or unknown. When @TSET@ is used in a startup script it is often desirable to provide information about the type of terminal used on such ports. The purpose of the -m option is to map from some set of conditions to a terminal type, that is, to tell @TSET@ “If I'm on this port at a particular speed, guess that I'm on that kind of terminal”. The argument to the -m option consists of an optional port type, an optional operator, an optional baud rate specification, an optional colon (“:”) character and a terminal type. The port type is a string (delimited by either the operator or the colon character). The operator may be any combination of “>”, “<”, “@”, and “!”; “>” means greater than, “<” means less than, “@” means equal to and “!” inverts the sense of the test. The baud rate is specified as a number and is compared with the speed of the standard error output (which should be the control terminal). The terminal type is a string. If the terminal type is not specified on the command line, the -m mappings are applied to the terminal type. If the port type and baud rate match the mapping, the terminal type specified in the mapping replaces the current type. If more than one mapping is specified, the first applicable mapping is used. For example, consider the following mapping: dialup>9600:vt100. The port type is dialup , the operator is >, the baud rate specification is 9600, and the terminal type is vt100. The result of this mapping is to specify that if the terminal type is dialup, and the baud rate is greater than 9600 baud, a terminal type of vt100 will be used. If no baud rate is specified, the terminal type will match any baud rate. If no port type is specified, the terminal type will match any port type. For example, -m dialup:vt100 -m :?xterm will cause any dialup port, regardless of baud rate, to match the terminal type vt100, and any non-dialup port type to match the terminal type ?xterm. Note, because of the leading question mark, the user will be queried on a default port as to whether they are actually using an xterm terminal. No whitespace characters are permitted in the -m option argument. Also, to avoid problems with meta-characters, it is suggested that the entire -m option argument be placed within single quote characters, and that csh users insert a backslash character (“\”) before any exclamation marks (“!”). HISTORY The @TSET@ command appeared in BSD 3.0. The ncurses implementation was lightly adapted from the 4.4BSD sources for a terminfo environment by Eric S. Raymond <esr@snark.thyrsus.com>. COMPATIBILITY The @TSET@ utility has been provided for backward-compatibility with BSD environments (under most modern UNIXes, /etc/inittab and getty(1) can set TERM appropriately for each dial-up line; this obviates what was @TSET@'s most important use). This implementation behaves like 4.4BSD tset, with a few exceptions specified here. The -S option of BSD tset no longer works; it prints an error message to stderr and dies. The -s option only sets TERM, not TERMCAP. Both of these changes are because the TERMCAP variable is no longer supported under terminfo-based ncurses, which makes @TSET@ -S useless (we made it die noisily rather than silently induce lossage). There was an undocumented 4.4BSD feature that invoking tset via a link named `TSET` (or via any other name beginning with an upper-case letter) set the terminal to use upper-case only. This feature has been omitted. The -A, -E, -h, -u and -v options were deleted from the @TSET@ utility in 4.4BSD. None of them were documented in 4.3BSD and all are of limited utility at best. The -a, -d, and -p options are similarly not documented or useful, but were retained as they appear to be in widespread use. It is strongly recommended that any usage of these three options be changed to use the -m option instead. The -n option remains, but has no effect. The -adnp options are therefore omitted from the usage summary above. It is still permissible to specify the -e, -i, and -k options without arguments, although it is strongly recommended that such usage be fixed to explicitly specify the character. As of 4.4BSD, executing @TSET@ as reset no longer implies the -Q option. Also, the interaction between the - option and the terminal argument in some historic implementations of @TSET@ has been removed. ENVIRONMENT The @TSET@ command uses these environment variables: SHELL tells @TSET@ whether to initialize TERM using sh or csh syntax. TERM Denotes your terminal type. Each terminal type is distinct, though many are similar. TERMCAP may denote the location of a termcap database. If it is not an absolute pathname, e.g., begins with a `/', @TSET@ removes the variable from the environment before looking for the terminal description. FILES /etc/ttys system port name to terminal type mapping database (BSD versions only). /usr/share/terminfo terminal capability database SEE ALSO csh(1), sh(1), stty(1), curs_terminfo(3X), tty(4), terminfo(5), ttys(5), environ(7) This describes ncurses version 5.7 (patch 20081102). @TSET@(1)
@TSET@, reset - terminal initialization
@TSET@ [-IQVcqrsw] [-] [-e ch] [-i ch] [-k ch] [-m mapping] [terminal] reset [-IQVcqrsw] [-] [-e ch] [-i ch] [-k ch] [-m mapping] [terminal]
null
null
mysqld_multi
mysqld_multi is designed to manage several mysqld processes that listen for connections on different Unix socket files and TCP/IP ports. It can start or stop servers, or report their current status. Note For some Linux platforms, MySQL installation from RPM or Debian packages includes systemd support for managing MySQL server startup and shutdown. On these platforms, mysqld_multi is not installed because it is unnecessary. For information about using systemd to handle multiple MySQL instances, see Section 2.5.9, “Managing MySQL Server with systemd”. mysqld_multi searches for groups named [mysqldN] in my.cnf (or in the file named by the --defaults-file option). N can be any positive integer. This number is referred to in the following discussion as the option group number, or GNR. Group numbers distinguish option groups from one another and are used as arguments to mysqld_multi to specify which servers you want to start, stop, or obtain a status report for. Options listed in these groups are the same that you would use in the [mysqld] group used for starting mysqld. (See, for example, Section 2.9.5, “Starting and Stopping MySQL Automatically”.) However, when using multiple servers, it is necessary that each one use its own value for options such as the Unix socket file and TCP/IP port number. For more information on which options must be unique per server in a multiple-server environment, see Section 5.8, “Running Multiple MySQL Instances on One Machine”. To invoke mysqld_multi, use the following syntax: mysqld_multi [options] {start|stop|reload|report} [GNR[,GNR] ...] start, stop, reload (stop and restart), and report indicate which operation to perform. You can perform the designated operation for a single server or multiple servers, depending on the GNR list that follows the option name. If there is no list, mysqld_multi performs the operation for all servers in the option file. Each GNR value represents an option group number or range of group numbers. The value should be the number at the end of the group name in the option file. For example, the GNR for a group named [mysqld17] is 17. To specify a range of numbers, separate the first and last numbers by a dash. The GNR value 10-13 represents groups [mysqld10] through [mysqld13]. Multiple groups or group ranges can be specified on the command line, separated by commas. There must be no whitespace characters (spaces or tabs) in the GNR list; anything after a whitespace character is ignored. This command starts a single server using option group [mysqld17]: mysqld_multi start 17 This command stops several servers, using option groups [mysqld8] and [mysqld10] through [mysqld13]: mysqld_multi stop 8,10-13 For an example of how you might set up an option file, use this command: mysqld_multi --example mysqld_multi searches for option files as follows: • With --no-defaults, no option files are read. ┌────────────────────┬───────────────┐ │Command-Line Format │ --no-defaults │ ├────────────────────┼───────────────┤ │Type │ Boolean │ ├────────────────────┼───────────────┤ │Default Value │ false │ └────────────────────┴───────────────┘ • With --defaults-file=file_name, only the named file is read. ┌────────────────────┬──────────────────────────┐ │Command-Line Format │ --defaults-file=filename │ ├────────────────────┼──────────────────────────┤ │Type │ File name │ ├────────────────────┼──────────────────────────┤ │Default Value │ [none] │ └────────────────────┴──────────────────────────┘ • Otherwise, option files in the standard list of locations are read, including any file named by the --defaults-extra-file=file_name option, if one is given. (If the option is given multiple times, the last value is used.) ┌────────────────────┬────────────────────────────────┐ │Command-Line Format │ --defaults-extra-file=filename │ ├────────────────────┼────────────────────────────────┤ │Type │ File name │ ├────────────────────┼────────────────────────────────┤ │Default Value │ [none] │ └────────────────────┴────────────────────────────────┘ For additional information about these and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. Option files read are searched for [mysqld_multi] and [mysqldN] option groups. The [mysqld_multi] group can be used for options to mysqld_multi itself. [mysqldN] groups can be used for options passed to specific mysqld instances. The [mysqld] or [mysqld_safe] groups can be used for common options read by all instances of mysqld or mysqld_safe. You can specify a --defaults-file=file_name option to use a different configuration file for that instance, in which case the [mysqld] or [mysqld_safe] groups from that file are used for that instance. mysqld_multi supports the following options. • --help ┌────────────────────┬─────────┐ │Command-Line Format │ --help │ ├────────────────────┼─────────┤ │Type │ Boolean │ ├────────────────────┼─────────┤ │Default Value │ false │ └────────────────────┴─────────┘ Display a help message and exit. • --example ┌────────────────────┬───────────┐ │Command-Line Format │ --example │ ├────────────────────┼───────────┤ │Type │ Boolean │ ├────────────────────┼───────────┤ │Default Value │ false │ └────────────────────┴───────────┘ Display a sample option file. • --log=file_name ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --log=path │ ├────────────────────┼───────────────────────────┤ │Type │ File name │ ├────────────────────┼───────────────────────────┤ │Default Value │ /var/log/mysqld_multi.log │ └────────────────────┴───────────────────────────┘ Specify the name of the log file. If the file exists, log output is appended to it. • --mysqladmin=prog_name ┌────────────────────┬───────────────────┐ │Command-Line Format │ --mysqladmin=file │ ├────────────────────┼───────────────────┤ │Type │ File name │ ├────────────────────┼───────────────────┤ │Default Value │ [none] │ └────────────────────┴───────────────────┘ The mysqladmin binary to be used to stop servers. • --mysqld=prog_name ┌────────────────────┬───────────────┐ │Command-Line Format │ --mysqld=file │ ├────────────────────┼───────────────┤ │Type │ File name │ ├────────────────────┼───────────────┤ │Default Value │ [none] │ └────────────────────┴───────────────┘ The mysqld binary to be used. Note that you can specify mysqld_safe as the value for this option also. If you use mysqld_safe to start the server, you can include the mysqld or ledir options in the corresponding [mysqldN] option group. These options indicate the name of the server that mysqld_safe should start and the path name of the directory where the server is located. (See the descriptions for these options in mysqld_safe(1).) Example: [mysqld38] mysqld = mysqld-debug ledir = /opt/local/mysql/libexec • --no-log ┌────────────────────┬──────────┐ │Command-Line Format │ --no-log │ ├────────────────────┼──────────┤ │Type │ Boolean │ ├────────────────────┼──────────┤ │Default Value │ false │ └────────────────────┴──────────┘ Print log information to stdout rather than to the log file. By default, output goes to the log file. • --password=password ┌────────────────────┬───────────────────┐ │Command-Line Format │ --password=string │ ├────────────────────┼───────────────────┤ │Type │ String │ ├────────────────────┼───────────────────┤ │Default Value │ [none] │ └────────────────────┴───────────────────┘ The password of the MySQL account to use when invoking mysqladmin. Note that the password value is not optional for this option, unlike for other MySQL programs. • --silent ┌────────────────────┬──────────┐ │Command-Line Format │ --silent │ ├────────────────────┼──────────┤ │Type │ Boolean │ ├────────────────────┼──────────┤ │Default Value │ false │ └────────────────────┴──────────┘ Silent mode; disable warnings. • --tcp-ip ┌────────────────────┬──────────┐ │Command-Line Format │ --tcp-ip │ ├────────────────────┼──────────┤ │Type │ Boolean │ ├────────────────────┼──────────┤ │Default Value │ false │ └────────────────────┴──────────┘ Connect to each MySQL server through the TCP/IP port instead of the Unix socket file. (If a socket file is missing, the server might still be running, but accessible only through the TCP/IP port.) By default, connections are made using the Unix socket file. This option affects stop and report operations. • --user=user_name ┌────────────────────┬─────────────┐ │Command-Line Format │ --user=name │ ├────────────────────┼─────────────┤ │Type │ String │ ├────────────────────┼─────────────┤ │Default Value │ root │ └────────────────────┴─────────────┘ The user name of the MySQL account to use when invoking mysqladmin. • --verbose ┌────────────────────┬───────────┐ │Command-Line Format │ --verbose │ ├────────────────────┼───────────┤ │Type │ Boolean │ ├────────────────────┼───────────┤ │Default Value │ false │ └────────────────────┴───────────┘ Be more verbose. • --version ┌────────────────────┬───────────┐ │Command-Line Format │ --version │ ├────────────────────┼───────────┤ │Type │ Boolean │ ├────────────────────┼───────────┤ │Default Value │ false │ └────────────────────┴───────────┘ Display version information and exit. Some notes about mysqld_multi: • Most important: Before using mysqld_multi be sure that you understand the meanings of the options that are passed to the mysqld servers and why you would want to have separate mysqld processes. Beware of the dangers of using multiple mysqld servers with the same data directory. Use separate data directories, unless you know what you are doing. Starting multiple servers with the same data directory does not give you extra performance in a threaded system. See Section 5.8, “Running Multiple MySQL Instances on One Machine”. Important Make sure that the data directory for each server is fully accessible to the Unix account that the specific mysqld process is started as. Do not use the Unix root account for this, unless you know what you are doing. See Section 6.1.5, “How to Run MySQL as a Normal User”. • Make sure that the MySQL account used for stopping the mysqld servers (with the mysqladmin program) has the same user name and password for each server. Also, make sure that the account has the SHUTDOWN privilege. If the servers that you want to manage have different user names or passwords for the administrative accounts, you might want to create an account on each server that has the same user name and password. For example, you might set up a common multi_admin account by executing the following commands for each server: $> mysql -u root -S /tmp/mysql.sock -p Enter password: mysql> CREATE USER 'multi_admin'@'localhost' IDENTIFIED BY 'multipass'; mysql> GRANT SHUTDOWN ON *.* TO 'multi_admin'@'localhost'; See Section 6.2, “Access Control and Account Management”. You have to do this for each mysqld server. Change the connection parameters appropriately when connecting to each one. Note that the host name part of the account name must permit you to connect as multi_admin from the host where you want to run mysqld_multi. • The Unix socket file and the TCP/IP port number must be different for every mysqld. (Alternatively, if the host has multiple network addresses, you can set the bind_address system variable to cause different servers to listen to different interfaces.) • The --pid-file option is very important if you are using mysqld_safe to start mysqld (for example, --mysqld=mysqld_safe) Every mysqld should have its own process ID file. The advantage of using mysqld_safe instead of mysqld is that mysqld_safe monitors its mysqld process and restarts it if the process terminates due to a signal sent using kill -9 or for other reasons, such as a segmentation fault. • You might want to use the --user option for mysqld, but to do this you need to run the mysqld_multi script as the Unix superuser (root). Having the option in the option file doesn't matter; you just get a warning if you are not the superuser and the mysqld processes are started under your own Unix account. The following example shows how you might set up an option file for use with mysqld_multi. The order in which the mysqld programs are started or stopped depends on the order in which they appear in the option file. Group numbers need not form an unbroken sequence. The first and fifth [mysqldN] groups were intentionally omitted from the example to illustrate that you can have “gaps” in the option file. This gives you more flexibility. # This is an example of a my.cnf file for mysqld_multi. # Usually this file is located in home dir ~/.my.cnf or /etc/my.cnf [mysqld_multi] mysqld = /usr/local/mysql/bin/mysqld_safe mysqladmin = /usr/local/mysql/bin/mysqladmin user = multi_admin password = my_password [mysqld2] socket = /tmp/mysql.sock2 port = 3307 pid-file = /usr/local/mysql/data2/hostname.pid2 datadir = /usr/local/mysql/data2 language = /usr/local/mysql/share/mysql/english user = unix_user1 [mysqld3] mysqld = /path/to/mysqld_safe ledir = /path/to/mysqld-binary/ mysqladmin = /path/to/mysqladmin socket = /tmp/mysql.sock3 port = 3308 pid-file = /usr/local/mysql/data3/hostname.pid3 datadir = /usr/local/mysql/data3 language = /usr/local/mysql/share/mysql/swedish user = unix_user2 [mysqld4] socket = /tmp/mysql.sock4 port = 3309 pid-file = /usr/local/mysql/data4/hostname.pid4 datadir = /usr/local/mysql/data4 language = /usr/local/mysql/share/mysql/estonia user = unix_user3 [mysqld6] socket = /tmp/mysql.sock6 port = 3311 pid-file = /usr/local/mysql/data6/hostname.pid6 datadir = /usr/local/mysql/data6 language = /usr/local/mysql/share/mysql/japanese user = unix_user4 See Section 4.2.2.2, “Using Option Files”. COPYRIGHT Copyright © 1997, 2023, Oracle and/or its affiliates. This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/. SEE ALSO For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/. AUTHOR Oracle Corporation (http://dev.mysql.com/). MySQL 8.3 11/23/2023 MYSQLD_MULTI(1)
mysqld_multi - manage multiple MySQL servers
mysqld_multi [options] {start|stop|report} [GNR[,GNR] ...]
null
null
sip-build
null
null
null
null
null
macchangeqt
null
null
null
null
null
tiff2pdf
null
null
null
null
null
pg_config
null
null
null
null
null
jupyter-notebook
null
null
null
null
null
wish
Wish is a simple program consisting of the Tcl command language, the Tk toolkit, and a main program that reads commands from standard input or from a file. It creates a main window and then processes Tcl commands. If wish is invoked with arguments, then the first few arguments, ?-encoding name? ?fileName? specify the name of a script file, and, optionally, the encoding of the text data stored in that script file. A value for fileName is recognized if the appropriate argument does not start with “-”. If there are no arguments, or the arguments do not specify a fileName, then wish reads Tcl commands interactively from standard input. It will continue processing commands until all windows have been deleted or until end-of-file is reached on standard input. If there exists a file “.wishrc” in the home directory of the user, wish evaluates the file as a Tcl script just before reading the first command from standard input. If arguments to wish do specify a fileName, then fileName is treated as the name of a script file. Wish will evaluate the script in fileName (which presumably creates a user interface), then it will respond to events until all windows have been deleted. Commands will not be read from standard input. There is no automatic evaluation of “.wishrc” when the name of a script file is presented on the wish command line, but the script file can always source it if desired. Note that on Windows, the wishversion.exe program varies from the tclshversion.exe program in an additional important way: it does not connect to a standard Windows console and is instead a windowed program. Because of this, it additionally provides access to its own console command. OPTION PROCESSING Wish automatically processes all of the command-line options described in the OPTIONS summary above. Any other command-line arguments besides these are passed through to the application using the argc and argv variables described later. APPLICATION NAME AND CLASS The name of the application, which is used for purposes such as send commands, is taken from the -name option, if it is specified; otherwise it is taken from fileName, if it is specified, or from the command name by which wish was invoked. In the last two cases, if the name contains a “/” character, then only the characters after the last slash are used as the application name. The class of the application, which is used for purposes such as specifying options with a RESOURCE_MANAGER property or .Xdefaults file, is the same as its name except that the first letter is capitalized. VARIABLES Wish sets the following Tcl variables: argc Contains a count of the number of arg arguments (0 if none), not including the options described above. argv Contains a Tcl list whose elements are the arg arguments that follow a -- option or do not match any of the options described in OPTIONS above, in order, or an empty string if there are no such arguments. argv0 Contains fileName if it was specified. Otherwise, contains the name by which wish was invoked. geometry If the -geometry option is specified, wish copies its value into this variable. If the variable still exists after fileName has been evaluated, wish uses the value of the variable in a wm geometry command to set the main window's geometry. tcl_interactive Contains 1 if wish is reading commands interactively (fileName was not specified and standard input is a terminal-like device), 0 otherwise. SCRIPT FILES If you create a Tcl script in a file whose first line is #!/usr/local/bin/wish then you can invoke the script file directly from your shell if you mark it as executable. This assumes that wish has been installed in the default location in /usr/local/bin; if it is installed somewhere else then you will have to modify the above line to match. Many UNIX systems do not allow the #! line to exceed about 30 characters in length, so be sure that the wish executable can be accessed with a short file name. An even better approach is to start your script files with the following three lines: #!/bin/sh # the next line restarts using wish \ exec wish "$0" "$@" This approach has three advantages over the approach in the previous paragraph. First, the location of the wish binary does not have to be hard-wired into the script: it can be anywhere in your shell search path. Second, it gets around the 30-character file name limit in the previous approach. Third, this approach will work even if wish is itself a shell script (this is done on some systems in order to handle multiple architectures or operating systems: the wish script selects one of several binaries to run). The three lines cause both sh and wish to process the script, but the exec is only executed by sh. sh processes the script first; it treats the second line as a comment and executes the third line. The exec statement cause the shell to stop processing and instead to start up wish to reprocess the entire script. When wish starts up, it treats all three lines as comments, since the backslash at the end of the second line causes the third line to be treated as part of the comment on the second line. The end of a script file may be marked either by the physical end of the medium, or by the character, “\032” (“\u001a”, control-Z). If this character is present in the file, the wish application will read text up to but not including the character. An application that requires this character in the file may encode it as “\032”, “\x1a”, or “\u001a”; or may generate it by use of commands such as format or binary. PROMPTS When wish is invoked interactively it normally prompts for each command with “% ”. You can change the prompt by setting the variables tcl_prompt1 and tcl_prompt2. If variable tcl_prompt1 exists then it must consist of a Tcl script to output a prompt; instead of outputting a prompt wish will evaluate the script in tcl_prompt1. The variable tcl_prompt2 is used in a similar way when a newline is typed but the current command is not yet complete; if tcl_prompt2 is not set then no prompt is output for incomplete commands. KEYWORDS shell, toolkit Tk 8.0 wish(1)
wish - Simple windowing shell
wish ?-encoding name? ?fileName arg arg ...?
-encoding name Specifies the encoding of the text stored in │ fileName. This option is only recognized prior to │ the fileName argument. -colormap new Specifies that the window should have a new private colormap instead of using the default colormap for the screen. -display display Display (and screen) on which to display window. -geometry geometry Initial geometry to use for window. If this option is specified, its value is stored in the geometry global variable of the application's Tcl interpreter. -name name Use name as the title to be displayed in the window, and as the name of the interpreter for send commands. -sync Execute all X server commands synchronously, so that errors are reported immediately. This will result in much slower execution, but it is useful for debugging. -use id Specifies that the main window for the application is to be embedded in the window whose identifier is id, instead of being created as an independent toplevel window. Id must be specified in the same way as the value for the -use option for toplevel widgets (i.e. it has a form like that returned by the winfo id command). Note that on some platforms this will only work correctly if id refers to a Tk frame or toplevel that has its -container option enabled. -visual visual Specifies the visual to use for the window. Visual may have any of the forms supported by the Tk_GetVisual procedure. -- Pass all remaining arguments through to the script's argv variable without interpreting them. This provides a mechanism for passing arguments such as -name to a script instead of having wish interpret them. ______________________________________________________________________________
null
lupdate-pro
null
null
null
null
null
unlzma
xz is a general-purpose data compression tool with command line syntax similar to gzip(1) and bzip2(1). The native file format is the .xz format, but the legacy .lzma format used by LZMA Utils and raw compressed streams with no container format headers are also supported. In addition, decompression of the .lz format used by lzip is supported. xz compresses or decompresses each file according to the selected operation mode. If no files are given or file is -, xz reads from standard input and writes the processed data to standard output. xz will refuse (display an error and skip the file) to write compressed data to standard output if it is a terminal. Similarly, xz will refuse to read compressed data from standard input if it is a terminal. Unless --stdout is specified, files other than - are written to a new file whose name is derived from the source file name: • When compressing, the suffix of the target file format (.xz or .lzma) is appended to the source filename to get the target filename. • When decompressing, the .xz, .lzma, or .lz suffix is removed from the filename to get the target filename. xz also recognizes the suffixes .txz and .tlz, and replaces them with the .tar suffix. If the target file already exists, an error is displayed and the file is skipped. Unless writing to standard output, xz will display a warning and skip the file if any of the following applies: • File is not a regular file. Symbolic links are not followed, and thus they are not considered to be regular files. • File has more than one hard link. • File has setuid, setgid, or sticky bit set. • The operation mode is set to compress and the file already has a suffix of the target file format (.xz or .txz when compressing to the .xz format, and .lzma or .tlz when compressing to the .lzma format). • The operation mode is set to decompress and the file doesn't have a suffix of any of the supported file formats (.xz, .txz, .lzma, .tlz, or .lz). After successfully compressing or decompressing the file, xz copies the owner, group, permissions, access time, and modification time from the source file to the target file. If copying the group fails, the permissions are modified so that the target file doesn't become accessible to users who didn't have permission to access the source file. xz doesn't support copying other metadata like access control lists or extended attributes yet. Once the target file has been successfully closed, the source file is removed unless --keep was specified. The source file is never removed if the output is written to standard output or if an error occurs. Sending SIGINFO or SIGUSR1 to the xz process makes it print progress information to standard error. This has only limited use since when standard error is a terminal, using --verbose will display an automatically updating progress indicator. Memory usage The memory usage of xz varies from a few hundred kilobytes to several gigabytes depending on the compression settings. The settings used when compressing a file determine the memory requirements of the decompressor. Typically the decompressor needs 5 % to 20 % of the amount of memory that the compressor needed when creating the file. For example, decompressing a file created with xz -9 currently requires 65 MiB of memory. Still, it is possible to have .xz files that require several gigabytes of memory to decompress. Especially users of older systems may find the possibility of very large memory usage annoying. To prevent uncomfortable surprises, xz has a built-in memory usage limiter, which is disabled by default. While some operating systems provide ways to limit the memory usage of processes, relying on it wasn't deemed to be flexible enough (for example, using ulimit(1) to limit virtual memory tends to cripple mmap(2)). The memory usage limiter can be enabled with the command line option --memlimit=limit. Often it is more convenient to enable the limiter by default by setting the environment variable XZ_DEFAULTS, for example, XZ_DEFAULTS=--memlimit=150MiB. It is possible to set the limits separately for compression and decompression by using --memlimit-compress=limit and --memlimit-decompress=limit. Using these two options outside XZ_DEFAULTS is rarely useful because a single run of xz cannot do both compression and decompression and --memlimit=limit (or -M limit) is shorter to type on the command line. If the specified memory usage limit is exceeded when decompressing, xz will display an error and decompressing the file will fail. If the limit is exceeded when compressing, xz will try to scale the settings down so that the limit is no longer exceeded (except when using --format=raw or --no-adjust). This way the operation won't fail unless the limit is very small. The scaling of the settings is done in steps that don't match the compression level presets, for example, if the limit is only slightly less than the amount required for xz -9, the settings will be scaled down only a little, not all the way down to xz -8. Concatenation and padding with .xz files It is possible to concatenate .xz files as is. xz will decompress such files as if they were a single .xz file. It is possible to insert padding between the concatenated parts or after the last part. The padding must consist of null bytes and the size of the padding must be a multiple of four bytes. This can be useful, for example, if the .xz file is stored on a medium that measures file sizes in 512-byte blocks. Concatenation and padding are not allowed with .lzma files or raw streams.
xz, unxz, xzcat, lzma, unlzma, lzcat - Compress or decompress .xz and .lzma files
xz [option...] [file...] COMMAND ALIASES unxz is equivalent to xz --decompress. xzcat is equivalent to xz --decompress --stdout. lzma is equivalent to xz --format=lzma. unlzma is equivalent to xz --format=lzma --decompress. lzcat is equivalent to xz --format=lzma --decompress --stdout. When writing scripts that need to decompress files, it is recommended to always use the name xz with appropriate arguments (xz -d or xz -dc) instead of the names unxz and xzcat.
Integer suffixes and special values In most places where an integer argument is expected, an optional suffix is supported to easily indicate large integers. There must be no space between the integer and the suffix. KiB Multiply the integer by 1,024 (2^10). Ki, k, kB, K, and KB are accepted as synonyms for KiB. MiB Multiply the integer by 1,048,576 (2^20). Mi, m, M, and MB are accepted as synonyms for MiB. GiB Multiply the integer by 1,073,741,824 (2^30). Gi, g, G, and GB are accepted as synonyms for GiB. The special value max can be used to indicate the maximum integer value supported by the option. Operation mode If multiple operation mode options are given, the last one takes effect. -z, --compress Compress. This is the default operation mode when no operation mode option is specified and no other operation mode is implied from the command name (for example, unxz implies --decompress). -d, --decompress, --uncompress Decompress. -t, --test Test the integrity of compressed files. This option is equivalent to --decompress --stdout except that the decompressed data is discarded instead of being written to standard output. No files are created or removed. -l, --list Print information about compressed files. No uncompressed output is produced, and no files are created or removed. In list mode, the program cannot read the compressed data from standard input or from other unseekable sources. The default listing shows basic information about files, one file per line. To get more detailed information, use also the --verbose option. For even more information, use --verbose twice, but note that this may be slow, because getting all the extra information requires many seeks. The width of verbose output exceeds 80 characters, so piping the output to, for example, less -S may be convenient if the terminal isn't wide enough. The exact output may vary between xz versions and different locales. For machine-readable output, --robot --list should be used. Operation modifiers -k, --keep Don't delete the input files. Since xz 5.2.6, this option also makes xz compress or decompress even if the input is a symbolic link to a regular file, has more than one hard link, or has the setuid, setgid, or sticky bit set. The setuid, setgid, and sticky bits are not copied to the target file. In earlier versions this was only done with --force. -f, --force This option has several effects: • If the target file already exists, delete it before compressing or decompressing. • Compress or decompress even if the input is a symbolic link to a regular file, has more than one hard link, or has the setuid, setgid, or sticky bit set. The setuid, setgid, and sticky bits are not copied to the target file. • When used with --decompress --stdout and xz cannot recognize the type of the source file, copy the source file as is to standard output. This allows xzcat --force to be used like cat(1) for files that have not been compressed with xz. Note that in future, xz might support new compressed file formats, which may make xz decompress more types of files instead of copying them as is to standard output. --format=format can be used to restrict xz to decompress only a single file format. -c, --stdout, --to-stdout Write the compressed or decompressed data to standard output instead of a file. This implies --keep. --single-stream Decompress only the first .xz stream, and silently ignore possible remaining input data following the stream. Normally such trailing garbage makes xz display an error. xz never decompresses more than one stream from .lzma files or raw streams, but this option still makes xz ignore the possible trailing data after the .lzma file or raw stream. This option has no effect if the operation mode is not --decompress or --test. --no-sparse Disable creation of sparse files. By default, if decompressing into a regular file, xz tries to make the file sparse if the decompressed data contains long sequences of binary zeros. It also works when writing to standard output as long as standard output is connected to a regular file and certain additional conditions are met to make it safe. Creating sparse files may save disk space and speed up the decompression by reducing the amount of disk I/O. -S .suf, --suffix=.suf When compressing, use .suf as the suffix for the target file instead of .xz or .lzma. If not writing to standard output and the source file already has the suffix .suf, a warning is displayed and the file is skipped. When decompressing, recognize files with the suffix .suf in addition to files with the .xz, .txz, .lzma, .tlz, or .lz suffix. If the source file has the suffix .suf, the suffix is removed to get the target filename. When compressing or decompressing raw streams (--format=raw), the suffix must always be specified unless writing to standard output, because there is no default suffix for raw streams. --files[=file] Read the filenames to process from file; if file is omitted, filenames are read from standard input. Filenames must be terminated with the newline character. A dash (-) is taken as a regular filename; it doesn't mean standard input. If filenames are given also as command line arguments, they are processed before the filenames read from file. --files0[=file] This is identical to --files[=file] except that each filename must be terminated with the null character. Basic file format and compression options -F format, --format=format Specify the file format to compress or decompress: auto This is the default. When compressing, auto is equivalent to xz. When decompressing, the format of the input file is automatically detected. Note that raw streams (created with --format=raw) cannot be auto- detected. xz Compress to the .xz file format, or accept only .xz files when decompressing. lzma, alone Compress to the legacy .lzma file format, or accept only .lzma files when decompressing. The alternative name alone is provided for backwards compatibility with LZMA Utils. lzip Accept only .lz files when decompressing. Compression is not supported. The .lz format version 0 and the unextended version 1 are supported. Version 0 files were produced by lzip 1.3 and older. Such files aren't common but may be found from file archives as a few source packages were released in this format. People might have old personal files in this format too. Decompression support for the format version 0 was removed in lzip 1.18. lzip 1.4 and later create files in the format version 1. The sync flush marker extension to the format version 1 was added in lzip 1.6. This extension is rarely used and isn't supported by xz (diagnosed as corrupt input). raw Compress or uncompress a raw stream (no headers). This is meant for advanced users only. To decode raw streams, you need use --format=raw and explicitly specify the filter chain, which normally would have been stored in the container headers. -C check, --check=check Specify the type of the integrity check. The check is calculated from the uncompressed data and stored in the .xz file. This option has an effect only when compressing into the .xz format; the .lzma format doesn't support integrity checks. The integrity check (if any) is verified when the .xz file is decompressed. Supported check types: none Don't calculate an integrity check at all. This is usually a bad idea. This can be useful when integrity of the data is verified by other means anyway. crc32 Calculate CRC32 using the polynomial from IEEE-802.3 (Ethernet). crc64 Calculate CRC64 using the polynomial from ECMA-182. This is the default, since it is slightly better than CRC32 at detecting damaged files and the speed difference is negligible. sha256 Calculate SHA-256. This is somewhat slower than CRC32 and CRC64. Integrity of the .xz headers is always verified with CRC32. It is not possible to change or disable it. --ignore-check Don't verify the integrity check of the compressed data when decompressing. The CRC32 values in the .xz headers will still be verified normally. Do not use this option unless you know what you are doing. Possible reasons to use this option: • Trying to recover data from a corrupt .xz file. • Speeding up decompression. This matters mostly with SHA-256 or with files that have compressed extremely well. It's recommended to not use this option for this purpose unless the file integrity is verified externally in some other way. -0 ... -9 Select a compression preset level. The default is -6. If multiple preset levels are specified, the last one takes effect. If a custom filter chain was already specified, setting a compression preset level clears the custom filter chain. The differences between the presets are more significant than with gzip(1) and bzip2(1). The selected compression settings determine the memory requirements of the decompressor, thus using a too high preset level might make it painful to decompress the file on an old system with little RAM. Specifically, it's not a good idea to blindly use -9 for everything like it often is with gzip(1) and bzip2(1). -0 ... -3 These are somewhat fast presets. -0 is sometimes faster than gzip -9 while compressing much better. The higher ones often have speed comparable to bzip2(1) with comparable or better compression ratio, although the results depend a lot on the type of data being compressed. -4 ... -6 Good to very good compression while keeping decompressor memory usage reasonable even for old systems. -6 is the default, which is usually a good choice for distributing files that need to be decompressible even on systems with only 16 MiB RAM. (-5e or -6e may be worth considering too. See --extreme.) -7 ... -9 These are like -6 but with higher compressor and decompressor memory requirements. These are useful only when compressing files bigger than 8 MiB, 16 MiB, and 32 MiB, respectively. On the same hardware, the decompression speed is approximately a constant number of bytes of compressed data per second. In other words, the better the compression, the faster the decompression will usually be. This also means that the amount of uncompressed output produced per second can vary a lot. The following table summarises the features of the presets: Preset DictSize CompCPU CompMem DecMem -0 256 KiB 0 3 MiB 1 MiB -1 1 MiB 1 9 MiB 2 MiB -2 2 MiB 2 17 MiB 3 MiB -3 4 MiB 3 32 MiB 5 MiB -4 4 MiB 4 48 MiB 5 MiB -5 8 MiB 5 94 MiB 9 MiB -6 8 MiB 6 94 MiB 9 MiB -7 16 MiB 6 186 MiB 17 MiB -8 32 MiB 6 370 MiB 33 MiB -9 64 MiB 6 674 MiB 65 MiB Column descriptions: • DictSize is the LZMA2 dictionary size. It is waste of memory to use a dictionary bigger than the size of the uncompressed file. This is why it is good to avoid using the presets -7 ... -9 when there's no real need for them. At -6 and lower, the amount of memory wasted is usually low enough to not matter. • CompCPU is a simplified representation of the LZMA2 settings that affect compression speed. The dictionary size affects speed too, so while CompCPU is the same for levels -6 ... -9, higher levels still tend to be a little slower. To get even slower and thus possibly better compression, see --extreme. • CompMem contains the compressor memory requirements in the single-threaded mode. It may vary slightly between xz versions. • DecMem contains the decompressor memory requirements. That is, the compression settings determine the memory requirements of the decompressor. The exact decompressor memory usage is slightly more than the LZMA2 dictionary size, but the values in the table have been rounded up to the next full MiB. Memory requirements of the multi-threaded mode are significantly higher than that of the single-threaded mode. With the default value of --block-size, each thread needs 3*3*DictSize plus CompMem or DecMem. For example, four threads with preset -6 needs 660–670 MiB of memory. -e, --extreme Use a slower variant of the selected compression preset level (-0 ... -9) to hopefully get a little bit better compression ratio, but with bad luck this can also make it worse. Decompressor memory usage is not affected, but compressor memory usage increases a little at preset levels -0 ... -3. Since there are two presets with dictionary sizes 4 MiB and 8 MiB, the presets -3e and -5e use slightly faster settings (lower CompCPU) than -4e and -6e, respectively. That way no two presets are identical. Preset DictSize CompCPU CompMem DecMem -0e 256 KiB 8 4 MiB 1 MiB -1e 1 MiB 8 13 MiB 2 MiB -2e 2 MiB 8 25 MiB 3 MiB -3e 4 MiB 7 48 MiB 5 MiB -4e 4 MiB 8 48 MiB 5 MiB -5e 8 MiB 7 94 MiB 9 MiB -6e 8 MiB 8 94 MiB 9 MiB -7e 16 MiB 8 186 MiB 17 MiB -8e 32 MiB 8 370 MiB 33 MiB -9e 64 MiB 8 674 MiB 65 MiB For example, there are a total of four presets that use 8 MiB dictionary, whose order from the fastest to the slowest is -5, -6, -5e, and -6e. --fast --best These are somewhat misleading aliases for -0 and -9, respectively. These are provided only for backwards compatibility with LZMA Utils. Avoid using these options. --block-size=size When compressing to the .xz format, split the input data into blocks of size bytes. The blocks are compressed independently from each other, which helps with multi-threading and makes limited random-access decompression possible. This option is typically used to override the default block size in multi- threaded mode, but this option can be used in single-threaded mode too. In multi-threaded mode about three times size bytes will be allocated in each thread for buffering input and output. The default size is three times the LZMA2 dictionary size or 1 MiB, whichever is more. Typically a good value is 2–4 times the size of the LZMA2 dictionary or at least 1 MiB. Using size less than the LZMA2 dictionary size is waste of RAM because then the LZMA2 dictionary buffer will never get fully used. In multi-threaded mode, the sizes of the blocks are stored in the block headers. This size information is required for multi-threaded decompression. In single-threaded mode no block splitting is done by default. Setting this option doesn't affect memory usage. No size information is stored in block headers, thus files created in single-threaded mode won't be identical to files created in multi-threaded mode. The lack of size information also means that xz won't be able decompress the files in multi-threaded mode. --block-list=items When compressing to the .xz format, start a new block with an optional custom filter chain after the given intervals of uncompressed data. The items are a comma-separated list. Each item consists of an optional filter chain number between 0 and 9 followed by a colon (:) and a required size of uncompressed data. Omitting an item (two or more consecutive commas) is a shorthand to use the size and filters of the previous item. If the input file is bigger than the sum of the sizes in items, the last item is repeated until the end of the file. A special value of 0 may be used as the last size to indicate that the rest of the file should be encoded as a single block. An alternative filter chain for each block can be specified in combination with the --filters1=filters ... --filters9=filters options. These options define filter chains with an identifier between 1–9. Filter chain 0 can be used to refer to the default filter chain, which is the same as not specifying a filter chain. The filter chain identifier can be used before the uncompressed size, followed by a colon (:). For example, if one specifies --block-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB then blocks will be created using: • The filter chain specified by --filters1 and 2 MiB input • The filter chain specified by --filters3 and 2 MiB input • The filter chain specified by --filters2 and 4 MiB input • The filter chain specified by --filters2 and 4 MiB input • The default filter chain and 2 MiB input • The default filter chain and 4 MiB input for every block until end of input. If one specifies a size that exceeds the encoder's block size (either the default value in threaded mode or the value specified with --block-size=size), the encoder will create additional blocks while keeping the boundaries specified in items. For example, if one specifies --block-size=10MiB --block-list=5MiB,10MiB,8MiB,12MiB,24MiB and the input file is 80 MiB, one will get 11 blocks: 5, 10, 8, 10, 2, 10, 10, 4, 10, 10, and 1 MiB. In multi-threaded mode the sizes of the blocks are stored in the block headers. This isn't done in single-threaded mode, so the encoded output won't be identical to that of the multi-threaded mode. --flush-timeout=timeout When compressing, if more than timeout milliseconds (a positive integer) has passed since the previous flush and reading more input would block, all the pending input data is flushed from the encoder and made available in the output stream. This can be useful if xz is used to compress data that is streamed over a network. Small timeout values make the data available at the receiving end with a small delay, but large timeout values give better compression ratio. This feature is disabled by default. If this option is specified more than once, the last one takes effect. The special timeout value of 0 can be used to explicitly disable this feature. This feature is not available on non-POSIX systems. This feature is still experimental. Currently xz is unsuitable for decompressing the stream in real time due to how xz does buffering. --memlimit-compress=limit Set a memory usage limit for compression. If this option is specified multiple times, the last one takes effect. If the compression settings exceed the limit, xz will attempt to adjust the settings downwards so that the limit is no longer exceeded and display a notice that automatic adjustment was done. The adjustments are done in this order: reducing the number of threads, switching to single-threaded mode if even one thread in multi-threaded mode exceeds the limit, and finally reducing the LZMA2 dictionary size. When compressing with --format=raw or if --no-adjust has been specified, only the number of threads may be reduced since it can be done without affecting the compressed output. If the limit cannot be met even with the adjustments described above, an error is displayed and xz will exit with exit status 1. The limit can be specified in multiple ways: • The limit can be an absolute value in bytes. Using an integer suffix like MiB can be useful. Example: --memlimit-compress=80MiB • The limit can be specified as a percentage of total physical memory (RAM). This can be useful especially when setting the XZ_DEFAULTS environment variable in a shell initialization script that is shared between different computers. That way the limit is automatically bigger on systems with more memory. Example: --memlimit-compress=70% • The limit can be reset back to its default value by setting it to 0. This is currently equivalent to setting the limit to max (no memory usage limit). For 32-bit xz there is a special case: if the limit would be over 4020 MiB, the limit is set to 4020 MiB. On MIPS32 2000 MiB is used instead. (The values 0 and max aren't affected by this. A similar feature doesn't exist for decompression.) This can be helpful when a 32-bit executable has access to 4 GiB address space (2 GiB on MIPS32) while hopefully doing no harm in other situations. See also the section Memory usage. --memlimit-decompress=limit Set a memory usage limit for decompression. This also affects the --list mode. If the operation is not possible without exceeding the limit, xz will display an error and decompressing the file will fail. See --memlimit-compress=limit for possible ways to specify the limit. --memlimit-mt-decompress=limit Set a memory usage limit for multi-threaded decompression. This can only affect the number of threads; this will never make xz refuse to decompress a file. If limit is too low to allow any multi-threading, the limit is ignored and xz will continue in single-threaded mode. Note that if also --memlimit-decompress is used, it will always apply to both single-threaded and multi- threaded modes, and so the effective limit for multi-threading will never be higher than the limit set with --memlimit-decompress. In contrast to the other memory usage limit options, --memlimit-mt-decompress=limit has a system-specific default limit. xz --info-memory can be used to see the current value. This option and its default value exist because without any limit the threaded decompressor could end up allocating an insane amount of memory with some input files. If the default limit is too low on your system, feel free to increase the limit but never set it to a value larger than the amount of usable RAM as with appropriate input files xz will attempt to use that amount of memory even with a low number of threads. Running out of memory or swapping will not improve decompression performance. See --memlimit-compress=limit for possible ways to specify the limit. Setting limit to 0 resets the limit to the default system-specific value. -M limit, --memlimit=limit, --memory=limit This is equivalent to specifying --memlimit-compress=limit --memlimit-decompress=limit --memlimit-mt-decompress=limit. --no-adjust Display an error and exit if the memory usage limit cannot be met without adjusting settings that affect the compressed output. That is, this prevents xz from switching the encoder from multi-threaded mode to single-threaded mode and from reducing the LZMA2 dictionary size. Even when this option is used the number of threads may be reduced to meet the memory usage limit as that won't affect the compressed output. Automatic adjusting is always disabled when creating raw streams (--format=raw). -T threads, --threads=threads Specify the number of worker threads to use. Setting threads to a special value 0 makes xz use up to as many threads as the processor(s) on the system support. The actual number of threads can be fewer than threads if the input file is not big enough for threading with the given settings or if using more threads would exceed the memory usage limit. The single-threaded and multi-threaded compressors produce different output. Single-threaded compressor will give the smallest file size but only the output from the multi-threaded compressor can be decompressed using multiple threads. Setting threads to 1 will use the single-threaded mode. Setting threads to any other value, including 0, will use the multi-threaded compressor even if the system supports only one hardware thread. (xz 5.2.x used single-threaded mode in this situation.) To use multi-threaded mode with only one thread, set threads to +1. The + prefix has no effect with values other than 1. A memory usage limit can still make xz switch to single-threaded mode unless --no-adjust is used. Support for the + prefix was added in xz 5.4.0. If an automatic number of threads has been requested and no memory usage limit has been specified, then a system-specific default soft limit will be used to possibly limit the number of threads. It is a soft limit in sense that it is ignored if the number of threads becomes one, thus a soft limit will never stop xz from compressing or decompressing. This default soft limit will not make xz switch from multi-threaded mode to single- threaded mode. The active limits can be seen with xz --info-memory. Currently the only threading method is to split the input into blocks and compress them independently from each other. The default block size depends on the compression level and can be overridden with the --block-size=size option. Threaded decompression only works on files that contain multiple blocks with size information in block headers. All large enough files compressed in multi-threaded mode meet this condition, but files compressed in single-threaded mode don't even if --block-size=size has been used. The default value for threads is 0. In xz 5.4.x and older the default is 1. Custom compressor filter chains A custom filter chain allows specifying the compression settings in detail instead of relying on the settings associated to the presets. When a custom filter chain is specified, preset options (-0 ... -9 and --extreme) earlier on the command line are forgotten. If a preset option is specified after one or more custom filter chain options, the new preset takes effect and the custom filter chain options specified earlier are forgotten. A filter chain is comparable to piping on the command line. When compressing, the uncompressed input goes to the first filter, whose output goes to the next filter (if any). The output of the last filter gets written to the compressed file. The maximum number of filters in the chain is four, but typically a filter chain has only one or two filters. Many filters have limitations on where they can be in the filter chain: some filters can work only as the last filter in the chain, some only as a non-last filter, and some work in any position in the chain. Depending on the filter, this limitation is either inherent to the filter design or exists to prevent security issues. A custom filter chain can be specified in two different ways. The options --filters=filters and --filters1=filters ... --filters9=filters allow specifying an entire filter chain in one option using the liblzma filter string syntax. Alternatively, a filter chain can be specified by using one or more individual filter options in the order they are wanted in the filter chain. That is, the order of the individual filter options is significant! When decoding raw streams (--format=raw), the filter chain must be specified in the same order as it was specified when compressing. Any individual filter or preset options specified before the full chain option (--filters=filters) will be forgotten. Individual filters specified after the full chain option will reset the filter chain. Both the full and individual filter options take filter-specific options as a comma-separated list. Extra commas in options are ignored. Every option has a default value, so specify those you want to change. To see the whole filter chain and options, use xz -vv (that is, use --verbose twice). This works also for viewing the filter chain options used by presets. --filters=filters Specify the full filter chain or a preset in a single option. Each filter can be separated by spaces or two dashes (--). filters may need to be quoted on the shell command line so it is parsed as a single option. To denote options, use : or =. A preset can be prefixed with a - and followed with zero or more flags. The only supported flag is e to apply the same options as --extreme. --filters1=filters ... --filters9=filters Specify up to nine additional filter chains that can be used with --block-list. For example, when compressing an archive with executable files followed by text files, the executable part could use a filter chain with a BCJ filter and the text part only the LZMA2 filter. --filters-help Display a help message describing how to specify presets and custom filter chains in the --filters and --filters1=filters ... --filters9=filters options, and exit successfully. --lzma1[=options] --lzma2[=options] Add LZMA1 or LZMA2 filter to the filter chain. These filters can be used only as the last filter in the chain. LZMA1 is a legacy filter, which is supported almost solely due to the legacy .lzma file format, which supports only LZMA1. LZMA2 is an updated version of LZMA1 to fix some practical issues of LZMA1. The .xz format uses LZMA2 and doesn't support LZMA1 at all. Compression speed and ratios of LZMA1 and LZMA2 are practically the same. LZMA1 and LZMA2 share the same set of options: preset=preset Reset all LZMA1 or LZMA2 options to preset. Preset consist of an integer, which may be followed by single- letter preset modifiers. The integer can be from 0 to 9, matching the command line options -0 ... -9. The only supported modifier is currently e, which matches --extreme. If no preset is specified, the default values of LZMA1 or LZMA2 options are taken from the preset 6. dict=size Dictionary (history buffer) size indicates how many bytes of the recently processed uncompressed data is kept in memory. The algorithm tries to find repeating byte sequences (matches) in the uncompressed data, and replace them with references to the data currently in the dictionary. The bigger the dictionary, the higher is the chance to find a match. Thus, increasing dictionary size usually improves compression ratio, but a dictionary bigger than the uncompressed file is waste of memory. Typical dictionary size is from 64 KiB to 64 MiB. The minimum is 4 KiB. The maximum for compression is currently 1.5 GiB (1536 MiB). The decompressor already supports dictionaries up to one byte less than 4 GiB, which is the maximum for the LZMA1 and LZMA2 stream formats. Dictionary size and match finder (mf) together determine the memory usage of the LZMA1 or LZMA2 encoder. The same (or bigger) dictionary size is required for decompressing that was used when compressing, thus the memory usage of the decoder is determined by the dictionary size used when compressing. The .xz headers store the dictionary size either as 2^n or 2^n + 2^(n-1), so these sizes are somewhat preferred for compression. Other sizes will get rounded up when stored in the .xz headers. lc=lc Specify the number of literal context bits. The minimum is 0 and the maximum is 4; the default is 3. In addition, the sum of lc and lp must not exceed 4. All bytes that cannot be encoded as matches are encoded as literals. That is, literals are simply 8-bit bytes that are encoded one at a time. The literal coding makes an assumption that the highest lc bits of the previous uncompressed byte correlate with the next byte. For example, in typical English text, an upper-case letter is often followed by a lower-case letter, and a lower-case letter is usually followed by another lower-case letter. In the US-ASCII character set, the highest three bits are 010 for upper-case letters and 011 for lower-case letters. When lc is at least 3, the literal coding can take advantage of this property in the uncompressed data. The default value (3) is usually good. If you want maximum compression, test lc=4. Sometimes it helps a little, and sometimes it makes compression worse. If it makes it worse, test lc=2 too. lp=lp Specify the number of literal position bits. The minimum is 0 and the maximum is 4; the default is 0. Lp affects what kind of alignment in the uncompressed data is assumed when encoding literals. See pb below for more information about alignment. pb=pb Specify the number of position bits. The minimum is 0 and the maximum is 4; the default is 2. Pb affects what kind of alignment in the uncompressed data is assumed in general. The default means four-byte alignment (2^pb=2^2=4), which is often a good choice when there's no better guess. When the alignment is known, setting pb accordingly may reduce the file size a little. For example, with text files having one-byte alignment (US-ASCII, ISO-8859-*, UTF-8), setting pb=0 can improve compression slightly. For UTF-16 text, pb=1 is a good choice. If the alignment is an odd number like 3 bytes, pb=0 might be the best choice. Even though the assumed alignment can be adjusted with pb and lp, LZMA1 and LZMA2 still slightly favor 16-byte alignment. It might be worth taking into account when designing file formats that are likely to be often compressed with LZMA1 or LZMA2. mf=mf Match finder has a major effect on encoder speed, memory usage, and compression ratio. Usually Hash Chain match finders are faster than Binary Tree match finders. The default depends on the preset: 0 uses hc3, 1–3 use hc4, and the rest use bt4. The following match finders are supported. The memory usage formulas below are rough approximations, which are closest to the reality when dict is a power of two. hc3 Hash Chain with 2- and 3-byte hashing Minimum value for nice: 3 Memory usage: dict * 7.5 (if dict <= 16 MiB); dict * 5.5 + 64 MiB (if dict > 16 MiB) hc4 Hash Chain with 2-, 3-, and 4-byte hashing Minimum value for nice: 4 Memory usage: dict * 7.5 (if dict <= 32 MiB); dict * 6.5 (if dict > 32 MiB) bt2 Binary Tree with 2-byte hashing Minimum value for nice: 2 Memory usage: dict * 9.5 bt3 Binary Tree with 2- and 3-byte hashing Minimum value for nice: 3 Memory usage: dict * 11.5 (if dict <= 16 MiB); dict * 9.5 + 64 MiB (if dict > 16 MiB) bt4 Binary Tree with 2-, 3-, and 4-byte hashing Minimum value for nice: 4 Memory usage: dict * 11.5 (if dict <= 32 MiB); dict * 10.5 (if dict > 32 MiB) mode=mode Compression mode specifies the method to analyze the data produced by the match finder. Supported modes are fast and normal. The default is fast for presets 0–3 and normal for presets 4–9. Usually fast is used with Hash Chain match finders and normal with Binary Tree match finders. This is also what the presets do. nice=nice Specify what is considered to be a nice length for a match. Once a match of at least nice bytes is found, the algorithm stops looking for possibly better matches. Nice can be 2–273 bytes. Higher values tend to give better compression ratio at the expense of speed. The default depends on the preset. depth=depth Specify the maximum search depth in the match finder. The default is the special value of 0, which makes the compressor determine a reasonable depth from mf and nice. Reasonable depth for Hash Chains is 4–100 and 16–1000 for Binary Trees. Using very high values for depth can make the encoder extremely slow with some files. Avoid setting the depth over 1000 unless you are prepared to interrupt the compression in case it is taking far too long. When decoding raw streams (--format=raw), LZMA2 needs only the dictionary size. LZMA1 needs also lc, lp, and pb. --x86[=options] --arm[=options] --armthumb[=options] --arm64[=options] --powerpc[=options] --ia64[=options] --sparc[=options] --riscv[=options] Add a branch/call/jump (BCJ) filter to the filter chain. These filters can be used only as a non-last filter in the filter chain. A BCJ filter converts relative addresses in the machine code to their absolute counterparts. This doesn't change the size of the data but it increases redundancy, which can help LZMA2 to produce 0–15 % smaller .xz file. The BCJ filters are always reversible, so using a BCJ filter for wrong type of data doesn't cause any data loss, although it may make the compression ratio slightly worse. The BCJ filters are very fast and use an insignificant amount of memory. These BCJ filters have known problems related to the compression ratio: • Some types of files containing executable code (for example, object files, static libraries, and Linux kernel modules) have the addresses in the instructions filled with filler values. These BCJ filters will still do the address conversion, which will make the compression worse with these files. • If a BCJ filter is applied on an archive, it is possible that it makes the compression ratio worse than not using a BCJ filter. For example, if there are similar or even identical executables then filtering will likely make the files less similar and thus compression is worse. The contents of non- executable files in the same archive can matter too. In practice one has to try with and without a BCJ filter to see which is better in each situation. Different instruction sets have different alignment: the executable file must be aligned to a multiple of this value in the input data to make the filter work. Filter Alignment Notes x86 1 32-bit or 64-bit x86 ARM 4 ARM-Thumb 2 ARM64 4 4096-byte alignment is best PowerPC 4 Big endian only IA-64 16 Itanium SPARC 4 RISC-V 2 Since the BCJ-filtered data is usually compressed with LZMA2, the compression ratio may be improved slightly if the LZMA2 options are set to match the alignment of the selected BCJ filter. Examples: • IA-64 filter has 16-byte alignment so pb=4,lp=4,lc=0 is good with LZMA2 (2^4=16). • RISC-V code has 2-byte or 4-byte alignment depending on whether the file contains 16-bit compressed instructions (the C extension). When 16-bit instructions are used, pb=2,lp=1,lc=3 or pb=1,lp=1,lc=3 is good. When 16-bit instructions aren't present, pb=2,lp=2,lc=2 is the best. readelf -h can be used to check if "RVC" appears on the "Flags" line. • ARM64 is always 4-byte aligned so pb=2,lp=2,lc=2 is the best. • The x86 filter is an exception. It's usually good to stick to LZMA2's defaults (pb=2,lp=0,lc=3) when compressing x86 executables. All BCJ filters support the same options: start=offset Specify the start offset that is used when converting between relative and absolute addresses. The offset must be a multiple of the alignment of the filter (see the table above). The default is zero. In practice, the default is good; specifying a custom offset is almost never useful. --delta[=options] Add the Delta filter to the filter chain. The Delta filter can be only used as a non-last filter in the filter chain. Currently only simple byte-wise delta calculation is supported. It can be useful when compressing, for example, uncompressed bitmap images or uncompressed PCM audio. However, special purpose algorithms may give significantly better results than Delta + LZMA2. This is true especially with audio, which compresses faster and better, for example, with flac(1). Supported options: dist=distance Specify the distance of the delta calculation in bytes. distance must be 1–256. The default is 1. For example, with dist=2 and eight-byte input A1 B1 A2 B3 A3 B5 A4 B7, the output will be A1 B1 01 02 01 02 01 02. Other options -q, --quiet Suppress warnings and notices. Specify this twice to suppress errors too. This option has no effect on the exit status. That is, even if a warning was suppressed, the exit status to indicate a warning is still used. -v, --verbose Be verbose. If standard error is connected to a terminal, xz will display a progress indicator. Specifying --verbose twice will give even more verbose output. The progress indicator shows the following information: • Completion percentage is shown if the size of the input file is known. That is, the percentage cannot be shown in pipes. • Amount of compressed data produced (compressing) or consumed (decompressing). • Amount of uncompressed data consumed (compressing) or produced (decompressing). • Compression ratio, which is calculated by dividing the amount of compressed data processed so far by the amount of uncompressed data processed so far. • Compression or decompression speed. This is measured as the amount of uncompressed data consumed (compression) or produced (decompression) per second. It is shown after a few seconds have passed since xz started processing the file. • Elapsed time in the format M:SS or H:MM:SS. • Estimated remaining time is shown only when the size of the input file is known and a couple of seconds have already passed since xz started processing the file. The time is shown in a less precise format which never has any colons, for example, 2 min 30 s. When standard error is not a terminal, --verbose will make xz print the filename, compressed size, uncompressed size, compression ratio, and possibly also the speed and elapsed time on a single line to standard error after compressing or decompressing the file. The speed and elapsed time are included only when the operation took at least a few seconds. If the operation didn't finish, for example, due to user interruption, also the completion percentage is printed if the size of the input file is known. -Q, --no-warn Don't set the exit status to 2 even if a condition worth a warning was detected. This option doesn't affect the verbosity level, thus both --quiet and --no-warn have to be used to not display warnings and to not alter the exit status. --robot Print messages in a machine-parsable format. This is intended to ease writing frontends that want to use xz instead of liblzma, which may be the case with various scripts. The output with this option enabled is meant to be stable across xz releases. See the section ROBOT MODE for details. --info-memory Display, in human-readable format, how much physical memory (RAM) and how many processor threads xz thinks the system has and the memory usage limits for compression and decompression, and exit successfully. -h, --help Display a help message describing the most commonly used options, and exit successfully. -H, --long-help Display a help message describing all features of xz, and exit successfully -V, --version Display the version number of xz and liblzma in human readable format. To get machine-parsable output, specify --robot before --version. ROBOT MODE The robot mode is activated with the --robot option. It makes the output of xz easier to parse by other programs. Currently --robot is supported only together with --list, --filters-help, --info-memory, and --version. It will be supported for compression and decompression in the future. List mode xz --robot --list uses tab-separated output. The first column of every line has a string that indicates the type of the information found on that line: name This is always the first line when starting to list a file. The second column on the line is the filename. file This line contains overall information about the .xz file. This line is always printed after the name line. stream This line type is used only when --verbose was specified. There are as many stream lines as there are streams in the .xz file. block This line type is used only when --verbose was specified. There are as many block lines as there are blocks in the .xz file. The block lines are shown after all the stream lines; different line types are not interleaved. summary This line type is used only when --verbose was specified twice. This line is printed after all block lines. Like the file line, the summary line contains overall information about the .xz file. totals This line is always the very last line of the list output. It shows the total counts and sizes. The columns of the file lines: 2. Number of streams in the file 3. Total number of blocks in the stream(s) 4. Compressed size of the file 5. Uncompressed size of the file 6. Compression ratio, for example, 0.123. If ratio is over 9.999, three dashes (---) are displayed instead of the ratio. 7. Comma-separated list of integrity check names. The following strings are used for the known check types: None, CRC32, CRC64, and SHA-256. For unknown check types, Unknown-N is used, where N is the Check ID as a decimal number (one or two digits). 8. Total size of stream padding in the file The columns of the stream lines: 2. Stream number (the first stream is 1) 3. Number of blocks in the stream 4. Compressed start offset 5. Uncompressed start offset 6. Compressed size (does not include stream padding) 7. Uncompressed size 8. Compression ratio 9. Name of the integrity check 10. Size of stream padding The columns of the block lines: 2. Number of the stream containing this block 3. Block number relative to the beginning of the stream (the first block is 1) 4. Block number relative to the beginning of the file 5. Compressed start offset relative to the beginning of the file 6. Uncompressed start offset relative to the beginning of the file 7. Total compressed size of the block (includes headers) 8. Uncompressed size 9. Compression ratio 10. Name of the integrity check If --verbose was specified twice, additional columns are included on the block lines. These are not displayed with a single --verbose, because getting this information requires many seeks and can thus be slow: 11. Value of the integrity check in hexadecimal 12. Block header size 13. Block flags: c indicates that compressed size is present, and u indicates that uncompressed size is present. If the flag is not set, a dash (-) is shown instead to keep the string length fixed. New flags may be added to the end of the string in the future. 14. Size of the actual compressed data in the block (this excludes the block header, block padding, and check fields) 15. Amount of memory (in bytes) required to decompress this block with this xz version 16. Filter chain. Note that most of the options used at compression time cannot be known, because only the options that are needed for decompression are stored in the .xz headers. The columns of the summary lines: 2. Amount of memory (in bytes) required to decompress this file with this xz version 3. yes or no indicating if all block headers have both compressed size and uncompressed size stored in them Since xz 5.1.2alpha: 4. Minimum xz version required to decompress the file The columns of the totals line: 2. Number of streams 3. Number of blocks 4. Compressed size 5. Uncompressed size 6. Average compression ratio 7. Comma-separated list of integrity check names that were present in the files 8. Stream padding size 9. Number of files. This is here to keep the order of the earlier columns the same as on file lines. If --verbose was specified twice, additional columns are included on the totals line: 10. Maximum amount of memory (in bytes) required to decompress the files with this xz version 11. yes or no indicating if all block headers have both compressed size and uncompressed size stored in them Since xz 5.1.2alpha: 12. Minimum xz version required to decompress the file Future versions may add new line types and new columns can be added to the existing line types, but the existing columns won't be changed. Filters help xz --robot --filters-help prints the supported filters in the following format: filter:option=<value>,option=<value>... filter Name of the filter option Name of a filter specific option value Numeric value ranges appear as <min-max>. String value choices are shown within < > and separated by a | character. Each filter is printed on its own line. Memory limit information xz --robot --info-memory prints a single line with multiple tab- separated columns: 1. Total amount of physical memory (RAM) in bytes. 2. Memory usage limit for compression in bytes (--memlimit-compress). A special value of 0 indicates the default setting which for single-threaded mode is the same as no limit. 3. Memory usage limit for decompression in bytes (--memlimit-decompress). A special value of 0 indicates the default setting which for single-threaded mode is the same as no limit. 4. Since xz 5.3.4alpha: Memory usage for multi-threaded decompression in bytes (--memlimit-mt-decompress). This is never zero because a system-specific default value shown in the column 5 is used if no limit has been specified explicitly. This is also never greater than the value in the column 3 even if a larger value has been specified with --memlimit-mt-decompress. 5. Since xz 5.3.4alpha: A system-specific default memory usage limit that is used to limit the number of threads when compressing with an automatic number of threads (--threads=0) and no memory usage limit has been specified (--memlimit-compress). This is also used as the default value for --memlimit-mt-decompress. 6. Since xz 5.3.4alpha: Number of available processor threads. In the future, the output of xz --robot --info-memory may have more columns, but never more than a single line. Version xz --robot --version prints the version number of xz and liblzma in the following format: XZ_VERSION=XYYYZZZS LIBLZMA_VERSION=XYYYZZZS X Major version. YYY Minor version. Even numbers are stable. Odd numbers are alpha or beta versions. ZZZ Patch level for stable releases or just a counter for development releases. S Stability. 0 is alpha, 1 is beta, and 2 is stable. S should be always 2 when YYY is even. XYYYZZZS are the same on both lines if xz and liblzma are from the same XZ Utils release. Examples: 4.999.9beta is 49990091 and 5.0.0 is 50000002. EXIT STATUS 0 All is good. 1 An error occurred. 2 Something worth a warning occurred, but no actual errors occurred. Notices (not warnings or errors) printed on standard error don't affect the exit status. ENVIRONMENT xz parses space-separated lists of options from the environment variables XZ_DEFAULTS and XZ_OPT, in this order, before parsing the options from the command line. Note that only options are parsed from the environment variables; all non-options are silently ignored. Parsing is done with getopt_long(3) which is used also for the command line arguments. XZ_DEFAULTS User-specific or system-wide default options. Typically this is set in a shell initialization script to enable xz's memory usage limiter by default. Excluding shell initialization scripts and similar special cases, scripts must never set or unset XZ_DEFAULTS. XZ_OPT This is for passing options to xz when it is not possible to set the options directly on the xz command line. This is the case when xz is run by a script or tool, for example, GNU tar(1): XZ_OPT=-2v tar caf foo.tar.xz foo Scripts may use XZ_OPT, for example, to set script-specific default compression options. It is still recommended to allow users to override XZ_OPT if that is reasonable. For example, in sh(1) scripts one may use something like this: XZ_OPT=${XZ_OPT-"-7e"} export XZ_OPT LZMA UTILS COMPATIBILITY The command line syntax of xz is practically a superset of lzma, unlzma, and lzcat as found from LZMA Utils 4.32.x. In most cases, it is possible to replace LZMA Utils with XZ Utils without breaking existing scripts. There are some incompatibilities though, which may sometimes cause problems. Compression preset levels The numbering of the compression level presets is not identical in xz and LZMA Utils. The most important difference is how dictionary sizes are mapped to different presets. Dictionary size is roughly equal to the decompressor memory usage. Level xz LZMA Utils -0 256 KiB N/A -1 1 MiB 64 KiB -2 2 MiB 1 MiB -3 4 MiB 512 KiB -4 4 MiB 1 MiB -5 8 MiB 2 MiB -6 8 MiB 4 MiB -7 16 MiB 8 MiB -8 32 MiB 16 MiB -9 64 MiB 32 MiB The dictionary size differences affect the compressor memory usage too, but there are some other differences between LZMA Utils and XZ Utils, which make the difference even bigger: Level xz LZMA Utils 4.32.x -0 3 MiB N/A -1 9 MiB 2 MiB -2 17 MiB 12 MiB -3 32 MiB 12 MiB -4 48 MiB 16 MiB -5 94 MiB 26 MiB -6 94 MiB 45 MiB -7 186 MiB 83 MiB -8 370 MiB 159 MiB -9 674 MiB 311 MiB The default preset level in LZMA Utils is -7 while in XZ Utils it is -6, so both use an 8 MiB dictionary by default. Streamed vs. non-streamed .lzma files The uncompressed size of the file can be stored in the .lzma header. LZMA Utils does that when compressing regular files. The alternative is to mark that uncompressed size is unknown and use end-of-payload marker to indicate where the decompressor should stop. LZMA Utils uses this method when uncompressed size isn't known, which is the case, for example, in pipes. xz supports decompressing .lzma files with or without end-of-payload marker, but all .lzma files created by xz will use end-of-payload marker and have uncompressed size marked as unknown in the .lzma header. This may be a problem in some uncommon situations. For example, a .lzma decompressor in an embedded device might work only with files that have known uncompressed size. If you hit this problem, you need to use LZMA Utils or LZMA SDK to create .lzma files with known uncompressed size. Unsupported .lzma files The .lzma format allows lc values up to 8, and lp values up to 4. LZMA Utils can decompress files with any lc and lp, but always creates files with lc=3 and lp=0. Creating files with other lc and lp is possible with xz and with LZMA SDK. The implementation of the LZMA1 filter in liblzma requires that the sum of lc and lp must not exceed 4. Thus, .lzma files, which exceed this limitation, cannot be decompressed with xz. LZMA Utils creates only .lzma files which have a dictionary size of 2^n (a power of 2) but accepts files with any dictionary size. liblzma accepts only .lzma files which have a dictionary size of 2^n or 2^n + 2^(n-1). This is to decrease false positives when detecting .lzma files. These limitations shouldn't be a problem in practice, since practically all .lzma files have been compressed with settings that liblzma will accept. Trailing garbage When decompressing, LZMA Utils silently ignore everything after the first .lzma stream. In most situations, this is a bug. This also means that LZMA Utils don't support decompressing concatenated .lzma files. If there is data left after the first .lzma stream, xz considers the file to be corrupt unless --single-stream was used. This may break obscure scripts which have assumed that trailing garbage is ignored. NOTES Compressed output may vary The exact compressed output produced from the same uncompressed input file may vary between XZ Utils versions even if compression options are identical. This is because the encoder can be improved (faster or better compression) without affecting the file format. The output can vary even between different builds of the same XZ Utils version, if different build options are used. The above means that once --rsyncable has been implemented, the resulting files won't necessarily be rsyncable unless both old and new files have been compressed with the same xz version. This problem can be fixed if a part of the encoder implementation is frozen to keep rsyncable output stable across xz versions. Embedded .xz decompressors Embedded .xz decompressor implementations like XZ Embedded don't necessarily support files created with integrity check types other than none and crc32. Since the default is --check=crc64, you must use --check=none or --check=crc32 when creating files for embedded systems. Outside embedded systems, all .xz format decompressors support all the check types, or at least are able to decompress the file without verifying the integrity check if the particular check is not supported. XZ Embedded supports BCJ filters, but only with the default start offset.
Basics Compress the file foo into foo.xz using the default compression level (-6), and remove foo if compression is successful: xz foo Decompress bar.xz into bar and don't remove bar.xz even if decompression is successful: xz -dk bar.xz Create baz.tar.xz with the preset -4e (-4 --extreme), which is slower than the default -6, but needs less memory for compression and decompression (48 MiB and 5 MiB, respectively): tar cf - baz | xz -4e > baz.tar.xz A mix of compressed and uncompressed files can be decompressed to standard output with a single command: xz -dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt Parallel compression of many files On GNU and *BSD, find(1) and xargs(1) can be used to parallelize compression of many files: find . -type f \! -name '*.xz' -print0 \ | xargs -0r -P4 -n16 xz -T1 The -P option to xargs(1) sets the number of parallel xz processes. The best value for the -n option depends on how many files there are to be compressed. If there are only a couple of files, the value should probably be 1; with tens of thousands of files, 100 or even more may be appropriate to reduce the number of xz processes that xargs(1) will eventually create. The option -T1 for xz is there to force it to single-threaded mode, because xargs(1) is used to control the amount of parallelization. Robot mode Calculate how many bytes have been saved in total after compressing multiple files: xz --robot --list *.xz | awk '/^totals/{print $5-$4}' A script may want to know that it is using new enough xz. The following sh(1) script checks that the version number of the xz tool is at least 5.0.0. This method is compatible with old beta versions, which didn't support the --robot option: if ! eval "$(xz --robot --version 2> /dev/null)" || [ "$XZ_VERSION" -lt 50000002 ]; then echo "Your xz is too old." fi unset XZ_VERSION LIBLZMA_VERSION Set a memory usage limit for decompression using XZ_OPT, but if a limit has already been set, don't increase it: NEWLIM=$((123 << 20)) # 123 MiB OLDLIM=$(xz --robot --info-memory | cut -f3) if [ $OLDLIM -eq 0 -o $OLDLIM -gt $NEWLIM ]; then XZ_OPT="$XZ_OPT --memlimit-decompress=$NEWLIM" export XZ_OPT fi Custom compressor filter chains The simplest use for custom filter chains is customizing a LZMA2 preset. This can be useful, because the presets cover only a subset of the potentially useful combinations of compression settings. The CompCPU columns of the tables from the descriptions of the options -0 ... -9 and --extreme are useful when customizing LZMA2 presets. Here are the relevant parts collected from those two tables: Preset CompCPU -0 0 -1 1 -2 2 -3 3 -4 4 -5 5 -6 6 -5e 7 -6e 8 If you know that a file requires somewhat big dictionary (for example, 32 MiB) to compress well, but you want to compress it quicker than xz -8 would do, a preset with a low CompCPU value (for example, 1) can be modified to use a bigger dictionary: xz --lzma2=preset=1,dict=32MiB foo.tar With certain files, the above command may be faster than xz -6 while compressing significantly better. However, it must be emphasized that only some files benefit from a big dictionary while keeping the CompCPU value low. The most obvious situation, where a big dictionary can help a lot, is an archive containing very similar files of at least a few megabytes each. The dictionary size has to be significantly bigger than any individual file to allow LZMA2 to take full advantage of the similarities between consecutive files. If very high compressor and decompressor memory usage is fine, and the file being compressed is at least several hundred megabytes, it may be useful to use an even bigger dictionary than the 64 MiB that xz -9 would use: xz -vv --lzma2=dict=192MiB big_foo.tar Using -vv (--verbose --verbose) like in the above example can be useful to see the memory requirements of the compressor and decompressor. Remember that using a dictionary bigger than the size of the uncompressed file is waste of memory, so the above command isn't useful for small files. Sometimes the compression time doesn't matter, but the decompressor memory usage has to be kept low, for example, to make it possible to decompress the file on an embedded system. The following command uses -6e (-6 --extreme) as a base and sets the dictionary to only 64 KiB. The resulting file can be decompressed with XZ Embedded (that's why there is --check=crc32) using about 100 KiB of memory. xz --check=crc32 --lzma2=preset=6e,dict=64KiB foo If you want to squeeze out as many bytes as possible, adjusting the number of literal context bits (lc) and number of position bits (pb) can sometimes help. Adjusting the number of literal position bits (lp) might help too, but usually lc and pb are more important. For example, a source code archive contains mostly US-ASCII text, so something like the following might give slightly (like 0.1 %) smaller file than xz -6e (try also without lc=4): xz --lzma2=preset=6e,pb=0,lc=4 source_code.tar Using another filter together with LZMA2 can improve compression with certain file types. For example, to compress a x86-32 or x86-64 shared library using the x86 BCJ filter: xz --x86 --lzma2 libfoo.so Note that the order of the filter options is significant. If --x86 is specified after --lzma2, xz will give an error, because there cannot be any filter after LZMA2, and also because the x86 BCJ filter cannot be used as the last filter in the chain. The Delta filter together with LZMA2 can give good results with bitmap images. It should usually beat PNG, which has a few more advanced filters than simple delta but uses Deflate for the actual compression. The image has to be saved in uncompressed format, for example, as uncompressed TIFF. The distance parameter of the Delta filter is set to match the number of bytes per pixel in the image. For example, 24-bit RGB bitmap needs dist=3, and it is also good to pass pb=0 to LZMA2 to accommodate the three-byte alignment: xz --delta=dist=3 --lzma2=pb=0 foo.tiff If multiple images have been put into a single archive (for example, .tar), the Delta filter will work on that too as long as all images have the same number of bytes per pixel. SEE ALSO xzdec(1), xzdiff(1), xzgrep(1), xzless(1), xzmore(1), gzip(1), bzip2(1), 7z(1) XZ Utils: <https://tukaani.org/xz/> XZ Embedded: <https://tukaani.org/xz/embedded.html> LZMA SDK: <https://7-zip.org/sdk.html> Tukaani 2024-04-08 XZ(1)
fixqt4headers.pl
null
null
null
null
null
fitsdiff
null
null
null
null
null
lz4cat
lz4 is an extremely fast lossless compression algorithm, based on byte-aligned LZ77 family of compression scheme. lz4 offers compression speeds > 500 MB/s per core, linearly scalable with multi-core CPUs. It features an extremely fast decoder, offering speed in multiple GB/s per core, typically reaching RAM speed limit on multi-core systems. The native file format is the .lz4 format. Difference between lz4 and gzip lz4 supports a command line syntax similar but not identical to gzip(1). Differences are : • lz4 compresses a single file by default (see -m for multiple files) • lz4 file1 file2 means : compress file1 into file2 • lz4 file.lz4 will default to decompression (use -z to force compression) • lz4 preserves original files (see --rm to erase source file on completion) • lz4 shows real-time notification statistics during compression or decompression of a single file (use -q to silence them) • When no destination is specified, result is sent on implicit output, which depends on stdout status. When stdout is Not the console, it becomes the implicit output. Otherwise, if stdout is the console, the implicit output is filename.lz4. • It is considered bad practice to rely on implicit output in scripts. because the script´s environment may change. Always use explicit output in scripts. -c ensures that output will be stdout. Conversely, providing a destination name, or using -m ensures that the output will be either the specified name, or filename.lz4 respectively. Default behaviors can be modified by opt-in commands, detailed below. • lz4 -m makes it possible to provide multiple input filenames, which will be compressed into files using suffix .lz4. Progress notifications become disabled by default (use -v to enable them). This mode has a behavior which more closely mimics gzip command line, with the main remaining difference being that source files are preserved by default. • Similarly, lz4 -m -d can decompress multiple *.lz4 files. • It´s possible to opt-in to erase source files on successful compression or decompression, using --rm command. • Consequently, lz4 -m --rm behaves the same as gzip. Concatenation of .lz4 files It is possible to concatenate .lz4 files as is. lz4 will decompress such files as if they were a single .lz4 file. For example: lz4 file1 > foo.lz4 lz4 file2 >> foo.lz4 Then lz4cat foo.lz4 is equivalent to cat file1 file2.
lz4 - lz4, unlz4, lz4cat - Compress or decompress .lz4 files
lz4 [OPTIONS] [-|INPUT-FILE] OUTPUT-FILE unlz4 is equivalent to lz4 -d lz4cat is equivalent to lz4 -dcfm When writing scripts that need to decompress files, it is recommended to always use the name lz4 with appropriate arguments (lz4 -d or lz4 -dc) instead of the names unlz4 and lz4cat.
Short commands concatenation In some cases, some options can be expressed using short command -x or long command --long-word. Short commands can be concatenated together. For example, -d -c is equivalent to -dc. Long commands cannot be concatenated. They must be clearly separated by a space. Multiple commands When multiple contradictory commands are issued on a same command line, only the latest one will be applied. Operation mode -z --compress Compress. This is the default operation mode when no operation mode option is specified, no other operation mode is implied from the command name (for example, unlz4 implies --decompress), nor from the input file name (for example, a file extension .lz4 implies --decompress by default). -z can also be used to force compression of an already compressed .lz4 file. -d --decompress --uncompress Decompress. --decompress is also the default operation when the input filename has an .lz4 extension. -t --test Test the integrity of compressed .lz4 files. The decompressed data is discarded. No files are created nor removed. -b# Benchmark mode, using # compression level. --list List information about .lz4 files. note : current implementation is limited to single-frame .lz4 files. Operation modifiers -# Compression level, with # being any value from 1 to 12. Higher values trade compression speed for compression ratio. Values above 12 are considered the same as 12. Recommended values are 1 for fast compression (default), and 9 for high compression. Speed/compression trade-off will vary depending on data to compress. Decompression speed remains fast at all settings. --fast[=#] Switch to ultra-fast compression levels. The higher the value, the faster the compression speed, at the cost of some compression ratio. If =# is not present, it defaults to 1. This setting overrides compression level if one was set previously. Similarly, if a compression level is set after --fast, it overrides it. --best Set highest compression level. Same as -12. --favor-decSpeed Generate compressed data optimized for decompression speed. Compressed data will be larger as a consequence (typically by ~0.5%), while decompression speed will be improved by 5-20%, depending on use cases. This option only works in combination with very high compression levels (>=10). -D dictionaryName Compress, decompress or benchmark using dictionary dictionaryName. Compression and decompression must use the same dictionary to be compatible. Using a different dictionary during decompression will either abort due to decompression error, or generate a checksum error. -f --[no-]force This option has several effects: If the target file already exists, overwrite it without prompting. When used with --decompress and lz4 cannot recognize the type of the source file, copy the source file as is to standard output. This allows lz4cat --force to be used like cat (1) for files that have not been compressed with lz4. -c --stdout --to-stdout Force write to standard output, even if it is the console. -m --multiple Multiple input files. Compressed file names will be appended a .lz4 suffix. This mode also reduces notification level. Can also be used to list multiple files. lz4 -m has a behavior equivalent to gzip -k (it preserves source files by default). -r operate recursively on directories. This mode also sets -m (multiple input files). -B# Block size [4-7](default : 7) -B4= 64KB ; -B5= 256KB ; -B6= 1MB ; -B7= 4MB -BI Produce independent blocks (default) -BD Blocks depend on predecessors (improves compression ratio, more noticeable on small blocks) -BX Generate block checksums (default:disabled) --[no-]frame-crc Select frame checksum (default:enabled) --no-crc Disable both frame and block checksums --[no-]content-size Header includes original size (default:not present) Note : this option can only be activated when the original size can be determined, hence for a file. It won´t work with unknown source size, such as stdin or pipe. --[no-]sparse Sparse mode support (default:enabled on file, disabled on stdout) -l Use Legacy format (typically for Linux Kernel compression) Note : -l is not compatible with -m (--multiple) nor -r Other options -v --verbose Verbose mode -q --quiet Suppress warnings and real-time statistics; specify twice to suppress errors too -h -H --help Display help/long help and exit -V --version Display Version number and exit -k --keep Preserve source files (default behavior) --rm Delete source files on successful compression or decompression -- Treat all subsequent arguments as files Benchmark mode -b# Benchmark file(s), using # compression level -e# Benchmark multiple compression levels, from b# to e# (included) -i# Minimum evaluation time in seconds [1-9] (default : 3) BUGS Report bugs at: https://github.com/lz4/lz4/issues AUTHOR Yann Collet lz4 v1.9.4 August 2022 LZ4(1)
null
xmlpatterns
null
null
null
null
null
kinit
kinit obtains and caches an initial ticket-granting ticket for principal. If principal is absent, kinit chooses an appropriate principal name based on existing credential cache contents or the local username of the user invoking kinit. Some options modify the choice of principal name.
kinit - obtain and cache Kerberos ticket-granting ticket
kinit [-V] [-l lifetime] [-s start_time] [-r renewable_life] [-p | -P] [-f | -F] [-a] [-A] [-C] [-E] [-v] [-R] [-k [-i | -t keytab_file]] [-c cache_name] [-n] [-S service_name] [-I input_ccache] [-T armor_ccache] [-X attribute[=value]] [--request-pac | --no-request-pac] [principal]
-V display verbose output. -l lifetime (duration string.) Requests a ticket with the lifetime lifetime. For example, kinit -l 5:30 or kinit -l 5h30m. If the -l option is not specified, the default ticket lifetime (configured by each site) is used. Specifying a ticket lifetime longer than the maximum ticket lifetime (configured by each site) will not override the configured maximum ticket lifetime. -s start_time (duration string.) Requests a postdated ticket. Postdated tickets are issued with the invalid flag set, and need to be resubmitted to the KDC for validation before use. start_time specifies the duration of the delay before the ticket can become valid. -r renewable_life (duration string.) Requests renewable tickets, with a total lifetime of renewable_life. -f requests forwardable tickets. -F requests non-forwardable tickets. -p requests proxiable tickets. -P requests non-proxiable tickets. -a requests tickets restricted to the host's local address[es]. -A requests tickets not restricted by address. -C requests canonicalization of the principal name, and allows the KDC to reply with a different client principal from the one requested. -E treats the principal name as an enterprise name. -v requests that the ticket-granting ticket in the cache (with the invalid flag set) be passed to the KDC for validation. If the ticket is within its requested time range, the cache is replaced with the validated ticket. -R requests renewal of the ticket-granting ticket. Note that an expired ticket cannot be renewed, even if the ticket is still within its renewable life. Note that renewable tickets that have expired as reported by klist(1) may sometimes be renewed using this option, because the KDC applies a grace period to account for client-KDC clock skew. See krb5.conf(5) clockskew setting. -k [-i | -t keytab_file] requests a ticket, obtained from a key in the local host's keytab. The location of the keytab may be specified with the -t keytab_file option, or with the -i option to specify the use of the default client keytab; otherwise the default keytab will be used. By default, a host ticket for the local host is requested, but any principal may be specified. On a KDC, the special keytab location KDB: can be used to indicate that kinit should open the KDC database and look up the key directly. This permits an administrator to obtain tickets as any principal that supports authentication based on the key. -n Requests anonymous processing. Two types of anonymous principals are supported. For fully anonymous Kerberos, configure pkinit on the KDC and configure pkinit_anchors in the client's krb5.conf(5). Then use the -n option with a principal of the form @REALM (an empty principal name followed by the at-sign and a realm name). If permitted by the KDC, an anonymous ticket will be returned. A second form of anonymous tickets is supported; these realm-exposed tickets hide the identity of the client but not the client's realm. For this mode, use kinit -n with a normal principal name. If supported by the KDC, the principal (but not realm) will be replaced by the anonymous principal. As of release 1.8, the MIT Kerberos KDC only supports fully anonymous operation. -I input_ccache Specifies the name of a credentials cache that already contains a ticket. When obtaining that ticket, if information about how that ticket was obtained was also stored to the cache, that information will be used to affect how new credentials are obtained, including preselecting the same methods of authenticating to the KDC. -T armor_ccache Specifies the name of a credentials cache that already contains a ticket. If supported by the KDC, this cache will be used to armor the request, preventing offline dictionary attacks and allowing the use of additional preauthentication mechanisms. Armoring also makes sure that the response from the KDC is not modified in transit. -c cache_name use cache_name as the Kerberos 5 credentials (ticket) cache location. If this option is not used, the default cache location is used. The default cache location may vary between systems. If the KRB5CCNAME environment variable is set, its value is used to locate the default cache. If a principal name is specified and the type of the default cache supports a collection (such as the DIR type), an existing cache containing credentials for the principal is selected or a new one is created and becomes the new primary cache. Otherwise, any existing contents of the default cache are destroyed by kinit. -S service_name specify an alternate service name to use when getting initial tickets. -X attribute[=value] specify a pre-authentication attribute and value to be interpreted by pre-authentication modules. The acceptable attribute and value values vary from module to module. This option may be specified multiple times to specify multiple attributes. If no value is specified, it is assumed to be "yes". The following attributes are recognized by the PKINIT pre-authentication mechanism: X509_user_identity=value specify where to find user's X509 identity information X509_anchors=value specify where to find trusted X509 anchor information flag_RSA_PROTOCOL[=yes] specify use of RSA, rather than the default Diffie-Hellman protocol disable_freshness[=yes] disable sending freshness tokens (for testing purposes only) --request-pac | --no-request-pac mutually exclusive. If --request-pac is set, ask the KDC to include a PAC in authdata; if --no-request-pac is set, ask the KDC not to include a PAC; if neither are set, the KDC will follow its default, which is typically is to include a PAC if doing so is supported. ENVIRONMENT See kerberos(7) for a description of Kerberos environment variables. FILES KCM: default location of Kerberos 5 credentials cache FILE:/etc/krb5.keytab default location for the local host's keytab. SEE ALSO klist(1), kdestroy(1), kerberos(7) AUTHOR MIT COPYRIGHT 1985-2022, MIT 1.20.1 KINIT(1)
null
pdftext
null
null
null
null
null
bsdtar
tar creates and manipulates streaming archive files. This implementation can extract from tar, pax, cpio, zip, jar, ar, xar, rpm, 7-zip, and ISO 9660 cdrom images and can create tar, pax, cpio, ar, zip, 7-zip, and shar archives. The first synopsis form shows a “bundled” option word. This usage is provided for compatibility with historical implementations. See COMPATIBILITY below for details. The other synopsis forms show the preferred usage. The first option to tar is a mode indicator from the following list: -c Create a new archive containing the specified items. The long option form is --create. -r Like -c, but new entries are appended to the archive. Note that this only works on uncompressed archives stored in regular files. The -f option is required. The long option form is --append. -t List archive contents to stdout. The long option form is --list. -u Like -r, but new entries are added only if they have a modification date newer than the corresponding entry in the archive. Note that this only works on uncompressed archives stored in regular files. The -f option is required. The long form is --update. -x Extract to disk from the archive. If a file with the same name appears more than once in the archive, each copy will be extracted, with later copies overwriting (replacing) earlier copies. The long option form is --extract. In -c, -r, or -u mode, each specified file or directory is added to the archive in the order specified on the command line. By default, the contents of each directory are also archived. In extract or list mode, the entire command line is read and parsed before the archive is opened. The pathnames or patterns on the command line indicate which items in the archive should be processed. Patterns are shell-style globbing patterns as documented in tcsh(1).
tar – manipulate tape archives
tar [bundled-flags ⟨args⟩] [⟨file⟩ | ⟨pattern⟩ ...] tar {-c} [options] [files | directories] tar {-r | -u} -f archive-file [options] [files | directories] tar {-t | -x} [options] [patterns]
Unless specifically stated otherwise, options are applicable in all operating modes. @archive (c and r modes only) The specified archive is opened and the entries in it will be appended to the current archive. As a simple example, tar -c -f - newfile @original.tar writes a new archive to standard output containing a file newfile and all of the entries from original.tar. In contrast, tar -c -f - newfile original.tar creates a new archive with only two entries. Similarly, tar -czf - --format pax @- reads an archive from standard input (whose format will be determined automatically) and converts it into a gzip-compressed pax-format archive on stdout. In this way, tar can be used to convert archives from one format to another. -a, --auto-compress (c mode only) Use the archive suffix to decide a set of the format and the compressions. As a simple example, tar -a -cf archive.tgz source.c source.h creates a new archive with restricted pax format and gzip compression, tar -a -cf archive.tar.bz2.uu source.c source.h creates a new archive with restricted pax format and bzip2 compression and uuencode compression, tar -a -cf archive.zip source.c source.h creates a new archive with zip format, tar -a -jcf archive.tgz source.c source.h ignores the “-j” option, and creates a new archive with restricted pax format and gzip compression, tar -a -jcf archive.xxx source.c source.h if it is unknown suffix or no suffix, creates a new archive with restricted pax format and bzip2 compression. --acls (c, r, u, x modes only) Archive or extract POSIX.1e or NFSv4 ACLs. This is the reverse of --no-acls and the default behavior in c, r, and u modes (except on Mac OS X) or if tar is run in x mode as root. On Mac OS X this option translates extended ACLs to NFSv4 ACLs. To store extended ACLs the --mac-metadata option is preferred. -B, --read-full-blocks Ignored for compatibility with other tar(1) implementations. -b blocksize, --block-size blocksize Specify the block size, in 512-byte records, for tape drive I/O. As a rule, this argument is only needed when reading from or writing to tape drives, and usually not even then as the default block size of 20 records (10240 bytes) is very common. -C directory, --cd directory, --directory directory In c and r mode, this changes the directory before adding the following files. In x mode, change directories after opening the archive but before extracting entries from the archive. --chroot (x mode only) chroot() to the current directory after processing any -C options and before extracting any files. --clear-nochange-fflags (x mode only) Before removing file system objects to replace them, clear platform-specific file attributes or file flags that might prevent removal. --exclude pattern Do not process files or directories that match the specified pattern. Note that exclusions take precedence over patterns or filenames specified on the command line. --exclude-vcs Do not process files or directories internally used by the version control systems ‘Arch’, ‘Bazaar’, ‘CVS’, ‘Darcs’, ‘Mercurial’, ‘RCS’, ‘SCCS’, ‘SVN’ and ‘git’. --fflags (c, r, u, x modes only) Archive or extract platform-specific file attributes or file flags. This is the reverse of --no-fflags and the default behavior in c, r, and u modes or if tar is run in x mode as root. --format format (c, r, u mode only) Use the specified format for the created archive. Supported formats include “cpio”, “pax”, “shar”, and “ustar”. Other formats may also be supported; see libarchive-formats(5) for more information about currently- supported formats. In r and u modes, when extending an existing archive, the format specified here must be compatible with the format of the existing archive on disk. -f file, --file file Read the archive from or write the archive to the specified file. The filename can be - for standard input or standard output. The default varies by system; on FreeBSD, the default is /dev/sa0; on Linux, the default is /dev/st0. --gid id Use the provided group id number. On extract, this overrides the group id in the archive; the group name in the archive will be ignored. On create, this overrides the group id read from disk; if --gname is not also specified, the group name will be set to match the group id. --gname name Use the provided group name. On extract, this overrides the group name in the archive; if the provided group name does not exist on the system, the group id (from the archive or from the --gid option) will be used instead. On create, this sets the group name that will be stored in the archive; the name will not be verified against the system group database. -H (c and r modes only) Symbolic links named on the command line will be followed; the target of the link will be archived, not the link itself. -h (c and r modes only) Synonym for -L. -I Synonym for -T. --help Show usage. --hfsCompression (x mode only) Mac OS X specific (v10.6 or later). Compress extracted regular files with HFS+ compression. --ignore-zeros An alias of --options read_concatenated_archives for compatibility with GNU tar. --include pattern Process only files or directories that match the specified pattern. Note that exclusions specified with --exclude take precedence over inclusions. If no inclusions are explicitly specified, all entries are processed by default. The --include option is especially useful when filtering archives. For example, the command tar -c -f new.tar --include='*foo*' @old.tgz creates a new archive new.tar containing only the entries from old.tgz containing the string ‘foo’. -J, --xz (c mode only) Compress the resulting archive with xz(1). In extract or list modes, this option is ignored. Note that this tar implementation recognizes XZ compression automatically when reading archives. -j, --bzip, --bzip2, --bunzip2 (c mode only) Compress the resulting archive with bzip2(1). In extract or list modes, this option is ignored. Note that this tar implementation recognizes bzip2 compression automatically when reading archives. -k, --keep-old-files (x mode only) Do not overwrite existing files. In particular, if a file appears more than once in an archive, later copies will not overwrite earlier copies. --keep-newer-files (x mode only) Do not overwrite existing files that are newer than the versions appearing in the archive being extracted. -L, --dereference (c and r modes only) All symbolic links will be followed. Normally, symbolic links are archived as such. With this option, the target of the link will be archived instead. -l, --check-links (c and r modes only) Issue a warning message unless all links to each file are archived. --lrzip (c mode only) Compress the resulting archive with lrzip(1). In extract or list modes, this option is ignored. Note that this tar implementation recognizes lrzip compression automatically when reading archives. --lz4 (c mode only) Compress the archive with lz4-compatible compression before writing it. In extract or list modes, this option is ignored. Note that this tar implementation recognizes lz4 compression automatically when reading archives. --zstd (c mode only) Compress the archive with zstd-compatible compression before writing it. In extract or list modes, this option is ignored. Note that this tar implementation recognizes zstd compression automatically when reading archives. --lzma (c mode only) Compress the resulting archive with the original LZMA algorithm. In extract or list modes, this option is ignored. Use of this option is discouraged and new archives should be created with --xz instead. Note that this tar implementation recognizes LZMA compression automatically when reading archives. --lzop (c mode only) Compress the resulting archive with lzop(1). In extract or list modes, this option is ignored. Note that this tar implementation recognizes LZO compression automatically when reading archives. -m, --modification-time (x mode only) Do not extract modification time. By default, the modification time is set to the time stored in the archive. --mac-metadata (c, r, u and x mode only) Mac OS X specific. Archive or extract extended ACLs and extended file attributes using copyfile(3) in AppleDouble format. This is the reverse of --no-mac-metadata. and the default behavior in c, r, and u modes or if tar is run in x mode as root. -n, --norecurse, --no-recursion Do not operate recursively on the content of directories. --newer date (c, r, u modes only) Only include files and directories newer than the specified date. This compares ctime entries. --newer-mtime date (c, r, u modes only) Like --newer, except it compares mtime entries instead of ctime entries. --newer-than file (c, r, u modes only) Only include files and directories newer than the specified file. This compares ctime entries. --newer-mtime-than file (c, r, u modes only) Like --newer-than, except it compares mtime entries instead of ctime entries. --nodump (c and r modes only) Honor the nodump file flag by skipping this file. --nopreserveHFSCompression (x mode only) Mac OS X specific (v10.6 or later). Do not compress extracted regular files which were compressed with HFS+ compression before archived. By default, compress the regular files again with HFS+ compression. --null (use with -I or -T) Filenames or patterns are separated by null characters, not by newlines. This is often used to read filenames output by the -print0 option to find(1). --no-acls (c, r, u, x modes only) Do not archive or extract POSIX.1e or NFSv4 ACLs. This is the reverse of --acls and the default behavior if tar is run as non-root in x mode (on Mac OS X as any user in c, r, u and x modes). --no-fflags (c, r, u, x modes only) Do not archive or extract file attributes or file flags. This is the reverse of --fflags and the default behavior if tar is run as non-root in x mode. --no-mac-metadata (x mode only) Mac OS X specific. Do not archive or extract ACLs and extended file attributes using copyfile(3) in AppleDouble format. This is the reverse of --mac-metadata. and the default behavior if tar is run as non-root in x mode. --no-read-sparse (c, r, u modes only) Do not read sparse file information from disk. This is the reverse of --read-sparse. --no-safe-writes (x mode only) Do not create temporary files and use rename(2) to replace the original ones. This is the reverse of --safe-writes. --no-same-owner (x mode only) Do not extract owner and group IDs. This is the reverse of --same-owner and the default behavior if tar is run as non-root. --no-same-permissions (x mode only) Do not extract full permissions (SGID, SUID, sticky bit, file attributes or file flags, extended file attributes and ACLs). This is the reverse of -p and the default behavior if tar is run as non-root. --no-xattrs (c, r, u, x modes only) Do not archive or extract extended file attributes. This is the reverse of --xattrs and the default behavior if tar is run as non-root in x mode. --numeric-owner This is equivalent to --uname "" --gname "". On extract, it causes user and group names in the archive to be ignored in favor of the numeric user and group ids. On create, it causes user and group names to not be stored in the archive. -O, --to-stdout (x, t modes only) In extract (-x) mode, files will be written to standard out rather than being extracted to disk. In list (-t) mode, the file listing will be written to stderr rather than the usual stdout. -o (x mode) Use the user and group of the user running the program rather than those specified in the archive. Note that this has no significance unless -p is specified, and the program is being run by the root user. In this case, the file modes and flags from the archive will be restored, but ACLs or owner information in the archive will be discarded. -o (c, r, u mode) A synonym for --format ustar --older date (c, r, u modes only) Only include files and directories older than the specified date. This compares ctime entries. --older-mtime date (c, r, u modes only) Like --older, except it compares mtime entries instead of ctime entries. --older-than file (c, r, u modes only) Only include files and directories older than the specified file. This compares ctime entries. --older-mtime-than file (c, r, u modes only) Like --older-than, except it compares mtime entries instead of ctime entries. --one-file-system (c, r, and u modes) Do not cross mount points. --options options Select optional behaviors for particular modules. The argument is a text string containing comma-separated keywords and values. These are passed to the modules that handle particular formats to control how those formats will behave. Each option has one of the following forms: key=value The key will be set to the specified value in every module that supports it. Modules that do not support this key will ignore it. key The key will be enabled in every module that supports it. This is equivalent to key=1. !key The key will be disabled in every module that supports it. module:key=value, module:key, module:!key As above, but the corresponding key and value will be provided only to modules whose name matches module. The complete list of supported modules and keys for create and append modes is in archive_write_set_options(3) and for extract and list modes in archive_read_set_options(3). Examples of supported options: iso9660:joliet Support Joliet extensions. This is enabled by default, use !joliet or iso9660:!joliet to disable. iso9660:rockridge Support Rock Ridge extensions. This is enabled by default, use !rockridge or iso9660:!rockridge to disable. gzip:compression-level A decimal integer from 1 to 9 specifying the gzip compression level. gzip:timestamp Store timestamp. This is enabled by default, use !timestamp or gzip:!timestamp to disable. lrzip:compression=type Use type as compression method. Supported values are bzip2, gzip, lzo (ultra fast), and zpaq (best, extremely slow). lrzip:compression-level A decimal integer from 1 to 9 specifying the lrzip compression level. lz4:compression-level A decimal integer from 1 to 9 specifying the lzop compression level. lz4:stream-checksum Enable stream checksum. This is by default, use lz4:!stream-checksum to disable. lz4:block-checksum Enable block checksum (Disabled by default). lz4:block-size A decimal integer from 4 to 7 specifying the lz4 compression block size (7 is set by default). lz4:block-dependence Use the previous block of the block being compressed for a compression dictionary to improve compression ratio. zstd:compression-level A decimal integer specifying the zstd compression level. Supported values depend on the library version, common values are from 1 to 22. zstd:threads Specify the number of worker threads to use. Setting threads to a special value 0 makes zstd(1) use as many threads as there are CPU cores on the system. lzop:compression-level A decimal integer from 1 to 9 specifying the lzop compression level. xz:compression-level A decimal integer from 0 to 9 specifying the xz compression level. xz:threads Specify the number of worker threads to use. Setting threads to a special value 0 makes xz(1) use as many threads as there are CPU cores on the system. mtree:keyword The mtree writer module allows you to specify which mtree keywords will be included in the output. Supported keywords include: cksum, device, flags, gid, gname, indent, link, md5, mode, nlink, rmd160, sha1, sha256, sha384, sha512, size, time, uid, uname. The default is equivalent to: “device, flags, gid, gname, link, mode, nlink, size, time, type, uid, uname”. mtree:all Enables all of the above keywords. You can also use mtree:!all to disable all keywords. mtree:use-set Enable generation of /set lines in the output. mtree:indent Produce human-readable output by indenting options and splitting lines to fit into 80 columns. zip:compression=type Use type as compression method. Supported values are store (uncompressed) and deflate (gzip algorithm). zip:encryption Enable encryption using traditional zip encryption. zip:encryption=type Use type as encryption type. Supported values are zipcrypt (traditional zip encryption), aes128 (WinZip AES-128 encryption) and aes256 (WinZip AES-256 encryption). read_concatenated_archives Ignore zeroed blocks in the archive, which occurs when multiple tar archives have been concatenated together. Without this option, only the contents of the first concatenated archive would be read. This option is comparable to the -i, --ignore-zeros option of GNU tar. If a provided option is not supported by any module, that is a fatal error. -P, --absolute-paths Preserve pathnames. By default, absolute pathnames (those that begin with a / character) have the leading slash removed both when creating archives and extracting from them. Also, tar will refuse to extract archive entries whose pathnames contain .. or whose target directory would be altered by a symlink. This option suppresses these behaviors. -p, --insecure, --preserve-permissions (x mode only) Preserve file permissions. Attempt to restore the full permissions, including file modes, file attributes or file flags, extended file attributes and ACLs, if available, for each item extracted from the archive. This is the reverse of --no-same-permissions and the default if tar is being run as root. It can be partially overridden by also specifying --no-acls, --no-fflags, --no-mac-metadata or --no-xattrs. --passphrase passphrase The passphrase is used to extract or create an encrypted archive. Currently, zip is the only supported format that supports encryption. You shouldn't use this option unless you realize how insecure use of this option is. --posix (c, r, u mode only) Synonym for --format pax -q, --fast-read (x and t mode only) Extract or list only the first archive entry that matches each pattern or filename operand. Exit as soon as each specified pattern or filename has been matched. By default, the archive is always read to the very end, since there can be multiple entries with the same name and, by convention, later entries overwrite earlier entries. This option is provided as a performance optimization. --read-sparse (c, r, u modes only) Read sparse file information from disk. This is the reverse of --no-read-sparse and the default behavior. -S (x mode only) Extract files as sparse files. For every block on disk, check first if it contains only NULL bytes and seek over it otherwise. This works similar to the conv=sparse option of dd. -s pattern Modify file or archive member names according to pattern. The pattern has the format /old/new/[ghHprRsS] where old is a basic regular expression, new is the replacement string of the matched part, and the optional trailing letters modify how the replacement is handled. If old is not matched, the pattern is skipped. Within new, ~ is substituted with the match, \1 to \9 with the content of the corresponding captured group. The optional trailing g specifies that matching should continue after the matched part and stop on the first unmatched pattern. The optional trailing s specifies that the pattern applies to the value of symbolic links. The optional trailing p specifies that after a successful substitution the original path name and the new path name should be printed to standard error. Optional trailing H, R, or S characters suppress substitutions for hardlink targets, regular filenames, or symlink targets, respectively. Optional trailing h, r, or s characters enable substitutions for hardlink targets, regular filenames, or symlink targets, respectively. The default is hrs which applies substitutions to all names. In particular, it is never necessary to specify h, r, or s. --safe-writes (x mode only) Extract files atomically. By default tar unlinks the original file with the same name as the extracted file (if it exists), and then creates it immediately under the same name and writes to it. For a short period of time, applications trying to access the file might not find it, or see incomplete results. If --safe-writes is enabled, tar first creates a unique temporary file, then writes the new contents to the temporary file, and finally renames the temporary file to its final name atomically using rename(2). This guarantees that an application accessing the file, will either see the old contents or the new contents at all times. --same-owner (x mode only) Extract owner and group IDs. This is the reverse of --no-same-owner and the default behavior if tar is run as root. --strip-components count Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped. Note that the pathname is edited after checking inclusion/exclusion patterns but before security checks. -T filename, --files-from filename In x or t mode, tar will read the list of names to be extracted from filename. In c mode, tar will read names to be archived from filename. The special name “-C” on a line by itself will cause the current directory to be changed to the directory specified on the following line. Names are terminated by newlines unless --null is specified. Note that --null also disables the special handling of lines containing “-C”. Note: If you are generating lists of files using find(1), you probably want to use -n as well. --totals (c, r, u modes only) After archiving all files, print a summary to stderr. -U, --unlink, --unlink-first (x mode only) Unlink files before creating them. This can be a minor performance optimization if most files already exist, but can make things slower if most files do not already exist. This flag also causes tar to remove intervening directory symlinks instead of reporting an error. See the SECURITY section below for more details. --uid id Use the provided user id number and ignore the user name from the archive. On create, if --uname is not also specified, the user name will be set to match the user id. --uname name Use the provided user name. On extract, this overrides the user name in the archive; if the provided user name does not exist on the system, it will be ignored and the user id (from the archive or from the --uid option) will be used instead. On create, this sets the user name that will be stored in the archive; the name is not verified against the system user database. --use-compress-program program Pipe the input (in x or t mode) or the output (in c mode) through program instead of using the builtin compression support. -v, --verbose Produce verbose output. In create and extract modes, tar will list each file name as it is read from or written to the archive. In list mode, tar will produce output similar to that of ls(1). An additional -v option will also provide ls-like details in create and extract mode. --version Print version of tar and libarchive, and exit. -w, --confirmation, --interactive Ask for confirmation for every action. -X filename, --exclude-from filename Read a list of exclusion patterns from the specified file. See --exclude for more information about the handling of exclusions. --xattrs (c, r, u, x modes only) Archive or extract extended file attributes. This is the reverse of --no-xattrs and the default behavior in c, r, and u modes or if tar is run in x mode as root. -y (c mode only) Compress the resulting archive with bzip2(1). In extract or list modes, this option is ignored. Note that this tar implementation recognizes bzip2 compression automatically when reading archives. -Z, --compress, --uncompress (c mode only) Compress the resulting archive with compress(1). In extract or list modes, this option is ignored. Note that this tar implementation recognizes compress compression automatically when reading archives. -z, --gunzip, --gzip (c mode only) Compress the resulting archive with gzip(1). In extract or list modes, this option is ignored. Note that this tar implementation recognizes gzip compression automatically when reading archives. ENVIRONMENT The following environment variables affect the execution of tar: TAR_READER_OPTIONS The default options for format readers and compression readers. The --options option overrides this. TAR_WRITER_OPTIONS The default options for format writers and compression writers. The --options option overrides this. LANG The locale to use. See environ(7) for more information. TAPE The default device. The -f option overrides this. Please see the description of the -f option above for more details. TZ The timezone to use when displaying dates. See environ(7) for more information. EXIT STATUS The tar utility exits 0 on success, and >0 if an error occurs.
The following creates a new archive called file.tar.gz that contains two files source.c and source.h: tar -czf file.tar.gz source.c source.h To view a detailed table of contents for this archive: tar -tvf file.tar.gz To extract all entries from the archive on the default tape drive: tar -x To examine the contents of an ISO 9660 cdrom image: tar -tf image.iso To move file hierarchies, invoke tar as tar -cf - -C srcdir . | tar -xpf - -C destdir or more traditionally cd srcdir ; tar -cf - . | (cd destdir ; tar -xpf -) In create mode, the list of files and directories to be archived can also include directory change instructions of the form -Cfoo/baz and archive inclusions of the form @archive-file. For example, the command line tar -c -f new.tar foo1 @old.tgz -C/tmp foo2 will create a new archive new.tar. tar will read the file foo1 from the current directory and add it to the output archive. It will then read each entry from old.tgz and add those entries to the output archive. Finally, it will switch to the /tmp directory and add foo2 to the output archive. An input file in mtree(5) format can be used to create an output archive with arbitrary ownership, permissions, or names that differ from existing data on disk: $ cat input.mtree #mtree usr/bin uid=0 gid=0 mode=0755 type=dir usr/bin/ls uid=0 gid=0 mode=0755 type=file content=myls $ tar -cvf output.tar @input.mtree The --newer and --newer-mtime switches accept a variety of common date and time specifications, including “12 Mar 2005 7:14:29pm”, “2005-03-12 19:14”, “5 minutes ago”, and “19:14 PST May 1”. The --options argument can be used to control various details of archive generation or reading. For example, you can generate mtree output which only contains type, time, and uid keywords: tar -cf file.tar --format=mtree --options='!all,type,time,uid' dir or you can set the compression level used by gzip or xz compression: tar -czf file.tar --options='compression-level=9'. For more details, see the explanation of the archive_read_set_options() and archive_write_set_options() API calls that are described in archive_read(3) and archive_write(3). COMPATIBILITY The bundled-arguments format is supported for compatibility with historic implementations. It consists of an initial word (with no leading - character) in which each character indicates an option. Arguments follow as separate words. The order of the arguments must match the order of the corresponding characters in the bundled command word. For example, tar tbf 32 file.tar specifies three flags t, b, and f. The b and f flags both require arguments, so there must be two additional items on the command line. The 32 is the argument to the b flag, and file.tar is the argument to the f flag. The mode options c, r, t, u, and x and the options b, f, l, m, o, v, and w comply with SUSv2. For maximum portability, scripts that invoke tar should use the bundled- argument format above, should limit themselves to the c, t, and x modes, and the b, f, m, v, and w options. Additional long options are provided to improve compatibility with other tar implementations. SECURITY Certain security issues are common to many archiving programs, including tar. In particular, carefully-crafted archives can request that tar extract files to locations outside of the target directory. This can potentially be used to cause unwitting users to overwrite files they did not intend to overwrite. If the archive is being extracted by the superuser, any file on the system can potentially be overwritten. There are three ways this can happen. Although tar has mechanisms to protect against each one, savvy users should be aware of the implications: • Archive entries can have absolute pathnames. By default, tar removes the leading / character from filenames before restoring them to guard against this problem. • Archive entries can have pathnames that include .. components. By default, tar will not extract files containing .. components in their pathname. • Archive entries can exploit symbolic links to restore files to other directories. An archive can restore a symbolic link to another directory, then use that link to restore a file into that directory. To guard against this, tar checks each extracted path for symlinks. If the final path element is a symlink, it will be removed and replaced with the archive entry. If -U is specified, any intermediate symlink will also be unconditionally removed. If neither -U nor -P is specified, tar will refuse to extract the entry. To protect yourself, you should be wary of any archives that come from untrusted sources. You should examine the contents of an archive with tar -tf filename before extraction. You should use the -k option to ensure that tar will not overwrite any existing files or the -U option to remove any pre- existing files. You should generally not extract archives while running with super-user privileges. Note that the -P option to tar disables the security checks above and allows you to extract an archive while preserving any absolute pathnames, .. components, or symlinks to other directories. SEE ALSO bzip2(1), compress(1), cpio(1), gzip(1), mt(1), pax(1), shar(1), xz(1), libarchive(3), libarchive-formats(5), tar(5) STANDARDS There is no current POSIX standard for the tar command; it appeared in ISO/IEC 9945-1:1996 (“POSIX.1”) but was dropped from IEEE Std 1003.1-2001 (“POSIX.1”). The options supported by this implementation were developed by surveying a number of existing tar implementations as well as the old POSIX specification for tar and the current POSIX specification for pax. The ustar and pax interchange file formats are defined by IEEE Std 1003.1-2001 (“POSIX.1”) for the pax command. HISTORY A tar command appeared in Seventh Edition Unix, which was released in January, 1979. There have been numerous other implementations, many of which extended the file format. John Gilmore's pdtar public-domain implementation (circa November, 1987) was quite influential, and formed the basis of GNU tar. GNU tar was included as the standard system tar in FreeBSD beginning with FreeBSD 1.0. This is a complete re-implementation based on the libarchive(3) library. It was first released with FreeBSD 5.4 in May, 2005. BUGS This program follows ISO/IEC 9945-1:1996 (“POSIX.1”) for the definition of the -l option. Note that GNU tar prior to version 1.15 treated -l as a synonym for the --one-file-system option. The -C dir option may differ from historic implementations. All archive output is written in correctly-sized blocks, even if the output is being compressed. Whether or not the last output block is padded to a full block size varies depending on the format and the output device. For tar and cpio formats, the last block of output is padded to a full block size if the output is being written to standard output or to a character or block device such as a tape drive. If the output is being written to a regular file, the last block will not be padded. Many compressors, including gzip(1) and bzip2(1), complain about the null padding when decompressing an archive created by tar, although they still extract it correctly. The compression and decompression is implemented internally, so there may be insignificant differences between the compressed output generated by tar -czf - file and that generated by tar -cf - file | gzip The default should be to read and write archives to the standard I/O paths, but tradition (and POSIX) dictates otherwise. The r and u modes require that the archive be uncompressed and located in a regular file on disk. Other archives can be modified using c mode with the @archive-file extension. To archive a file called @foo or -foo you must specify it as ./@foo or ./-foo, respectively. In create mode, a leading ./ is always removed. A leading / is stripped unless the -P option is specified. There needs to be better support for file selection on both create and extract. There is not yet any support for multi-volume archives. Converting between dissimilar archive formats (such as tar and cpio) using the @- convention can cause hard link information to be lost. (This is a consequence of the incompatible ways that different archive formats store hardlink information.) macOS 14.5 January 31, 2020 macOS 14.5
samp_hub
null
null
null
null
null
qdbusxml2cpp
null
null
null
null
null
kaleido
null
null
null
null
null
gif2h5
null
null
null
null
null
langchain-server
null
null
null
null
null
reset
The tput utility uses the terminfo database to make the values of terminal-dependent capabilities and information available to the shell (see sh(1)), to initialize or reset the terminal, or return the long name of the requested terminal type. The result depends upon the capability's type: string tput writes the string to the standard output. No trailing newline is supplied. integer tput writes the decimal value to the standard output, with a trailing newline. boolean tput simply sets the exit code (0 for TRUE if the terminal has the capability, 1 for FALSE if it does not), and writes nothing to the standard output. Before using a value returned on the standard output, the application should test the exit code (e.g., $?, see sh(1)) to be sure it is 0. (See the EXIT CODES and DIAGNOSTICS sections.) For a complete list of capabilities and the capname associated with each, see terminfo(5). -Ttype indicates the type of terminal. Normally this option is unnecessary, because the default is taken from the environment variable TERM. If -T is specified, then the shell variables LINES and COLUMNS will also be ignored. capname indicates the capability from the terminfo database. When termcap support is compiled in, the termcap name for the capability is also accepted. parms If the capability is a string that takes parameters, the arguments parms will be instantiated into the string. Most parameters are numbers. Only a few terminfo capabilities require string parameters; tput uses a table to decide which to pass as strings. Normally tput uses tparm (3X) to perform the substitution. If no parameters are given for the capability, tput writes the string without performing the substitution. -S allows more than one capability per invocation of tput. The capabilities must be passed to tput from the standard input instead of from the command line (see example). Only one capname is allowed per line. The -S option changes the meaning of the 0 and 1 boolean and string exit codes (see the EXIT CODES section). Again, tput uses a table and the presence of parameters in its input to decide whether to use tparm (3X), and how to interpret the parameters. -V reports the version of ncurses which was used in this program, and exits. init If the terminfo database is present and an entry for the user's terminal exists (see -Ttype, above), the following will occur: (1) if present, the terminal's initialization strings will be output as detailed in the terminfo(5) section on Tabs and Initialization, (2) any delays (e.g., newline) specified in the entry will be set in the tty driver, (3) tabs expansion will be turned on or off according to the specification in the entry, and (4) if tabs are not expanded, standard tabs will be set (every 8 spaces). If an entry does not contain the information needed for any of the four above activities, that activity will silently be skipped. reset Instead of putting out initialization strings, the terminal's reset strings will be output if present (rs1, rs2, rs3, rf). If the reset strings are not present, but initialization strings are, the initialization strings will be output. Otherwise, reset acts identically to init. longname If the terminfo database is present and an entry for the user's terminal exists (see -Ttype above), then the long name of the terminal will be put out. The long name is the last name in the first line of the terminal's description in the terminfo database [see term(5)]. If tput is invoked by a link named reset, this has the same effect as tput reset. See @TSET@ for comparison, which has similar behavior.
tput, reset - initialize a terminal or query terminfo database
tput [-Ttype] capname [parms ... ] tput [-Ttype] init tput [-Ttype] reset tput [-Ttype] longname tput -S << tput -V
null
tput init Initialize the terminal according to the type of terminal in the environmental variable TERM. This command should be included in everyone's .profile after the environmental variable TERM has been exported, as illustrated on the profile(5) manual page. tput -T5620 reset Reset an AT&T 5620 terminal, overriding the type of terminal in the environmental variable TERM. tput cup 0 0 Send the sequence to move the cursor to row 0, column 0 (the upper left corner of the screen, usually known as the "home" cursor position). tput clear Echo the clear-screen sequence for the current terminal. tput cols Print the number of columns for the current terminal. tput -T450 cols Print the number of columns for the 450 terminal. bold=`tput smso` offbold=`@TPUT@ rmso` Set the shell variables bold, to begin stand-out mode sequence, and offbold, to end standout mode sequence, for the current terminal. This might be followed by a prompt: echo "${bold}Please type in your name: ${offbold}\c" tput hc Set exit code to indicate if the current terminal is a hard copy terminal. tput cup 23 4 Send the sequence to move the cursor to row 23, column 4. tput cup Send the terminfo string for cursor-movement, with no parameters substituted. tput longname Print the long name from the terminfo database for the type of terminal specified in the environmental variable TERM. tput -S <<! > clear > cup 10 10 > bold > ! This example shows tput processing several capabilities in one invocation. It clears the screen, moves the cursor to position 10, 10 and turns on bold (extra bright) mode. The list is terminated by an exclamation mark (!) on a line by itself. FILES /usr/share/terminfo compiled terminal description database /usr/share/tabset/* tab settings for some terminals, in a format appropriate to be output to the terminal (escape sequences that set margins and tabs); for more information, see the "Tabs and Initialization" section of terminfo(5) EXIT CODES If the -S option is used, tput checks for errors from each line, and if any errors are found, will set the exit code to 4 plus the number of lines with errors. If no errors are found, the exit code is 0. No indication of which line failed can be given so exit code 1 will never appear. Exit codes 2, 3, and 4 retain their usual interpretation. If the -S option is not used, the exit code depends on the type of capname: boolean a value of 0 is set for TRUE and 1 for FALSE. string a value of 0 is set if the capname is defined for this terminal type (the value of capname is returned on standard output); a value of 1 is set if capname is not defined for this terminal type (nothing is written to standard output). integer a value of 0 is always set, whether or not capname is defined for this terminal type. To determine if capname is defined for this terminal type, the user must test the value written to standard output. A value of -1 means that capname is not defined for this terminal type. other reset or init may fail to find their respective files. In that case, the exit code is set to 4 + errno. Any other exit code indicates an error; see the DIAGNOSTICS section. DIAGNOSTICS tput prints the following error messages and sets the corresponding exit codes. exit code error message ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 0 (capname is a numeric variable that is not specified in the terminfo(5) database for this terminal type, e.g. tput -T450 lines and @TPUT@ -T2621 xmc) 1 no error message is printed, see the EXIT CODES section. 2 usage error 3 unknown terminal type or no terminfo database 4 unknown terminfo capability capname >4 error occurred in -S ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ PORTABILITY The longname and -S options, and the parameter-substitution features used in the cup example, are not supported in BSD curses or in AT&T/USL curses before SVr4. X/Open documents only the operands for clear, init and reset. In this implementation, clear is part of the capname support. Other implementations of tput on SVr4-based systems such as Solaris, IRIX64 and HPUX as well as others such as AIX and Tru64 provide support for capname operands. A few platforms such as FreeBSD and NetBSD recognize termcap names rather than terminfo capability names in their respective tput commands. Most implementations which provide support for capname operands use the tparm function to expand parameters in it. That function expects a mixture of numeric and string parameters, requiring tput to know which type to use. This implementation uses a table to determine that for the standard capname operands, and an internal library function to analyze nonstandard capname operands. Other implementations may simply guess that an operand containing only digits is intended to be a number. SEE ALSO clear(1), stty(1), tabs(1), terminfo(5), curs_termcap(3X). This describes ncurses version 5.7 (patch 20081102). tput(1)
xxh64sum
Print or check xxHash (32, 64 or 128 bits) checksums. When no FILE, read standard input, except if it´s the console. When FILE is -, read standard input even if it´s the console. xxhsum supports a command line syntax similar but not identical to md5sum(1). Differences are: xxhsum doesn´t have text/binary mode switch (-b, -t); xxhsum always treats files as binary file; xxhsum has a hash bit width switch (-H); As xxHash is a fast non-cryptographic checksum algorithm, xxhsum should not be used for security related purposes. xxhsum -b invokes benchmark mode. See OPTIONS and EXAMPLES for details.
xxhsum - print or check xxHash non-cryptographic checksums
xxhsum [<OPTION>] ... [<FILE>] ... xxhsum -b [<OPTION>] ... xxh32sum is equivalent to xxhsum -H0 xxh64sum is equivalent to xxhsum -H1 xxh128sum is equivalent to xxhsum -H2
-V, --version Displays xxhsum version and exits -HHASHTYPE Hash selection. HASHTYPE means 0=32bits, 1=64bits, 2=128bits. Alternatively, HASHTYPE 32=32bits, 64=64bits, 128=128bits. Default value is 1 (64bits) --tag Output in the BSD style. --little-endian Set output hexadecimal checksum value as little endian convention. By default, value is displayed as big endian. -h, --help Displays help and exits The following four options are useful only when verifying checksums (-c) -c, --check FILE Read xxHash sums from FILE and check them -q, --quiet Don´t print OK for each successfully verified file --strict Return an error code if any line in the file is invalid, not just if some checksums are wrong. This policy is disabled by default, though UI will prompt an informational message if any line in the file is detected invalid. --status Don´t output anything. Status code shows success. -w, --warn Emit a warning message about each improperly formatted checksum line. The following options are useful only benchmark purpose -b Benchmark mode. See EXAMPLES for details. -b# Specify ID of variant to be tested. Multiple variants can be selected, separated by a ´,´ comma. -BBLOCKSIZE Only useful for benchmark mode (-b). See EXAMPLES for details. BLOCKSIZE specifies benchmark mode´s test data block size in bytes. Default value is 102400 -iITERATIONS Only useful for benchmark mode (-b). See EXAMPLES for details. ITERATIONS specifies number of iterations in benchmark. Single iteration lasts approximately 1000 milliseconds. Default value is 3 EXIT STATUS xxhsum exit 0 on success, 1 if at least one file couldn´t be read or doesn´t have the same checksum as the -c option.
Output xxHash (64bit) checksum values of specific files to standard output $ xxhsum -H1 foo bar baz Output xxHash (32bit and 64bit) checksum values of specific files to standard output, and redirect it to xyz.xxh32 and qux.xxh64 $ xxhsum -H0 foo bar baz > xyz.xxh32 $ xxhsum -H1 foo bar baz > qux.xxh64 Read xxHash sums from specific files and check them $ xxhsum -c xyz.xxh32 qux.xxh64 Benchmark xxHash algorithm. By default, xxhsum benchmarks xxHash main variants on a synthetic sample of 100 KB, and print results into standard output. The first column is the algorithm, the second column is the source data size in bytes, the third column is the number of hashes generated per second (throughput), and finally the last column translates speed in megabytes per second. $ xxhsum -b In the following example, the sample to hash is set to 16384 bytes, the variants to be benched are selected by their IDs, and each benchmark test is repeated 10 times, for increased accuracy. $ xxhsum -b1,2,3 -i10 -B16384 BUGS Report bugs at: https://github.com/Cyan4973/xxHash/issues/ AUTHOR Yann Collet SEE ALSO md5sum(1) xxhsum 0.7.4 July 2020 XXHSUM(1)
bzcat
bzip2 compresses files using the Burrows-Wheeler block sorting text compression algorithm, and Huffman coding. Compression is generally considerably better than that achieved by more conventional LZ77/LZ78-based compressors, and approaches the performance of the PPM family of statistical compressors. The command-line options are deliberately very similar to those of GNU gzip, but they are not identical. bzip2 expects a list of file names to accompany the command-line flags. Each file is replaced by a compressed version of itself, with the name "original_name.bz2". Each compressed file has the same modification date, permissions, and, when possible, ownership as the corresponding original, so that these properties can be correctly restored at decompression time. File name handling is naive in the sense that there is no mechanism for preserving original file names, permissions, ownerships or dates in filesystems which lack these concepts, or have serious file name length restrictions, such as MS-DOS. bzip2 and bunzip2 will by default not overwrite existing files. If you want this to happen, specify the -f flag. If no file names are specified, bzip2 compresses from standard input to standard output. In this case, bzip2 will decline to write compressed output to a terminal, as this would be entirely incomprehensible and therefore pointless. bunzip2 (or bzip2 -d) decompresses all specified files. Files which were not created by bzip2 will be detected and ignored, and a warning issued. bzip2 attempts to guess the filename for the decompressed file from that of the compressed file as follows: filename.bz2 becomes filename filename.bz becomes filename filename.tbz2 becomes filename.tar filename.tbz becomes filename.tar anyothername becomes anyothername.out If the file does not end in one of the recognised endings, .bz2, .bz, .tbz2 or .tbz, bzip2 complains that it cannot guess the name of the original file, and uses the original name with .out appended. As with compression, supplying no filenames causes decompression from standard input to standard output. bunzip2 will correctly decompress a file which is the concatenation of two or more compressed files. The result is the concatenation of the corresponding uncompressed files. Integrity testing (-t) of concatenated compressed files is also supported. You can also compress or decompress files to the standard output by giving the -c flag. Multiple files may be compressed and decompressed like this. The resulting outputs are fed sequentially to stdout. Compression of multiple files in this manner generates a stream containing multiple compressed file representations. Such a stream can be decompressed correctly only by bzip2 version 0.9.0 or later. Earlier versions of bzip2 will stop after decompressing the first file in the stream. bzcat (or bzip2 -dc) decompresses all specified files to the standard output. bzip2 will read arguments from the environment variables BZIP2 and BZIP, in that order, and will process them before any arguments read from the command line. This gives a convenient way to supply default arguments. Compression is always performed, even if the compressed file is slightly larger than the original. Files of less than about one hundred bytes tend to get larger, since the compression mechanism has a constant overhead in the region of 50 bytes. Random data (including the output of most file compressors) is coded at about 8.05 bits per byte, giving an expansion of around 0.5%. As a self-check for your protection, bzip2 uses 32-bit CRCs to make sure that the decompressed version of a file is identical to the original. This guards against corruption of the compressed data, and against undetected bugs in bzip2 (hopefully very unlikely). The chances of data corruption going undetected is microscopic, about one chance in four billion for each file processed. Be aware, though, that the check occurs upon decompression, so it can only tell you that something is wrong. It can't help you recover the original uncompressed data. You can use bzip2recover to try to recover data from damaged files. Return values: 0 for a normal exit, 1 for environmental problems (file not found, invalid flags, I/O errors, &c), 2 to indicate a corrupt compressed file, 3 for an internal consistency error (eg, bug) which caused bzip2 to panic.
bzip2, bunzip2 - a block-sorting file compressor, v1.0.8 bzcat - decompresses files to stdout bzip2recover - recovers data from damaged bzip2 files
bzip2 [ -cdfkqstvzVL123456789 ] [ filenames ... ] bunzip2 [ -fkvsVL ] [ filenames ... ] bzcat [ -s ] [ filenames ... ] bzip2recover filename
-c --stdout Compress or decompress to standard output. -d --decompress Force decompression. bzip2, bunzip2 and bzcat are really the same program, and the decision about what actions to take is done on the basis of which name is used. This flag overrides that mechanism, and forces bzip2 to decompress. -z --compress The complement to -d: forces compression, regardless of the invocation name. -t --test Check integrity of the specified file(s), but don't decompress them. This really performs a trial decompression and throws away the result. -f --force Force overwrite of output files. Normally, bzip2 will not overwrite existing output files. Also forces bzip2 to break hard links to files, which it otherwise wouldn't do. bzip2 normally declines to decompress files which don't have the correct magic header bytes. If forced (-f), however, it will pass such files through unmodified. This is how GNU gzip behaves. -k --keep Keep (don't delete) input files during compression or decompression. -s --small Reduce memory usage, for compression, decompression and testing. Files are decompressed and tested using a modified algorithm which only requires 2.5 bytes per block byte. This means any file can be decompressed in 2300k of memory, albeit at about half the normal speed. During compression, -s selects a block size of 200k, which limits memory use to around the same figure, at the expense of your compression ratio. In short, if your machine is low on memory (8 megabytes or less), use -s for everything. See MEMORY MANAGEMENT below. -q --quiet Suppress non-essential warning messages. Messages pertaining to I/O errors and other critical events will not be suppressed. -v --verbose Verbose mode -- show the compression ratio for each file processed. Further -v's increase the verbosity level, spewing out lots of information which is primarily of interest for diagnostic purposes. -L --license -V --version Display the software version, license terms and conditions. -1 (or --fast) to -9 (or --best) Set the block size to 100 k, 200 k .. 900 k when compressing. Has no effect when decompressing. See MEMORY MANAGEMENT below. The --fast and --best aliases are primarily for GNU gzip compatibility. In particular, --fast doesn't make things significantly faster. And --best merely selects the default behaviour. -- Treats all subsequent arguments as file names, even if they start with a dash. This is so you can handle files with names beginning with a dash, for example: bzip2 -- -myfilename. --repetitive-fast --repetitive-best These flags are redundant in versions 0.9.5 and above. They provided some coarse control over the behaviour of the sorting algorithm in earlier versions, which was sometimes useful. 0.9.5 and above have an improved algorithm which renders these flags irrelevant. MEMORY MANAGEMENT bzip2 compresses large files in blocks. The block size affects both the compression ratio achieved, and the amount of memory needed for compression and decompression. The flags -1 through -9 specify the block size to be 100,000 bytes through 900,000 bytes (the default) respectively. At decompression time, the block size used for compression is read from the header of the compressed file, and bunzip2 then allocates itself just enough memory to decompress the file. Since block sizes are stored in compressed files, it follows that the flags -1 to -9 are irrelevant to and so ignored during decompression. Compression and decompression requirements, in bytes, can be estimated as: Compression: 400k + ( 8 x block size ) Decompression: 100k + ( 4 x block size ), or 100k + ( 2.5 x block size ) Larger block sizes give rapidly diminishing marginal returns. Most of the compression comes from the first two or three hundred k of block size, a fact worth bearing in mind when using bzip2 on small machines. It is also important to appreciate that the decompression memory requirement is set at compression time by the choice of block size. For files compressed with the default 900k block size, bunzip2 will require about 3700 kbytes to decompress. To support decompression of any file on a 4 megabyte machine, bunzip2 has an option to decompress using approximately half this amount of memory, about 2300 kbytes. Decompression speed is also halved, so you should use this option only where necessary. The relevant flag is -s. In general, try and use the largest block size memory constraints allow, since that maximises the compression achieved. Compression and decompression speed are virtually unaffected by block size. Another significant point applies to files which fit in a single block -- that means most files you'd encounter using a large block size. The amount of real memory touched is proportional to the size of the file, since the file is smaller than a block. For example, compressing a file 20,000 bytes long with the flag -9 will cause the compressor to allocate around 7600k of memory, but only touch 400k + 20000 * 8 = 560 kbytes of it. Similarly, the decompressor will allocate 3700k but only touch 100k + 20000 * 4 = 180 kbytes. Here is a table which summarises the maximum memory usage for different block sizes. Also recorded is the total compressed size for 14 files of the Calgary Text Compression Corpus totalling 3,141,622 bytes. This column gives some feel for how compression varies with block size. These figures tend to understate the advantage of larger block sizes for larger files, since the Corpus is dominated by smaller files. Compress Decompress Decompress Corpus Flag usage usage -s usage Size -1 1200k 500k 350k 914704 -2 2000k 900k 600k 877703 -3 2800k 1300k 850k 860338 -4 3600k 1700k 1100k 846899 -5 4400k 2100k 1350k 845160 -6 5200k 2500k 1600k 838626 -7 6100k 2900k 1850k 834096 -8 6800k 3300k 2100k 828642 -9 7600k 3700k 2350k 828642 RECOVERING DATA FROM DAMAGED FILES bzip2 compresses files in blocks, usually 900kbytes long. Each block is handled independently. If a media or transmission error causes a multi-block .bz2 file to become damaged, it may be possible to recover data from the undamaged blocks in the file. The compressed representation of each block is delimited by a 48-bit pattern, which makes it possible to find the block boundaries with reasonable certainty. Each block also carries its own 32-bit CRC, so damaged blocks can be distinguished from undamaged ones. bzip2recover is a simple program whose purpose is to search for blocks in .bz2 files, and write each block out into its own .bz2 file. You can then use bzip2 -t to test the integrity of the resulting files, and decompress those which are undamaged. bzip2recover takes a single argument, the name of the damaged file, and writes a number of files "rec00001file.bz2", "rec00002file.bz2", etc, containing the extracted blocks. The output filenames are designed so that the use of wildcards in subsequent processing -- for example, "bzip2 -dc rec*file.bz2 > recovered_data" -- processes the files in the correct order. bzip2recover should be of most use dealing with large .bz2 files, as these will contain many blocks. It is clearly futile to use it on damaged single-block files, since a damaged block cannot be recovered. If you wish to minimise any potential data loss through media or transmission errors, you might consider compressing with a smaller block size. PERFORMANCE NOTES The sorting phase of compression gathers together similar strings in the file. Because of this, files containing very long runs of repeated symbols, like "aabaabaabaab ..." (repeated several hundred times) may compress more slowly than normal. Versions 0.9.5 and above fare much better than previous versions in this respect. The ratio between worst-case and average-case compression time is in the region of 10:1. For previous versions, this figure was more like 100:1. You can use the -vvvv option to monitor progress in great detail, if you want. Decompression speed is unaffected by these phenomena. bzip2 usually allocates several megabytes of memory to operate in, and then charges all over it in a fairly random fashion. This means that performance, both for compressing and decompressing, is largely determined by the speed at which your machine can service cache misses. Because of this, small changes to the code to reduce the miss rate have been observed to give disproportionately large performance improvements. I imagine bzip2 will perform best on machines with very large caches. CAVEATS I/O error messages are not as helpful as they could be. bzip2 tries hard to detect I/O errors and exit cleanly, but the details of what the problem is sometimes seem rather misleading. This manual page pertains to version 1.0.8 of bzip2. Compressed data created by this version is entirely forwards and backwards compatible with the previous public releases, versions 0.1pl2, 0.9.0, 0.9.5, 1.0.0, 1.0.1, 1.0.2 and above, but with the following exception: 0.9.0 and above can correctly decompress multiple concatenated compressed files. 0.1pl2 cannot do this; it will stop after decompressing just the first file in the stream. bzip2recover versions prior to 1.0.2 used 32-bit integers to represent bit positions in compressed files, so they could not handle compressed files more than 512 megabytes long. Versions 1.0.2 and above use 64-bit ints on some platforms which support them (GNU supported targets, and Windows). To establish whether or not bzip2recover was built with such a limitation, run it without arguments. In any event you can build yourself an unlimited version if you can recompile it with MaybeUInt64 set to be an unsigned 64-bit integer. AUTHOR Julian Seward, jseward@acm.org. https://sourceware.org/bzip2/ The ideas embodied in bzip2 are due to (at least) the following people: Michael Burrows and David Wheeler (for the block sorting transformation), David Wheeler (again, for the Huffman coder), Peter Fenwick (for the structured coding model in the original bzip, and many refinements), and Alistair Moffat, Radford Neal and Ian Witten (for the arithmetic coder in the original bzip). I am much indebted for their help, support and advice. See the manual in the source distribution for pointers to sources of documentation. Christian von Roques encouraged me to look for faster sorting algorithms, so as to speed up compression. Bela Lubkin encouraged me to improve the worst-case compression performance. Donna Robinson XMLised the documentation. The bz* scripts are derived from those of GNU gzip. Many people sent patches, helped with portability problems, lent machines, gave advice and were generally helpful. bzip2(1)
null
qmlmin
null
null
null
null
null
xzfgrep
xzgrep invokes grep(1) on uncompressed contents of files. The formats of the files are determined from the filename suffixes. Any file with a suffix supported by xz(1), gzip(1), bzip2(1), lzop(1), zstd(1), or lz4(1) will be decompressed; all other files are assumed to be uncompressed. If no files are specified or file is - then standard input is read. When reading from standard input, only files supported by xz(1) are decompressed. Other files are assumed to be in uncompressed form already. Most options of grep(1) are supported. However, the following options are not supported: -r, --recursive -R, --dereference-recursive -d, --directories=action -Z, --null -z, --null-data --include=glob --exclude=glob --exclude-from=file --exclude-dir=glob xzegrep is an alias for xzgrep -E. xzfgrep is an alias for xzgrep -F. The commands lzgrep, lzegrep, and lzfgrep are provided for backward compatibility with LZMA Utils. EXIT STATUS 0 At least one match was found from at least one of the input files. No errors occurred. 1 No matches were found from any of the input files. No errors occurred. >1 One or more errors occurred. It is unknown if matches were found. ENVIRONMENT GREP If GREP is set to a non-empty value, it is used instead of grep, grep -E, or grep -F. SEE ALSO grep(1), xz(1), gzip(1), bzip2(1), lzop(1), zstd(1), lz4(1), zgrep(1) Tukaani 2024-02-13 XZGREP(1)
xzgrep - search possibly-compressed files for patterns
xzgrep [option...] [pattern_list] [file...] xzegrep ... xzfgrep ... lzgrep ... lzegrep ... lzfgrep ...
null
null
pasteurize
null
null
null
null
null
slencheck
null
null
null
null
null
sphinx-build
null
null
null
null
null
webpinfo
This manual page documents the webpinfo command. webpinfo can be used to print out the chunk level structure and bitstream header information of WebP files. It can also check if the files are of valid WebP format.
webpinfo - print out the chunk level structure of WebP files along with basic integrity checks.
webpinfo OPTIONS INPUT webpinfo [-h|-help|-H|-longhelp]
-version Print the version number (as major.minor.revision) and exit. -quiet Do not show chunk parsing information. -diag Show parsing error diagnosis. -summary Show chunk stats summary. -bitstream_info Parse bitstream header. -h, -help A short usage summary. -H, -longhelp Detailed usage instructions. INPUT Input files in WebP format. Input files must come last, following options (if any). There can be multiple input files. BUGS Please report all bugs to the issue tracker: https://bugs.chromium.org/p/webp Patches welcome! See this page to get started: https://www.webmproject.org/code/contribute/submitting-patches/
webpinfo -h webpinfo -diag -summary input_file.webp webpinfo -bitstream_info input_file_1.webp input_file_2.webp webpinfo *.webp AUTHORS webpinfo is a part of libwebp and was written by the WebP team. The latest source tree is available at https://chromium.googlesource.com/webm/libwebp This manual page was written by Hui Su <huisu@google.com>, for the Debian project (and may be used by others). SEE ALSO webpmux(1) Please refer to https://developers.google.com/speed/webp/ for additional information. November 17, 2021 WEBPINFO(1)
.python.app-post-link.sh
null
null
null
null
null
icuinfo
null
null
null
null
null
h5jam
null
null
null
null
null
libpng-config
null
null
null
null
null
conch
null
null
null
null
null
qta-browser
null
null
null
null
null
isympy
isympy is a Python shell for SymPy. It is just a normal python shell (ipython shell if you have the ipython package installed) that executes the following commands so that you don't have to: >>> from __future__ import division >>> from sympy import * >>> x, y, z = symbols("x,y,z") >>> k, m, n = symbols("k,m,n", integer=True) So starting isympy is equivalent to starting python (or ipython) and executing the above commands by hand. It is intended for easy and quick experimentation with SymPy. For more complicated programs, it is recommended to write a script and import things explicitly (using the "from sympy import sin, log, Symbol, ..." idiom).
isympy - interactive shell for SymPy
isympy [-c | --console] [-p ENCODING | --pretty ENCODING] [-t TYPE | --types TYPE] [-o ORDER | --order ORDER] [-q | --quiet] [-d | --doctest] [-C | --no-cache] [-a | --auto] [-D | --debug] [ -- | PYTHONOPTIONS] isympy [ {-h | --help} | {-v | --version} ]
-c SHELL, --console=SHELL Use the specified shell (python or ipython) as console backend instead of the default one (ipython if present or python otherwise). Example: isympy -c python SHELL could be either 'ipython' or 'python' -p ENCODING, --pretty=ENCODING Setup pretty printing in SymPy. By default, the most pretty, unicode printing is enabled (if the terminal supports it). You can use less pretty ASCII printing instead or no pretty printing at all. Example: isympy -p no ENCODING must be one of 'unicode', 'ascii' or 'no'. -t TYPE, --types=TYPE Setup the ground types for the polys. By default, gmpy ground types are used if gmpy2 or gmpy is installed, otherwise it falls back to python ground types, which are a little bit slower. You can manually choose python ground types even if gmpy is installed (e.g., for testing purposes). Note that sympy ground types are not supported, and should be used only for experimental purposes. Note that the gmpy1 ground type is primarily intended for testing; it the use of gmpy even if gmpy2 is available. This is the same as setting the environment variable SYMPY_GROUND_TYPES to the given ground type (e.g., SYMPY_GROUND_TYPES='gmpy') The ground types can be determined interactively from the variable sympy.polys.domains.GROUND_TYPES inside the isympy shell itself. Example: isympy -t python TYPE must be one of 'gmpy', 'gmpy1' or 'python'. -o ORDER, --order=ORDER Setup the ordering of terms for printing. The default is lex, which orders terms lexicographically (e.g., x**2 + x + 1). You can choose other orderings, such as rev-lex, which will use reverse lexicographic ordering (e.g., 1 + x + x**2). Note that for very large expressions, ORDER='none' may speed up printing considerably, with the tradeoff that the order of the terms in the printed expression will have no canonical order Example: isympy -o rev-lax ORDER must be one of 'lex', 'rev-lex', 'grlex', 'rev-grlex', 'grevlex', 'rev-grevlex', 'old', or 'none'. -q, --quiet Print only Python's and SymPy's versions to stdout at startup, and nothing else. -d, --doctest Use the same format that should be used for doctests. This is equivalent to 'isympy -c python -p no'. -C, --no-cache Disable the caching mechanism. Disabling the cache may slow certain operations down considerably. This is useful for testing the cache, or for benchmarking, as the cache can result in deceptive benchmark timings. This is the same as setting the environment variable SYMPY_USE_CACHE to 'no'. -a, --auto Automatically create missing symbols. Normally, typing a name of a Symbol that has not been instantiated first would raise NameError, but with this option enabled, any undefined name will be automatically created as a Symbol. This only works in IPython 0.11. Note that this is intended only for interactive, calculator style usage. In a script that uses SymPy, Symbols should be instantiated at the top, so that it's clear what they are. This will not override any names that are already defined, which includes the single character letters represented by the mnemonic QCOSINE (see the "Gotchas and Pitfalls" document in the documentation). You can delete existing names by executing "del name" in the shell itself. You can see if a name is defined by typing "'name' in globals()". The Symbols that are created using this have default assumptions. If you want to place assumptions on symbols, you should create them using symbols() or var(). Finally, this only works in the top level namespace. So, for example, if you define a function in isympy with an undefined Symbol, it will not work. -D, --debug Enable debugging output. This is the same as setting the environment variable SYMPY_DEBUG to 'True'. The debug status is set in the variable SYMPY_DEBUG within isympy. -- PYTHONOPTIONS These options will be passed on to ipython (1) shell. Only supported when ipython is being used (standard python shell not supported). Two dashes (--) are required to separate PYTHONOPTIONS from the other isympy options. For example, to run iSymPy without startup banner and colors: isympy -q -c ipython -- --colors=NoColor -h, --help Print help output and exit. -v, --version Print isympy version information and exit. FILES ${HOME}/.sympy-history Saves the history of commands when using the python shell as backend. BUGS The upstreams BTS can be found at ⟨https://github.com/sympy/sympy/issues⟩ Please report all bugs that you find in there, this will help improve the overall quality of SymPy. SEE ALSO ipython(1), python(1) 2007-10-8 isympy(1)
null
qmlimportscanner
null
null
null
null
null
gobject-query
null
null
null
null
null
mysqlcheck
The mysqlcheck client performs table maintenance: It checks, repairs, optimizes, or analyzes tables. Each table is locked and therefore unavailable to other sessions while it is being processed, although for check operations, the table is locked with a READ lock only (see Section 13.3.6, “LOCK TABLES and UNLOCK TABLES Statements”, for more information about READ and WRITE locks). Table maintenance operations can be time-consuming, particularly for large tables. If you use the --databases or --all-databases option to process all tables in one or more databases, an invocation of mysqlcheck might take a long time. (This is also true for the MySQL upgrade procedure if it determines that table checking is needed because it processes tables the same way.) mysqlcheck must be used when the mysqld server is running, which means that you do not have to stop the server to perform table maintenance. mysqlcheck uses the SQL statements CHECK TABLE, REPAIR TABLE, ANALYZE TABLE, and OPTIMIZE TABLE in a convenient way for the user. It determines which statements to use for the operation you want to perform, and then sends the statements to the server to be executed. For details about which storage engines each statement works with, see the descriptions for those statements in Section 13.7.3, “Table Maintenance Statements”. All storage engines do not necessarily support all four maintenance operations. In such cases, an error message is displayed. For example, if test.t is an MEMORY table, an attempt to check it produces this result: $> mysqlcheck test t test.t note : The storage engine for the table doesn't support check If mysqlcheck is unable to repair a table, see Section 2.10.13, “Rebuilding or Repairing Tables or Indexes” for manual table repair strategies. This is the case, for example, for InnoDB tables, which can be checked with CHECK TABLE, but not repaired with REPAIR TABLE. Caution It is best to make a backup of a table before performing a table repair operation; under some circumstances the operation might cause data loss. Possible causes include but are not limited to file system errors. There are three general ways to invoke mysqlcheck: mysqlcheck [options] db_name [tbl_name ...] mysqlcheck [options] --databases db_name ... mysqlcheck [options] --all-databases If you do not name any tables following db_name or if you use the --databases or --all-databases option, entire databases are checked. mysqlcheck has a special feature compared to other client programs. The default behavior of checking tables (--check) can be changed by renaming the binary. If you want to have a tool that repairs tables by default, you should just make a copy of mysqlcheck named mysqlrepair, or make a symbolic link to mysqlcheck named mysqlrepair. If you invoke mysqlrepair, it repairs tables. The names shown in the following table can be used to change mysqlcheck default behavior. ┌──────────────┬───────────────────────┐ │Command │ Meaning │ ├──────────────┼───────────────────────┤ │mysqlrepair │ The default option is │ │ │ --repair │ ├──────────────┼───────────────────────┤ │mysqlanalyze │ The default option is │ │ │ --analyze │ ├──────────────┼───────────────────────┤ │mysqloptimize │ The default option is │ │ │ --optimize │ └──────────────┴───────────────────────┘ mysqlcheck supports the following options, which can be specified on the command line or in the [mysqlcheck] and [client] groups of an option file. For information about option files used by MySQL programs, see Section 4.2.2.2, “Using Option Files”. • --help, -? ┌────────────────────┬────────┐ │Command-Line Format │ --help │ └────────────────────┴────────┘ Display a help message and exit. • --all-databases, -A ┌────────────────────┬─────────────────┐ │Command-Line Format │ --all-databases │ └────────────────────┴─────────────────┘ Check all tables in all databases. This is the same as using the --databases option and naming all the databases on the command line, except that the INFORMATION_SCHEMA and performance_schema databases are not checked. They can be checked by explicitly naming them with the --databases option. • --all-in-1, -1 ┌────────────────────┬────────────┐ │Command-Line Format │ --all-in-1 │ └────────────────────┴────────────┘ Instead of issuing a statement for each table, execute a single statement for each database that names all the tables from that database to be processed. • --analyze, -a ┌────────────────────┬───────────┐ │Command-Line Format │ --analyze │ └────────────────────┴───────────┘ Analyze the tables. • --auto-repair ┌────────────────────┬───────────────┐ │Command-Line Format │ --auto-repair │ └────────────────────┴───────────────┘ If a checked table is corrupted, automatically fix it. Any necessary repairs are done after all tables have been checked. • --bind-address=ip_address ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --bind-address=ip_address │ └────────────────────┴───────────────────────────┘ On a computer having multiple network interfaces, use this option to select which interface to use for connecting to the MySQL server. • --character-sets-dir=dir_name ┌────────────────────┬───────────────────────────────┐ │Command-Line Format │ --character-sets-dir=dir_name │ ├────────────────────┼───────────────────────────────┤ │Type │ Directory name │ └────────────────────┴───────────────────────────────┘ The directory where character sets are installed. See Section 10.15, “Character Set Configuration”. • --check, -c ┌────────────────────┬─────────┐ │Command-Line Format │ --check │ └────────────────────┴─────────┘ Check the tables for errors. This is the default operation. • --check-only-changed, -C ┌────────────────────┬──────────────────────┐ │Command-Line Format │ --check-only-changed │ └────────────────────┴──────────────────────┘ Check only tables that have changed since the last check or that have not been closed properly. • --check-upgrade, -g ┌────────────────────┬─────────────────┐ │Command-Line Format │ --check-upgrade │ └────────────────────┴─────────────────┘ Invoke CHECK TABLE with the FOR UPGRADE option to check tables for incompatibilities with the current version of the server. • --compress ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --compress[={OFF|ON}] │ ├────────────────────┼───────────────────────┤ │Deprecated │ Yes │ ├────────────────────┼───────────────────────┤ │Type │ Boolean │ ├────────────────────┼───────────────────────┤ │Default Value │ OFF │ └────────────────────┴───────────────────────┘ Compress all information sent between the client and the server if possible. See Section 4.2.8, “Connection Compression Control”. This option is deprecated. Expect it to be removed in a future version of MySQL. See the section called “Configuring Legacy Connection Compression”. • --compression-algorithms=value ┌────────────────────┬────────────────────────────────┐ │Command-Line Format │ --compression-algorithms=value │ ├────────────────────┼────────────────────────────────┤ │Type │ Set │ ├────────────────────┼────────────────────────────────┤ │Default Value │ uncompressed │ ├────────────────────┼────────────────────────────────┤ │Valid Values │ zlib zstd uncompressed │ └────────────────────┴────────────────────────────────┘ The permitted compression algorithms for connections to the server. The available algorithms are the same as for the protocol_compression_algorithms system variable. The default value is uncompressed. For more information, see Section 4.2.8, “Connection Compression Control”. • --databases, -B ┌────────────────────┬─────────────┐ │Command-Line Format │ --databases │ └────────────────────┴─────────────┘ Process all tables in the named databases. Normally, mysqlcheck treats the first name argument on the command line as a database name and any following names as table names. With this option, it treats all name arguments as database names. • --debug[=debug_options], -# [debug_options] ┌────────────────────┬─────────────────────────┐ │Command-Line Format │ --debug[=debug_options] │ ├────────────────────┼─────────────────────────┤ │Type │ String │ ├────────────────────┼─────────────────────────┤ │Default Value │ d:t:o │ └────────────────────┴─────────────────────────┘ Write a debugging log. A typical debug_options string is d:t:o,file_name. The default is d:t:o. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. • --debug-check ┌────────────────────┬───────────────┐ │Command-Line Format │ --debug-check │ ├────────────────────┼───────────────┤ │Type │ Boolean │ ├────────────────────┼───────────────┤ │Default Value │ FALSE │ └────────────────────┴───────────────┘ Print some debugging information when the program exits. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. • --debug-info ┌────────────────────┬──────────────┐ │Command-Line Format │ --debug-info │ ├────────────────────┼──────────────┤ │Type │ Boolean │ ├────────────────────┼──────────────┤ │Default Value │ FALSE │ └────────────────────┴──────────────┘ Print debugging information and memory and CPU usage statistics when the program exits. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. • --default-character-set=charset_name ┌────────────────────┬──────────────────────────────────────┐ │Command-Line Format │ --default-character-set=charset_name │ ├────────────────────┼──────────────────────────────────────┤ │Type │ String │ └────────────────────┴──────────────────────────────────────┘ Use charset_name as the default character set. See Section 10.15, “Character Set Configuration”. • --defaults-extra-file=file_name ┌────────────────────┬─────────────────────────────────┐ │Command-Line Format │ --defaults-extra-file=file_name │ ├────────────────────┼─────────────────────────────────┤ │Type │ File name │ └────────────────────┴─────────────────────────────────┘ Read this option file after the global option file but (on Unix) before the user option file. If the file does not exist or is otherwise inaccessible, an error occurs. If file_name is not an absolute path name, it is interpreted relative to the current directory. For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --defaults-file=file_name ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --defaults-file=file_name │ ├────────────────────┼───────────────────────────┤ │Type │ File name │ └────────────────────┴───────────────────────────┘ Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs. If file_name is not an absolute path name, it is interpreted relative to the current directory. Exception: Even with --defaults-file, client programs read .mylogin.cnf. For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --defaults-group-suffix=str ┌────────────────────┬─────────────────────────────┐ │Command-Line Format │ --defaults-group-suffix=str │ ├────────────────────┼─────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────┘ Read not only the usual option groups, but also groups with the usual names and a suffix of str. For example, mysqlcheck normally reads the [client] and [mysqlcheck] groups. If this option is given as --defaults-group-suffix=_other, mysqlcheck also reads the [client_other] and [mysqlcheck_other] groups. For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --extended, -e ┌────────────────────┬────────────┐ │Command-Line Format │ --extended │ └────────────────────┴────────────┘ If you are using this option to check tables, it ensures that they are 100% consistent but takes a long time. If you are using this option to repair tables, it runs an extended repair that may not only take a long time to execute, but may produce a lot of garbage rows also! • --default-auth=plugin ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --default-auth=plugin │ ├────────────────────┼───────────────────────┤ │Type │ String │ └────────────────────┴───────────────────────┘ A hint about which client-side authentication plugin to use. See Section 6.2.17, “Pluggable Authentication”. • --enable-cleartext-plugin ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --enable-cleartext-plugin │ ├────────────────────┼───────────────────────────┤ │Type │ Boolean │ ├────────────────────┼───────────────────────────┤ │Default Value │ FALSE │ └────────────────────┴───────────────────────────┘ Enable the mysql_clear_password cleartext authentication plugin. (See Section 6.4.1.4, “Client-Side Cleartext Pluggable Authentication”.) • --fast, -F ┌────────────────────┬────────┐ │Command-Line Format │ --fast │ └────────────────────┴────────┘ Check only tables that have not been closed properly. • --force, -f ┌────────────────────┬─────────┐ │Command-Line Format │ --force │ └────────────────────┴─────────┘ Continue even if an SQL error occurs. • --get-server-public-key ┌────────────────────┬─────────────────────────┐ │Command-Line Format │ --get-server-public-key │ ├────────────────────┼─────────────────────────┤ │Type │ Boolean │ └────────────────────┴─────────────────────────┘ Request from the server the public key required for RSA key pair-based password exchange. This option applies to clients that authenticate with the caching_sha2_password authentication plugin. For that plugin, the server does not send the public key unless requested. This option is ignored for accounts that do not authenticate with that plugin. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection. If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over --get-server-public-key. For information about the caching_sha2_password plugin, see Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”. • --host=host_name, -h host_name ┌────────────────────┬──────────────────┐ │Command-Line Format │ --host=host_name │ ├────────────────────┼──────────────────┤ │Type │ String │ ├────────────────────┼──────────────────┤ │Default Value │ localhost │ └────────────────────┴──────────────────┘ Connect to the MySQL server on the given host. • --login-path=name ┌────────────────────┬───────────────────┐ │Command-Line Format │ --login-path=name │ ├────────────────────┼───────────────────┤ │Type │ String │ └────────────────────┴───────────────────┘ Read options from the named login path in the .mylogin.cnf login path file. A “login path” is an option group containing options that specify which MySQL server to connect to and which account to authenticate as. To create or modify a login path file, use the mysql_config_editor utility. See mysql_config_editor(1). For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --no-login-paths ┌────────────────────┬──────────────────┐ │Command-Line Format │ --no-login-paths │ └────────────────────┴──────────────────┘ Skips reading options from the login path file. See --login-path for related information. For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --medium-check, -m ┌────────────────────┬────────────────┐ │Command-Line Format │ --medium-check │ └────────────────────┴────────────────┘ Do a check that is faster than an --extended operation. This finds only 99.99% of all errors, which should be good enough in most cases. • --no-defaults ┌────────────────────┬───────────────┐ │Command-Line Format │ --no-defaults │ └────────────────────┴───────────────┘ Do not read any option files. If program startup fails due to reading unknown options from an option file, --no-defaults can be used to prevent them from being read. The exception is that the .mylogin.cnf file is read in all cases, if it exists. This permits passwords to be specified in a safer way than on the command line even when --no-defaults is used. To create .mylogin.cnf, use the mysql_config_editor utility. See mysql_config_editor(1). For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --optimize, -o ┌────────────────────┬────────────┐ │Command-Line Format │ --optimize │ └────────────────────┴────────────┘ Optimize the tables. • --password[=password], -p[password] ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --password[=password] │ ├────────────────────┼───────────────────────┤ │Type │ String │ └────────────────────┴───────────────────────┘ The password of the MySQL account used for connecting to the server. The password value is optional. If not given, mysqlcheck prompts for one. If given, there must be no space between --password= or -p and the password following it. If no password option is specified, the default is to send no password. Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 6.1.2.1, “End-User Guidelines for Password Security”. To explicitly specify that there is no password and that mysqlcheck should not prompt for one, use the --skip-password option. • --password1[=pass_val] The password for multifactor authentication factor 1 of the MySQL account used for connecting to the server. The password value is optional. If not given, mysqlcheck prompts for one. If given, there must be no space between --password1= and the password following it. If no password option is specified, the default is to send no password. Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 6.1.2.1, “End-User Guidelines for Password Security”. To explicitly specify that there is no password and that mysqlcheck should not prompt for one, use the --skip-password1 option. --password1 and --password are synonymous, as are --skip-password1 and --skip-password. • --password2[=pass_val] The password for multifactor authentication factor 2 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for --password1; see the description of that option for details. • --password3[=pass_val] The password for multifactor authentication factor 3 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for --password1; see the description of that option for details. • --pipe, -W ┌────────────────────┬────────┐ │Command-Line Format │ --pipe │ ├────────────────────┼────────┤ │Type │ String │ └────────────────────┴────────┘ On Windows, connect to the server using a named pipe. This option applies only if the server was started with the named_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by the named_pipe_full_access_group system variable. • --plugin-dir=dir_name ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --plugin-dir=dir_name │ ├────────────────────┼───────────────────────┤ │Type │ Directory name │ └────────────────────┴───────────────────────┘ The directory in which to look for plugins. Specify this option if the --default-auth option is used to specify an authentication plugin but mysqlcheck does not find it. See Section 6.2.17, “Pluggable Authentication”. • --port=port_num, -P port_num ┌────────────────────┬─────────────────┐ │Command-Line Format │ --port=port_num │ ├────────────────────┼─────────────────┤ │Type │ Numeric │ ├────────────────────┼─────────────────┤ │Default Value │ 3306 │ └────────────────────┴─────────────────┘ For TCP/IP connections, the port number to use. • --print-defaults ┌────────────────────┬──────────────────┐ │Command-Line Format │ --print-defaults │ └────────────────────┴──────────────────┘ Print the program name and all options that it gets from option files. For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --protocol={TCP|SOCKET|PIPE|MEMORY} ┌────────────────────┬────────────────────────┐ │Command-Line Format │ --protocol=type │ ├────────────────────┼────────────────────────┤ │Type │ String │ ├────────────────────┼────────────────────────┤ │Default Value │ [see text] │ ├────────────────────┼────────────────────────┤ │Valid Values │ TCP SOCKET PIPE │ │ │ MEMORY │ └────────────────────┴────────────────────────┘ The transport protocol to use for connecting to the server. It is useful when the other connection parameters normally result in use of a protocol other than the one you want. For details on the permissible values, see Section 4.2.7, “Connection Transport Protocols”. • --quick, -q ┌────────────────────┬─────────┐ │Command-Line Format │ --quick │ └────────────────────┴─────────┘ If you are using this option to check tables, it prevents the check from scanning the rows to check for incorrect links. This is the fastest check method. If you are using this option to repair tables, it tries to repair only the index tree. This is the fastest repair method. • --repair, -r ┌────────────────────┬──────────┐ │Command-Line Format │ --repair │ └────────────────────┴──────────┘ Perform a repair that can fix almost anything except unique keys that are not unique. • --server-public-key-path=file_name ┌────────────────────┬────────────────────────────────────┐ │Command-Line Format │ --server-public-key-path=file_name │ ├────────────────────┼────────────────────────────────────┤ │Type │ File name │ └────────────────────┴────────────────────────────────────┘ The path name to a file in PEM format containing a client-side copy of the public key required by the server for RSA key pair-based password exchange. This option applies to clients that authenticate with the sha256_password or caching_sha2_password authentication plugin. This option is ignored for accounts that do not authenticate with one of those plugins. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection. If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over --get-server-public-key. For sha256_password, this option applies only if MySQL was built using OpenSSL. For information about the sha256_password and caching_sha2_password plugins, see Section 6.4.1.3, “SHA-256 Pluggable Authentication”, and Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”. • --shared-memory-base-name=name ┌────────────────────┬────────────────────────────────┐ │Command-Line Format │ --shared-memory-base-name=name │ ├────────────────────┼────────────────────────────────┤ │Platform Specific │ Windows │ └────────────────────┴────────────────────────────────┘ On Windows, the shared-memory name to use for connections made using shared memory to a local server. The default value is MYSQL. The shared-memory name is case-sensitive. This option applies only if the server was started with the shared_memory system variable enabled to support shared-memory connections. • --silent, -s ┌────────────────────┬──────────┐ │Command-Line Format │ --silent │ └────────────────────┴──────────┘ Silent mode. Print only error messages. • --skip-database=db_name ┌────────────────────┬─────────────────────────┐ │Command-Line Format │ --skip-database=db_name │ └────────────────────┴─────────────────────────┘ Do not include the named database (case-sensitive) in the operations performed by mysqlcheck. • --socket=path, -S path ┌────────────────────┬────────────────────────────────┐ │Command-Line Format │ --socket={file_name|pipe_name} │ ├────────────────────┼────────────────────────────────┤ │Type │ String │ └────────────────────┴────────────────────────────────┘ For connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use. On Windows, this option applies only if the server was started with the named_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by the named_pipe_full_access_group system variable. • --ssl* Options that begin with --ssl specify whether to connect to the server using encryption and indicate where to find SSL keys and certificates. See the section called “Command Options for Encrypted Connections”. • --ssl-fips-mode={OFF|ON|STRICT} ┌────────────────────┬─────────────────────────────────┐ │Command-Line Format │ --ssl-fips-mode={OFF|ON|STRICT} │ ├────────────────────┼─────────────────────────────────┤ │Deprecated │ Yes │ ├────────────────────┼─────────────────────────────────┤ │Type │ Enumeration │ ├────────────────────┼─────────────────────────────────┤ │Default Value │ OFF │ ├────────────────────┼─────────────────────────────────┤ │Valid Values │ OFF ON STRICT │ └────────────────────┴─────────────────────────────────┘ Controls whether to enable FIPS mode on the client side. The --ssl-fips-mode option differs from other --ssl-xxx options in that it is not used to establish encrypted connections, but rather to affect which cryptographic operations to permit. See Section 6.8, “FIPS Support”. These --ssl-fips-mode values are permitted: • OFF: Disable FIPS mode. • ON: Enable FIPS mode. • STRICT: Enable “strict” FIPS mode. Note If the OpenSSL FIPS Object Module is not available, the only permitted value for --ssl-fips-mode is OFF. In this case, setting --ssl-fips-mode to ON or STRICT causes the client to produce a warning at startup and to operate in non-FIPS mode. This option is deprecated. Expect it to be removed in a future version of MySQL. • --tables ┌────────────────────┬──────────┐ │Command-Line Format │ --tables │ └────────────────────┴──────────┘ Override the --databases or -B option. All name arguments following the option are regarded as table names. • --tls-ciphersuites=ciphersuite_list ┌────────────────────┬─────────────────────────────────────┐ │Command-Line Format │ --tls-ciphersuites=ciphersuite_list │ ├────────────────────┼─────────────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────────────┘ The permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a list of one or more colon-separated ciphersuite names. The ciphersuites that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, “Encrypted Connection TLS Protocols and Ciphers”. • --tls-sni-servername=server_name ┌────────────────────┬──────────────────────────────────┐ │Command-Line Format │ --tls-sni-servername=server_name │ ├────────────────────┼──────────────────────────────────┤ │Type │ String │ └────────────────────┴──────────────────────────────────┘ When specified, the name is passed to the libmysqlclient C API library using the MYSQL_OPT_TLS_SNI_SERVERNAME option of mysql_options(). The server name is not case-sensitive. To show which server name the client specified for the current session, if any, check the Tls_sni_server_name status variable. Server Name Indication (SNI) is an extension to the TLS protocol (OpenSSL must be compiled using TLS extensions for this option to function). The MySQL implementation of SNI represents the client-side only. • --tls-version=protocol_list ┌────────────────────┬───────────────────────────────┐ │Command-Line Format │ --tls-version=protocol_list │ ├────────────────────┼───────────────────────────────┤ │Type │ String │ ├────────────────────┼───────────────────────────────┤ │Default Value │ TLSv1,TLSv1.1,TLSv1.2,TLSv1.3 │ │ │ (OpenSSL 1.1.1 or higher) │ │ │ TLSv1,TLSv1.1,TLSv1.2 │ │ │ (otherwise) │ └────────────────────┴───────────────────────────────┘ The permissible TLS protocols for encrypted connections. The value is a list of one or more comma-separated protocol names. The protocols that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, “Encrypted Connection TLS Protocols and Ciphers”. • --use-frm ┌────────────────────┬───────────┐ │Command-Line Format │ --use-frm │ └────────────────────┴───────────┘ For repair operations on MyISAM tables, get the table structure from the data dictionary so that the table can be repaired even if the .MYI header is corrupted. • --user=user_name, -u user_name ┌────────────────────┬───────────────────┐ │Command-Line Format │ --user=user_name, │ ├────────────────────┼───────────────────┤ │Type │ String │ └────────────────────┴───────────────────┘ The user name of the MySQL account to use for connecting to the server. • --verbose, -v ┌────────────────────┬───────────┐ │Command-Line Format │ --verbose │ └────────────────────┴───────────┘ Verbose mode. Print information about the various stages of program operation. • --version, -V ┌────────────────────┬───────────┐ │Command-Line Format │ --version │ └────────────────────┴───────────┘ Display version information and exit. • --write-binlog ┌────────────────────┬────────────────┐ │Command-Line Format │ --write-binlog │ └────────────────────┴────────────────┘ This option is enabled by default, so that ANALYZE TABLE, OPTIMIZE TABLE, and REPAIR TABLE statements generated by mysqlcheck are written to the binary log. Use --skip-write-binlog to cause NO_WRITE_TO_BINLOG to be added to the statements so that they are not logged. Use the --skip-write-binlog when these statements should not be sent to replicas or run when using the binary logs for recovery from backup. • --zstd-compression-level=level ┌────────────────────┬────────────────────────────┐ │Command-Line Format │ --zstd-compression-level=# │ ├────────────────────┼────────────────────────────┤ │Type │ Integer │ └────────────────────┴────────────────────────────┘ The compression level to use for connections to the server that use the zstd compression algorithm. The permitted levels are from 1 to 22, with larger values indicating increasing levels of compression. The default zstd compression level is 3. The compression level setting has no effect on connections that do not use zstd compression. For more information, see Section 4.2.8, “Connection Compression Control”. COPYRIGHT Copyright © 1997, 2023, Oracle and/or its affiliates. This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/. SEE ALSO For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/. AUTHOR Oracle Corporation (http://dev.mysql.com/). MySQL 8.3 11/23/2023 MYSQLCHECK(1)
mysqlcheck - a table maintenance program
mysqlcheck [options] [db_name [tbl_name ...]]
null
null
gflags_completions.sh
null
null
null
null
null
send2trash
null
null
null
null
null
h5cc
null
null
null
null
null
pagestuff
pagestuff shows how a structure of a Mach-O or universal file corresponds to logical pages on the current system. Structural information includes the location and extent of file headers, sections and segments, symbol tables, code signatures, etc. When displaying a universal file, all architectures will be shown unless otherwise specified by the -arch flag. The options to pagestuff(1) are: -arch arch_type Specifies the architecture, arch_type, of the file for pagestuff to operate on when the file is a universal file. (See arch(3) for the currently known arch_types.) When this option is used the logical page numbers start from the beginning of the architecture file within the universal file. -pagesize pagesize Specifies the page size to use when computing logical page boundaries. By default pagestuff will use the page size of the current system. -a Display all pages in the file. -p Print a list of the sections of the specified file, offsets and lengths. When displaying a universal file, all archs will be displayed unless Print a list of the sections of the specified Mach-O file, with offsets and lengths. Note that the size(1) tool displays a much more concise listing given the `-l -m -x' arguments. SEE ALSO size(1), arch(3), Mach-O(5). Apple, Inc. June 23, 2020 PAGESTUFF(1)
pagestuff - Mach-O file page analysis tool
pagestuff file [-arch arch_flag] [[-a] [-p] | [pagenumber...]]
null
null
dbrunsli
null
null
null
null
null
JxrEncApp
null
null
null
null
null
torchrun
null
null
null
null
null
tldextract
null
null
null
null
null
conda-index
null
null
null
null
null
lz4
lz4 is an extremely fast lossless compression algorithm, based on byte-aligned LZ77 family of compression scheme. lz4 offers compression speeds > 500 MB/s per core, linearly scalable with multi-core CPUs. It features an extremely fast decoder, offering speed in multiple GB/s per core, typically reaching RAM speed limit on multi-core systems. The native file format is the .lz4 format. Difference between lz4 and gzip lz4 supports a command line syntax similar but not identical to gzip(1). Differences are : • lz4 compresses a single file by default (see -m for multiple files) • lz4 file1 file2 means : compress file1 into file2 • lz4 file.lz4 will default to decompression (use -z to force compression) • lz4 preserves original files (see --rm to erase source file on completion) • lz4 shows real-time notification statistics during compression or decompression of a single file (use -q to silence them) • When no destination is specified, result is sent on implicit output, which depends on stdout status. When stdout is Not the console, it becomes the implicit output. Otherwise, if stdout is the console, the implicit output is filename.lz4. • It is considered bad practice to rely on implicit output in scripts. because the script´s environment may change. Always use explicit output in scripts. -c ensures that output will be stdout. Conversely, providing a destination name, or using -m ensures that the output will be either the specified name, or filename.lz4 respectively. Default behaviors can be modified by opt-in commands, detailed below. • lz4 -m makes it possible to provide multiple input filenames, which will be compressed into files using suffix .lz4. Progress notifications become disabled by default (use -v to enable them). This mode has a behavior which more closely mimics gzip command line, with the main remaining difference being that source files are preserved by default. • Similarly, lz4 -m -d can decompress multiple *.lz4 files. • It´s possible to opt-in to erase source files on successful compression or decompression, using --rm command. • Consequently, lz4 -m --rm behaves the same as gzip. Concatenation of .lz4 files It is possible to concatenate .lz4 files as is. lz4 will decompress such files as if they were a single .lz4 file. For example: lz4 file1 > foo.lz4 lz4 file2 >> foo.lz4 Then lz4cat foo.lz4 is equivalent to cat file1 file2.
lz4 - lz4, unlz4, lz4cat - Compress or decompress .lz4 files
lz4 [OPTIONS] [-|INPUT-FILE] OUTPUT-FILE unlz4 is equivalent to lz4 -d lz4cat is equivalent to lz4 -dcfm When writing scripts that need to decompress files, it is recommended to always use the name lz4 with appropriate arguments (lz4 -d or lz4 -dc) instead of the names unlz4 and lz4cat.
Short commands concatenation In some cases, some options can be expressed using short command -x or long command --long-word. Short commands can be concatenated together. For example, -d -c is equivalent to -dc. Long commands cannot be concatenated. They must be clearly separated by a space. Multiple commands When multiple contradictory commands are issued on a same command line, only the latest one will be applied. Operation mode -z --compress Compress. This is the default operation mode when no operation mode option is specified, no other operation mode is implied from the command name (for example, unlz4 implies --decompress), nor from the input file name (for example, a file extension .lz4 implies --decompress by default). -z can also be used to force compression of an already compressed .lz4 file. -d --decompress --uncompress Decompress. --decompress is also the default operation when the input filename has an .lz4 extension. -t --test Test the integrity of compressed .lz4 files. The decompressed data is discarded. No files are created nor removed. -b# Benchmark mode, using # compression level. --list List information about .lz4 files. note : current implementation is limited to single-frame .lz4 files. Operation modifiers -# Compression level, with # being any value from 1 to 12. Higher values trade compression speed for compression ratio. Values above 12 are considered the same as 12. Recommended values are 1 for fast compression (default), and 9 for high compression. Speed/compression trade-off will vary depending on data to compress. Decompression speed remains fast at all settings. --fast[=#] Switch to ultra-fast compression levels. The higher the value, the faster the compression speed, at the cost of some compression ratio. If =# is not present, it defaults to 1. This setting overrides compression level if one was set previously. Similarly, if a compression level is set after --fast, it overrides it. --best Set highest compression level. Same as -12. --favor-decSpeed Generate compressed data optimized for decompression speed. Compressed data will be larger as a consequence (typically by ~0.5%), while decompression speed will be improved by 5-20%, depending on use cases. This option only works in combination with very high compression levels (>=10). -D dictionaryName Compress, decompress or benchmark using dictionary dictionaryName. Compression and decompression must use the same dictionary to be compatible. Using a different dictionary during decompression will either abort due to decompression error, or generate a checksum error. -f --[no-]force This option has several effects: If the target file already exists, overwrite it without prompting. When used with --decompress and lz4 cannot recognize the type of the source file, copy the source file as is to standard output. This allows lz4cat --force to be used like cat (1) for files that have not been compressed with lz4. -c --stdout --to-stdout Force write to standard output, even if it is the console. -m --multiple Multiple input files. Compressed file names will be appended a .lz4 suffix. This mode also reduces notification level. Can also be used to list multiple files. lz4 -m has a behavior equivalent to gzip -k (it preserves source files by default). -r operate recursively on directories. This mode also sets -m (multiple input files). -B# Block size [4-7](default : 7) -B4= 64KB ; -B5= 256KB ; -B6= 1MB ; -B7= 4MB -BI Produce independent blocks (default) -BD Blocks depend on predecessors (improves compression ratio, more noticeable on small blocks) -BX Generate block checksums (default:disabled) --[no-]frame-crc Select frame checksum (default:enabled) --no-crc Disable both frame and block checksums --[no-]content-size Header includes original size (default:not present) Note : this option can only be activated when the original size can be determined, hence for a file. It won´t work with unknown source size, such as stdin or pipe. --[no-]sparse Sparse mode support (default:enabled on file, disabled on stdout) -l Use Legacy format (typically for Linux Kernel compression) Note : -l is not compatible with -m (--multiple) nor -r Other options -v --verbose Verbose mode -q --quiet Suppress warnings and real-time statistics; specify twice to suppress errors too -h -H --help Display help/long help and exit -V --version Display Version number and exit -k --keep Preserve source files (default behavior) --rm Delete source files on successful compression or decompression -- Treat all subsequent arguments as files Benchmark mode -b# Benchmark file(s), using # compression level -e# Benchmark multiple compression levels, from b# to e# (included) -i# Minimum evaluation time in seconds [1-9] (default : 3) BUGS Report bugs at: https://github.com/lz4/lz4/issues AUTHOR Yann Collet lz4 v1.9.4 August 2022 LZ4(1)
null
mysqlimport
The mysqlimport client provides a command-line interface to the LOAD DATA SQL statement. Most options to mysqlimport correspond directly to clauses of LOAD DATA syntax. See Section 13.2.9, “LOAD DATA Statement”. Invoke mysqlimport like this: mysqlimport [options] db_name textfile1 [textfile2 ...] For each text file named on the command line, mysqlimport strips any extension from the file name and uses the result to determine the name of the table into which to import the file's contents. For example, files named patient.txt, patient.text, and patient all would be imported into a table named patient. mysqlimport supports the following options, which can be specified on the command line or in the [mysqlimport] and [client] groups of an option file. For information about option files used by MySQL programs, see Section 4.2.2.2, “Using Option Files”. • --help, -? ┌────────────────────┬────────┐ │Command-Line Format │ --help │ └────────────────────┴────────┘ Display a help message and exit. • --bind-address=ip_address ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --bind-address=ip_address │ └────────────────────┴───────────────────────────┘ On a computer having multiple network interfaces, use this option to select which interface to use for connecting to the MySQL server. • --character-sets-dir=dir_name ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --character-sets-dir=path │ ├────────────────────┼───────────────────────────┤ │Type │ String │ ├────────────────────┼───────────────────────────┤ │Default Value │ [none] │ └────────────────────┴───────────────────────────┘ The directory where character sets are installed. See Section 10.15, “Character Set Configuration”. • --columns=column_list, -c column_list ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --columns=column_list │ └────────────────────┴───────────────────────┘ This option takes a list of comma-separated column names as its value. The order of the column names indicates how to match data file columns with table columns. • --compress, -C ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --compress[={OFF|ON}] │ ├────────────────────┼───────────────────────┤ │Deprecated │ Yes │ ├────────────────────┼───────────────────────┤ │Type │ Boolean │ ├────────────────────┼───────────────────────┤ │Default Value │ OFF │ └────────────────────┴───────────────────────┘ Compress all information sent between the client and the server if possible. See Section 4.2.8, “Connection Compression Control”. This option is deprecated. Expect it to be removed in a future version of MySQL. See the section called “Configuring Legacy Connection Compression”. • --compression-algorithms=value ┌────────────────────┬────────────────────────────────┐ │Command-Line Format │ --compression-algorithms=value │ ├────────────────────┼────────────────────────────────┤ │Type │ Set │ ├────────────────────┼────────────────────────────────┤ │Default Value │ uncompressed │ ├────────────────────┼────────────────────────────────┤ │Valid Values │ zlib zstd uncompressed │ └────────────────────┴────────────────────────────────┘ The permitted compression algorithms for connections to the server. The available algorithms are the same as for the protocol_compression_algorithms system variable. The default value is uncompressed. For more information, see Section 4.2.8, “Connection Compression Control”. • --debug[=debug_options], -# [debug_options] ┌────────────────────┬─────────────────────────┐ │Command-Line Format │ --debug[=debug_options] │ ├────────────────────┼─────────────────────────┤ │Type │ String │ ├────────────────────┼─────────────────────────┤ │Default Value │ d:t:o │ └────────────────────┴─────────────────────────┘ Write a debugging log. A typical debug_options string is d:t:o,file_name. The default is d:t:o. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. • --debug-check ┌────────────────────┬───────────────┐ │Command-Line Format │ --debug-check │ ├────────────────────┼───────────────┤ │Type │ Boolean │ ├────────────────────┼───────────────┤ │Default Value │ FALSE │ └────────────────────┴───────────────┘ Print some debugging information when the program exits. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. • --debug-info ┌────────────────────┬──────────────┐ │Command-Line Format │ --debug-info │ ├────────────────────┼──────────────┤ │Type │ Boolean │ ├────────────────────┼──────────────┤ │Default Value │ FALSE │ └────────────────────┴──────────────┘ Print debugging information and memory and CPU usage statistics when the program exits. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. • --default-character-set=charset_name ┌────────────────────┬──────────────────────────────────────┐ │Command-Line Format │ --default-character-set=charset_name │ ├────────────────────┼──────────────────────────────────────┤ │Type │ String │ └────────────────────┴──────────────────────────────────────┘ Use charset_name as the default character set. See Section 10.15, “Character Set Configuration”. • --default-auth=plugin ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --default-auth=plugin │ ├────────────────────┼───────────────────────┤ │Type │ String │ └────────────────────┴───────────────────────┘ A hint about which client-side authentication plugin to use. See Section 6.2.17, “Pluggable Authentication”. • --defaults-extra-file=file_name ┌────────────────────┬─────────────────────────────────┐ │Command-Line Format │ --defaults-extra-file=file_name │ ├────────────────────┼─────────────────────────────────┤ │Type │ File name │ └────────────────────┴─────────────────────────────────┘ Read this option file after the global option file but (on Unix) before the user option file. If the file does not exist or is otherwise inaccessible, an error occurs. If file_name is not an absolute path name, it is interpreted relative to the current directory. For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --defaults-file=file_name ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --defaults-file=file_name │ ├────────────────────┼───────────────────────────┤ │Type │ File name │ └────────────────────┴───────────────────────────┘ Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs. If file_name is not an absolute path name, it is interpreted relative to the current directory. Exception: Even with --defaults-file, client programs read .mylogin.cnf. For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --defaults-group-suffix=str ┌────────────────────┬─────────────────────────────┐ │Command-Line Format │ --defaults-group-suffix=str │ ├────────────────────┼─────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────┘ Read not only the usual option groups, but also groups with the usual names and a suffix of str. For example, mysqlimport normally reads the [client] and [mysqlimport] groups. If this option is given as --defaults-group-suffix=_other, mysqlimport also reads the [client_other] and [mysqlimport_other] groups. For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --delete, -D ┌────────────────────┬──────────┐ │Command-Line Format │ --delete │ └────────────────────┴──────────┘ Empty the table before importing the text file. • --enable-cleartext-plugin ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --enable-cleartext-plugin │ ├────────────────────┼───────────────────────────┤ │Type │ Boolean │ ├────────────────────┼───────────────────────────┤ │Default Value │ FALSE │ └────────────────────┴───────────────────────────┘ Enable the mysql_clear_password cleartext authentication plugin. (See Section 6.4.1.4, “Client-Side Cleartext Pluggable Authentication”.) • --fields-terminated-by=..., --fields-enclosed-by=..., --fields-optionally-enclosed-by=..., --fields-escaped-by=... ┌────────────────────┬───────────────────────────────┐ │Command-Line Format │ --fields-terminated-by=string │ ├────────────────────┼───────────────────────────────┤ │Type │ String │ └────────────────────┴───────────────────────────────┘ ┌────────────────────┬─────────────────────────────┐ │Command-Line Format │ --fields-enclosed-by=string │ ├────────────────────┼─────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────┘ ┌────────────────────┬────────────────────────────────────────┐ │Command-Line Format │ --fields-optionally-enclosed-by=string │ ├────────────────────┼────────────────────────────────────────┤ │Type │ String │ └────────────────────┴────────────────────────────────────────┘ ┌────────────────────┬─────────────────────┐ │Command-Line Format │ --fields-escaped-by │ ├────────────────────┼─────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────┘ These options have the same meaning as the corresponding clauses for LOAD DATA. See Section 13.2.9, “LOAD DATA Statement”. • --force, -f ┌────────────────────┬─────────┐ │Command-Line Format │ --force │ └────────────────────┴─────────┘ Ignore errors. For example, if a table for a text file does not exist, continue processing any remaining files. Without --force, mysqlimport exits if a table does not exist. • --get-server-public-key ┌────────────────────┬─────────────────────────┐ │Command-Line Format │ --get-server-public-key │ ├────────────────────┼─────────────────────────┤ │Type │ Boolean │ └────────────────────┴─────────────────────────┘ Request from the server the public key required for RSA key pair-based password exchange. This option applies to clients that authenticate with the caching_sha2_password authentication plugin. For that plugin, the server does not send the public key unless requested. This option is ignored for accounts that do not authenticate with that plugin. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection. If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over --get-server-public-key. For information about the caching_sha2_password plugin, see Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”. • --host=host_name, -h host_name ┌────────────────────┬──────────────────┐ │Command-Line Format │ --host=host_name │ ├────────────────────┼──────────────────┤ │Type │ String │ ├────────────────────┼──────────────────┤ │Default Value │ localhost │ └────────────────────┴──────────────────┘ Import data to the MySQL server on the given host. The default host is localhost. • --ignore, -i ┌────────────────────┬──────────┐ │Command-Line Format │ --ignore │ └────────────────────┴──────────┘ See the description for the --replace option. • --ignore-lines=N ┌────────────────────┬──────────────────┐ │Command-Line Format │ --ignore-lines=# │ ├────────────────────┼──────────────────┤ │Type │ Numeric │ └────────────────────┴──────────────────┘ Ignore the first N lines of the data file. • --lines-terminated-by=... ┌────────────────────┬──────────────────────────────┐ │Command-Line Format │ --lines-terminated-by=string │ ├────────────────────┼──────────────────────────────┤ │Type │ String │ └────────────────────┴──────────────────────────────┘ This option has the same meaning as the corresponding clause for LOAD DATA. For example, to import Windows files that have lines terminated with carriage return/linefeed pairs, use --lines-terminated-by="\r\n". (You might have to double the backslashes, depending on the escaping conventions of your command interpreter.) See Section 13.2.9, “LOAD DATA Statement”. • --local, -L ┌────────────────────┬─────────┐ │Command-Line Format │ --local │ ├────────────────────┼─────────┤ │Type │ Boolean │ ├────────────────────┼─────────┤ │Default Value │ FALSE │ └────────────────────┴─────────┘ By default, files are read by the server on the server host. With this option, mysqlimport reads input files locally on the client host. Successful use of LOCAL load operations within mysqlimport also requires that the server permits local loading; see Section 6.1.6, “Security Considerations for LOAD DATA LOCAL” • --lock-tables, -l ┌────────────────────┬───────────────┐ │Command-Line Format │ --lock-tables │ └────────────────────┴───────────────┘ Lock all tables for writing before processing any text files. This ensures that all tables are synchronized on the server. • --login-path=name ┌────────────────────┬───────────────────┐ │Command-Line Format │ --login-path=name │ ├────────────────────┼───────────────────┤ │Type │ String │ └────────────────────┴───────────────────┘ Read options from the named login path in the .mylogin.cnf login path file. A “login path” is an option group containing options that specify which MySQL server to connect to and which account to authenticate as. To create or modify a login path file, use the mysql_config_editor utility. See mysql_config_editor(1). For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --no-login-paths ┌────────────────────┬──────────────────┐ │Command-Line Format │ --no-login-paths │ └────────────────────┴──────────────────┘ Skips reading options from the login path file. See --login-path for related information. For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --low-priority ┌────────────────────┬────────────────┐ │Command-Line Format │ --low-priority │ └────────────────────┴────────────────┘ Use LOW_PRIORITY when loading the table. This affects only storage engines that use only table-level locking (such as MyISAM, MEMORY, and MERGE). • --no-defaults ┌────────────────────┬───────────────┐ │Command-Line Format │ --no-defaults │ └────────────────────┴───────────────┘ Do not read any option files. If program startup fails due to reading unknown options from an option file, --no-defaults can be used to prevent them from being read. The exception is that the .mylogin.cnf file is read in all cases, if it exists. This permits passwords to be specified in a safer way than on the command line even when --no-defaults is used. To create .mylogin.cnf, use the mysql_config_editor utility. See mysql_config_editor(1). For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --password[=password], -p[password] ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --password[=password] │ ├────────────────────┼───────────────────────┤ │Type │ String │ └────────────────────┴───────────────────────┘ The password of the MySQL account used for connecting to the server. The password value is optional. If not given, mysqlimport prompts for one. If given, there must be no space between --password= or -p and the password following it. If no password option is specified, the default is to send no password. Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 6.1.2.1, “End-User Guidelines for Password Security”. To explicitly specify that there is no password and that mysqlimport should not prompt for one, use the --skip-password option. • --password1[=pass_val] The password for multifactor authentication factor 1 of the MySQL account used for connecting to the server. The password value is optional. If not given, mysqlimport prompts for one. If given, there must be no space between --password1= and the password following it. If no password option is specified, the default is to send no password. Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 6.1.2.1, “End-User Guidelines for Password Security”. To explicitly specify that there is no password and that mysqlimport should not prompt for one, use the --skip-password1 option. --password1 and --password are synonymous, as are --skip-password1 and --skip-password. • --password2[=pass_val] The password for multifactor authentication factor 2 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for --password1; see the description of that option for details. • --password3[=pass_val] The password for multifactor authentication factor 3 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for --password1; see the description of that option for details. • --pipe, -W ┌────────────────────┬────────┐ │Command-Line Format │ --pipe │ ├────────────────────┼────────┤ │Type │ String │ └────────────────────┴────────┘ On Windows, connect to the server using a named pipe. This option applies only if the server was started with the named_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by the named_pipe_full_access_group system variable. • --plugin-dir=dir_name ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --plugin-dir=dir_name │ ├────────────────────┼───────────────────────┤ │Type │ Directory name │ └────────────────────┴───────────────────────┘ The directory in which to look for plugins. Specify this option if the --default-auth option is used to specify an authentication plugin but mysqlimport does not find it. See Section 6.2.17, “Pluggable Authentication”. • --port=port_num, -P port_num ┌────────────────────┬─────────────────┐ │Command-Line Format │ --port=port_num │ ├────────────────────┼─────────────────┤ │Type │ Numeric │ ├────────────────────┼─────────────────┤ │Default Value │ 3306 │ └────────────────────┴─────────────────┘ For TCP/IP connections, the port number to use. • --print-defaults ┌────────────────────┬──────────────────┐ │Command-Line Format │ --print-defaults │ └────────────────────┴──────────────────┘ Print the program name and all options that it gets from option files. For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --protocol={TCP|SOCKET|PIPE|MEMORY} ┌────────────────────┬────────────────────────┐ │Command-Line Format │ --protocol=type │ ├────────────────────┼────────────────────────┤ │Type │ String │ ├────────────────────┼────────────────────────┤ │Default Value │ [see text] │ ├────────────────────┼────────────────────────┤ │Valid Values │ TCP SOCKET PIPE │ │ │ MEMORY │ └────────────────────┴────────────────────────┘ The transport protocol to use for connecting to the server. It is useful when the other connection parameters normally result in use of a protocol other than the one you want. For details on the permissible values, see Section 4.2.7, “Connection Transport Protocols”. • --replace, -r ┌────────────────────┬───────────┐ │Command-Line Format │ --replace │ └────────────────────┴───────────┘ The --replace and --ignore options control handling of input rows that duplicate existing rows on unique key values. If you specify --replace, new rows replace existing rows that have the same unique key value. If you specify --ignore, input rows that duplicate an existing row on a unique key value are skipped. If you do not specify either option, an error occurs when a duplicate key value is found, and the rest of the text file is ignored. • --server-public-key-path=file_name ┌────────────────────┬────────────────────────────────────┐ │Command-Line Format │ --server-public-key-path=file_name │ ├────────────────────┼────────────────────────────────────┤ │Type │ File name │ └────────────────────┴────────────────────────────────────┘ The path name to a file in PEM format containing a client-side copy of the public key required by the server for RSA key pair-based password exchange. This option applies to clients that authenticate with the sha256_password or caching_sha2_password authentication plugin. This option is ignored for accounts that do not authenticate with one of those plugins. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection. If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over --get-server-public-key. For sha256_password, this option applies only if MySQL was built using OpenSSL. For information about the sha256_password and caching_sha2_password plugins, see Section 6.4.1.3, “SHA-256 Pluggable Authentication”, and Section 6.4.1.2, “Caching SHA-2 Pluggable Authentication”. • --shared-memory-base-name=name ┌────────────────────┬────────────────────────────────┐ │Command-Line Format │ --shared-memory-base-name=name │ ├────────────────────┼────────────────────────────────┤ │Platform Specific │ Windows │ └────────────────────┴────────────────────────────────┘ On Windows, the shared-memory name to use for connections made using shared memory to a local server. The default value is MYSQL. The shared-memory name is case-sensitive. This option applies only if the server was started with the shared_memory system variable enabled to support shared-memory connections. • --silent, -s ┌────────────────────┬──────────┐ │Command-Line Format │ --silent │ └────────────────────┴──────────┘ Silent mode. Produce output only when errors occur. • --socket=path, -S path ┌────────────────────┬────────────────────────────────┐ │Command-Line Format │ --socket={file_name|pipe_name} │ ├────────────────────┼────────────────────────────────┤ │Type │ String │ └────────────────────┴────────────────────────────────┘ For connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use. On Windows, this option applies only if the server was started with the named_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by the named_pipe_full_access_group system variable. • --ssl* Options that begin with --ssl specify whether to connect to the server using encryption and indicate where to find SSL keys and certificates. See the section called “Command Options for Encrypted Connections”. • --ssl-fips-mode={OFF|ON|STRICT} ┌────────────────────┬─────────────────────────────────┐ │Command-Line Format │ --ssl-fips-mode={OFF|ON|STRICT} │ ├────────────────────┼─────────────────────────────────┤ │Deprecated │ Yes │ ├────────────────────┼─────────────────────────────────┤ │Type │ Enumeration │ ├────────────────────┼─────────────────────────────────┤ │Default Value │ OFF │ ├────────────────────┼─────────────────────────────────┤ │Valid Values │ OFF ON STRICT │ └────────────────────┴─────────────────────────────────┘ Controls whether to enable FIPS mode on the client side. The --ssl-fips-mode option differs from other --ssl-xxx options in that it is not used to establish encrypted connections, but rather to affect which cryptographic operations to permit. See Section 6.8, “FIPS Support”. These --ssl-fips-mode values are permitted: • OFF: Disable FIPS mode. • ON: Enable FIPS mode. • STRICT: Enable “strict” FIPS mode. Note If the OpenSSL FIPS Object Module is not available, the only permitted value for --ssl-fips-mode is OFF. In this case, setting --ssl-fips-mode to ON or STRICT causes the client to produce a warning at startup and to operate in non-FIPS mode. This option is deprecated. Expect it to be removed in a future version of MySQL. • --tls-ciphersuites=ciphersuite_list ┌────────────────────┬─────────────────────────────────────┐ │Command-Line Format │ --tls-ciphersuites=ciphersuite_list │ ├────────────────────┼─────────────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────────────┘ The permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a list of one or more colon-separated ciphersuite names. The ciphersuites that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, “Encrypted Connection TLS Protocols and Ciphers”. • --tls-sni-servername=server_name ┌────────────────────┬──────────────────────────────────┐ │Command-Line Format │ --tls-sni-servername=server_name │ ├────────────────────┼──────────────────────────────────┤ │Type │ String │ └────────────────────┴──────────────────────────────────┘ When specified, the name is passed to the libmysqlclient C API library using the MYSQL_OPT_TLS_SNI_SERVERNAME option of mysql_options(). The server name is not case-sensitive. To show which server name the client specified for the current session, if any, check the Tls_sni_server_name status variable. Server Name Indication (SNI) is an extension to the TLS protocol (OpenSSL must be compiled using TLS extensions for this option to function). The MySQL implementation of SNI represents the client-side only. • --tls-version=protocol_list ┌────────────────────┬───────────────────────────────┐ │Command-Line Format │ --tls-version=protocol_list │ ├────────────────────┼───────────────────────────────┤ │Type │ String │ ├────────────────────┼───────────────────────────────┤ │Default Value │ TLSv1,TLSv1.1,TLSv1.2,TLSv1.3 │ │ │ (OpenSSL 1.1.1 or higher) │ │ │ TLSv1,TLSv1.1,TLSv1.2 │ │ │ (otherwise) │ └────────────────────┴───────────────────────────────┘ The permissible TLS protocols for encrypted connections. The value is a list of one or more comma-separated protocol names. The protocols that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, “Encrypted Connection TLS Protocols and Ciphers”. • --user=user_name, -u user_name ┌────────────────────┬───────────────────┐ │Command-Line Format │ --user=user_name, │ ├────────────────────┼───────────────────┤ │Type │ String │ └────────────────────┴───────────────────┘ The user name of the MySQL account to use for connecting to the server. • --use-threads=N ┌────────────────────┬─────────────────┐ │Command-Line Format │ --use-threads=# │ ├────────────────────┼─────────────────┤ │Type │ Numeric │ └────────────────────┴─────────────────┘ Load files in parallel using N threads. • --verbose, -v ┌────────────────────┬───────────┐ │Command-Line Format │ --verbose │ └────────────────────┴───────────┘ Verbose mode. Print more information about what the program does. • --version, -V ┌────────────────────┬───────────┐ │Command-Line Format │ --version │ └────────────────────┴───────────┘ Display version information and exit. • --zstd-compression-level=level ┌────────────────────┬────────────────────────────┐ │Command-Line Format │ --zstd-compression-level=# │ ├────────────────────┼────────────────────────────┤ │Type │ Integer │ └────────────────────┴────────────────────────────┘ The compression level to use for connections to the server that use the zstd compression algorithm. The permitted levels are from 1 to 22, with larger values indicating increasing levels of compression. The default zstd compression level is 3. The compression level setting has no effect on connections that do not use zstd compression. For more information, see Section 4.2.8, “Connection Compression Control”. Here is a sample session that demonstrates use of mysqlimport: $> mysql -e 'CREATE TABLE imptest(id INT, n VARCHAR(30))' test $> ed a 100 Max Sydow 101 Count Dracula . w imptest.txt 32 q $> od -c imptest.txt 0000000 1 0 0 \t M a x S y d o w \n 1 0 0000020 1 \t C o u n t D r a c u l a \n 0000040 $> mysqlimport --local test imptest.txt test.imptest: Records: 2 Deleted: 0 Skipped: 0 Warnings: 0 $> mysql -e 'SELECT * FROM imptest' test +------+---------------+ | id | n | +------+---------------+ | 100 | Max Sydow | | 101 | Count Dracula | +------+---------------+ COPYRIGHT Copyright © 1997, 2023, Oracle and/or its affiliates. This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/. SEE ALSO For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/. AUTHOR Oracle Corporation (http://dev.mysql.com/). MySQL 8.3 11/23/2023 MYSQLIMPORT(1)
mysqlimport - a data import program
mysqlimport [options] db_name textfile1 ...
null
null
autopep8
null
null
null
null
null
binstar
null
null
null
null
null
fonttools
null
null
null
null
null
orc-metadata
null
null
null
null
null
msgen
Creates an English translation catalog. The input file is the last created English PO file, or a PO Template file (generally created by xgettext). Untranslated entries are assigned a translation that is identical to the msgid. Mandatory arguments to long options are mandatory for short options too. Input file location: INPUTFILE input PO or POT file -D, --directory=DIRECTORY add DIRECTORY to list for input files search If input file 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 -. 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: --lang=CATALOGNAME set 'Language' field in the header entry --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 indented output style --no-location suppress '#: filename:line' lines -n, --add-location preserve '#: filename:line' lines (default) --strict strict Uniforum output style -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 msgen is maintained as a Texinfo manual. If the info and msgen programs are properly installed at your site, the command info msgen should give you access to the complete manual. GNU gettext-tools 0.22.5 February 2024 MSGEN(1)
msgen - create English message catalog
msgen [OPTION] INPUTFILE
null
null
surya_order
null
null
null
null
null
wheel
null
null
null
null
null
humanfriendly
null
null
null
null
null
arm64-apple-darwin20.0.0-mtor
null
null
null
null
null
tclsh8.6
null
null
null
null
null
qtattributionsscanner
null
null
null
null
null
arm64-apple-darwin20.0.0-dyldinfo
Executables built for Mac OS X 10.6 and later have a new format for the information in the __LINKEDIT segment. The dyldinfo tool will display that information. The options are as follows: -arch arch Only display the specified architecture. Other architectures in a universal image are ignored. -dylibs Display the table of dylibs on which this image depends. -rebase Display the table of rebasing information. Rebasing is what dyld does when an image is not loaded at its preferred address. Typically, this involves updating pointers in the __DATA segment which point within the image. -bind Display the table of binding information. These are the symbolic fix ups that dyld must do when an image is loaded. -weak_bind Display the table of weak binding information. Typically, only C++ progams will have any weak binding. These are symbols which dyld must unique accross all images. -lazy_bind Display the table of lazy binding information. These are symbols which dyld delays binding until they are first used. Lazy binding is automatically used for all function calls to functions in some external dylib. -export Display the table symbols which this image exports. -opcodes Display the low level opcodes used to encode all rebase and binding information. -function_starts Decodes the list of function start addresses. SEE ALSO otool(1) nm(1) Darwin November 10, 2010 Darwin
dyldinfo – Displays information used by dyld in an executable
dyldinfo [-arch arch-name] [-dylibs] [-rebase] [-bind] [-weak_bind] [-lazy_bind] [-export] [-opcodes] [-function_starts] file(s)
null
null
cookiecutter
null
null
null
null
null
slugify
null
null
null
null
null
odbcinst
odbcinst is a command-line utility allowing users who develop install scripts or packages for ODBC drivers to easily create or remove entries in odbc.ini and odbcinst.ini. The utility is part of the odbcinst component of unixODBC and complements the shared library of the same name (libodbcinst).
odbcinst - A unixODBC utility for managing configuration files
odbcinst ACTION OBJECT OPTIONS
ACTIONS -i Install a new OBJECT (by adding a section to a configuration file). -u Uninstall an existing OBJECT (by removing a section from a configuration file). -q Query ODBC configuration files and print available options for the specified OBJECT. -j Print the current configuration of unixODBC, including paths to configuration files. -c Call SQLCreateDataSource. -m Call SQLManageDataSources. --version Display the program version. OBJECTS -d The specified ACTION affects a driver (and thus the odbcinst.ini configuration file). -s The specified ACTION affects a data source (and thus the user or system odbc.ini configuration file). -f FILE FILE is a template describing the configuration of the installed OBJECT (only valid with the -i ACTION). -r Act in the same way as for the -f OPTION, but take standard input as the template file. -n NAME Specifies the NAME of the OBJECT. -v Disable all information, warning and error messages. -l The specified data source is system-wide. This option is only valid when used with the -s OBJECT. -h The specified data source is user-specific. This option is only valid when used with the -s OBJECT. RETURN VALUES odbcinst returns zero on success and a non-zero value on failure. FILES /etc/odbcinst.ini Configuration file containing all database driver definitions. See odbcinst.ini(5) for more information. /etc/odbc.ini Configuration file containing system-wide Data Source Name (DSN) definitions. See odbc.ini(5) for more information. $HOME/.odbc.ini Configuration file containing user-specific Data Source Name (DSN) definitions. See odbc.ini(5) for more information. SEE ALSO odbcinst.ini(5), odbc.ini(5) AUTHORS The authors of unixODBC are Peter Harvey <pharvey@codebydesign.com> and Nick Gorham <nick@lurcher.org>. For a full list of contributors, refer to the AUTHORS file. COPYRIGHT unixODBC is licensed under the GNU Lesser General Public License. For details about the license, see the COPYING file. version 2.3.12 Sat 09 Jan 2021 odbcinst(1)
null
rst2odt_prepstyles.py
null
null
null
null
null
conda-develop
null
null
null
null
null
aec
Aec performs lossless compression and decompression with Golomb-Rice coding as defined in the Space Data System Standard documents 121.0-B-2.
aec - compress or expand files
aec [-3] [-b BYTES] [-d] [-j SAMPLES] [-m] [-n BITS] [-N] [-p] [-r BLOCKS] [-s] [-t] infile outfile
-3 24 bit samples are stored in 3 bytes -b BYTES internal buffer size in bytes -d decompress infile; if option -d is not used then compress infile -j SAMPLES block size in samples -m samples are MSB first; default is LSB first -n BITS bits per sample -N disable pre/post processing -p pad RSI to byte boundary -r BLOCKS reference sample interval in blocks -s samples are signed; default is unsigned -t use restricted set of code options AEC(1)
null
python3.11
Python is an interpreted, interactive, object-oriented programming language that combines remarkable power with very clear syntax. For an introduction to programming in Python, see the Python Tutorial. The Python Library Reference documents built-in and standard types, constants, functions and modules. Finally, the Python Reference Manual describes the syntax and semantics of the core language in (perhaps too) much detail. (These documents may be located via the INTERNET RESOURCES below; they may be installed on your system as well.) Python's basic power can be extended with your own modules written in C or C++. On most systems such modules may be dynamically loaded. Python is also adaptable as an extension language for existing applications. See the internal documentation for hints. Documentation for installed Python modules and packages can be viewed by running the pydoc program. COMMAND LINE OPTIONS -B Don't write .pyc files on import. See also PYTHONDONTWRITEBYTECODE. -b Issue warnings about str(bytes_instance), str(bytearray_instance) and comparing bytes/bytearray with str. (-bb: issue errors) -c command Specify the command to execute (see next section). This terminates the option list (following options are passed as arguments to the command). --check-hash-based-pycs mode Configure how Python evaluates the up-to-dateness of hash-based .pyc files. -d Turn on parser debugging output (for expert only, depending on compilation options). -E Ignore environment variables like PYTHONPATH and PYTHONHOME that modify the behavior of the interpreter. -h , -? , --help Prints the usage for the interpreter executable and exits. --help-env Prints help about Python-specific environment variables and exits. --help-xoptions Prints help about implementation-specific -X options and exits. --help-all Prints complete usage information and exits. -i When a script is passed as first argument or the -c option is used, enter interactive mode after executing the script or the command. It does not read the $PYTHONSTARTUP file. This can be useful to inspect global variables or a stack trace when a script raises an exception. -I Run Python in isolated mode. This also implies -E, -P and -s. In isolated mode sys.path contains neither the script's directory nor the user's site-packages directory. All PYTHON* environment variables are ignored, too. Further restrictions may be imposed to prevent the user from injecting malicious code. -m module-name Searches sys.path for the named module and runs the corresponding .py file as a script. This terminates the option list (following options are passed as arguments to the module). -O Remove assert statements and any code conditional on the value of __debug__; augment the filename for compiled (bytecode) files by adding .opt-1 before the .pyc extension. -OO Do -O and also discard docstrings; change the filename for compiled (bytecode) files by adding .opt-2 before the .pyc extension. -P Don't automatically prepend a potentially unsafe path to sys.path such as the current directory, the script's directory or an empty string. See also the PYTHONSAFEPATH environment variable. -q Do not print the version and copyright messages. These messages are also suppressed in non-interactive mode. -s Don't add user site directory to sys.path. -S Disable the import of the module site and the site-dependent manipulations of sys.path that it entails. Also disable these manipulations if site is explicitly imported later. -u Force the stdout and stderr streams to be unbuffered. This option has no effect on the stdin stream. -v Print a message each time a module is initialized, showing the place (filename or built-in module) from which it is loaded. When given twice, print a message for each file that is checked for when searching for a module. Also provides information on module cleanup at exit. -V , --version Prints the Python version number of the executable and exits. When given twice, print more information about the build. -W argument Warning control. Python's warning machinery by default prints warning messages to sys.stderr. The simplest settings apply a particular action unconditionally to all warnings emitted by a process (even those that are otherwise ignored by default): -Wdefault # Warn once per call location -Werror # Convert to exceptions -Walways # Warn every time -Wmodule # Warn once per calling module -Wonce # Warn once per Python process -Wignore # Never warn The action names can be abbreviated as desired and the interpreter will resolve them to the appropriate action name. For example, -Wi is the same as -Wignore . The full form of argument is: action:message:category:module:lineno Empty fields match all values; trailing empty fields may be omitted. For example -W ignore::DeprecationWarning ignores all DeprecationWarning warnings. The action field is as explained above but only applies to warnings that match the remaining fields. The message field must match the whole printed warning message; this match is case-insensitive. The category field matches the warning category (ex: "DeprecationWarning"). This must be a class name; the match test whether the actual warning category of the message is a subclass of the specified warning category. The module field matches the (fully-qualified) module name; this match is case-sensitive. The lineno field matches the line number, where zero matches all line numbers and is thus equivalent to an omitted line number. Multiple -W options can be given; when a warning matches more than one option, the action for the last matching option is performed. Invalid -W options are ignored (though, a warning message is printed about invalid options when the first warning is issued). Warnings can also be controlled using the PYTHONWARNINGS environment variable and from within a Python program using the warnings module. For example, the warnings.filterwarnings() function can be used to use a regular expression on the warning message. -X option Set implementation-specific option. The following options are available: -X faulthandler: enable faulthandler -X showrefcount: output the total reference count and number of used memory blocks when the program finishes or after each statement in the interactive interpreter. This only works on debug builds -X tracemalloc: start tracing Python memory allocations using the tracemalloc module. By default, only the most recent frame is stored in a traceback of a trace. Use -X tracemalloc=NFRAME to start tracing with a traceback limit of NFRAME frames -X importtime: show how long each import takes. It shows module name, cumulative time (including nested imports) and self time (excluding nested imports). Note that its output may be broken in multi-threaded application. Typical usage is python3 -X importtime -c 'import asyncio' -X dev: enable CPython's "development mode", introducing additional runtime checks which are too expensive to be enabled by default. It will not be more verbose than the default if the code is correct: new warnings are only emitted when an issue is detected. Effect of the developer mode: * Add default warning filter, as -W default * Install debug hooks on memory allocators: see the PyMem_SetupDebugHooks() C function * Enable the faulthandler module to dump the Python traceback on a crash * Enable asyncio debug mode * Set the dev_mode attribute of sys.flags to True * io.IOBase destructor logs close() exceptions -X utf8: enable UTF-8 mode for operating system interfaces, overriding the default locale-aware mode. -X utf8=0 explicitly disables UTF-8 mode (even when it would otherwise activate automatically). See PYTHONUTF8 for more details -X pycache_prefix=PATH: enable writing .pyc files to a parallel tree rooted at the given directory instead of to the code tree. -X warn_default_encoding: enable opt-in EncodingWarning for 'encoding=None' -X no_debug_ranges: disable the inclusion of the tables mapping extra location information (end line, start column offset and end column offset) to every instruction in code objects. This is useful when smaller code objects and pyc files are desired as well as suppressing the extra visual location indicators when the interpreter displays tracebacks. -X frozen_modules=[on|off]: whether or not frozen modules should be used. The default is "on" (or "off" if you are running a local build). -X int_max_str_digits=number: limit the size of int<->str conversions. This helps avoid denial of service attacks when parsing untrusted data. The default is sys.int_info.default_max_str_digits. 0 disables. -x Skip the first line of the source. This is intended for a DOS specific hack only. Warning: the line numbers in error messages will be off by one! INTERPRETER INTERFACE The interpreter interface resembles that of the UNIX shell: when called with standard input connected to a tty device, it prompts for commands and executes them until an EOF is read; when called with a file name argument or with a file as standard input, it reads and executes a script from that file; when called with -c command, it executes the Python statement(s) given as command. Here command may contain multiple statements separated by newlines. Leading whitespace is significant in Python statements! In non-interactive mode, the entire input is parsed before it is executed. If available, the script name and additional arguments thereafter are passed to the script in the Python variable sys.argv, which is a list of strings (you must first import sys to be able to access it). If no script name is given, sys.argv[0] is an empty string; if -c is used, sys.argv[0] contains the string '-c'. Note that options interpreted by the Python interpreter itself are not placed in sys.argv. In interactive mode, the primary prompt is `>>>'; the second prompt (which appears when a command is not complete) is `...'. The prompts can be changed by assignment to sys.ps1 or sys.ps2. The interpreter quits when it reads an EOF at a prompt. When an unhandled exception occurs, a stack trace is printed and control returns to the primary prompt; in non-interactive mode, the interpreter exits after printing the stack trace. The interrupt signal raises the KeyboardInterrupt exception; other UNIX signals are not caught (except that SIGPIPE is sometimes ignored, in favor of the IOError exception). Error messages are written to stderr. FILES AND DIRECTORIES These are subject to difference depending on local installation conventions; ${prefix} and ${exec_prefix} are installation-dependent and should be interpreted as for GNU software; they may be the same. The default for both is /usr/local. ${exec_prefix}/bin/python Recommended location of the interpreter. ${prefix}/lib/python<version> ${exec_prefix}/lib/python<version> Recommended locations of the directories containing the standard modules. ${prefix}/include/python<version> ${exec_prefix}/include/python<version> Recommended locations of the directories containing the include files needed for developing Python extensions and embedding the interpreter. ENVIRONMENT VARIABLES PYTHONSAFEPATH If this is set to a non-empty string, don't automatically prepend a potentially unsafe path to sys.path such as the current directory, the script's directory or an empty string. See also the -P option. PYTHONHOME Change the location of the standard Python libraries. By default, the libraries are searched in ${prefix}/lib/python<version> and ${exec_prefix}/lib/python<version>, where ${prefix} and ${exec_prefix} are installation-dependent directories, both defaulting to /usr/local. When $PYTHONHOME is set to a single directory, its value replaces both ${prefix} and ${exec_prefix}. To specify different values for these, set $PYTHONHOME to ${prefix}:${exec_prefix}. PYTHONPATH Augments the default search path for module files. The format is the same as the shell's $PATH: one or more directory pathnames separated by colons. Non-existent directories are silently ignored. The default search path is installation dependent, but generally begins with ${prefix}/lib/python<version> (see PYTHONHOME above). The default search path is always appended to $PYTHONPATH. If a script argument is given, the directory containing the script is inserted in the path in front of $PYTHONPATH. The search path can be manipulated from within a Python program as the variable sys.path. PYTHONPLATLIBDIR Override sys.platlibdir. PYTHONSTARTUP If this is the name of a readable file, the Python commands in that file are executed before the first prompt is displayed in interactive mode. The file is executed in the same name space where interactive commands are executed so that objects defined or imported in it can be used without qualification in the interactive session. You can also change the prompts sys.ps1 and sys.ps2 in this file. PYTHONOPTIMIZE If this is set to a non-empty string it is equivalent to specifying the -O option. If set to an integer, it is equivalent to specifying -O multiple times. PYTHONDEBUG If this is set to a non-empty string it is equivalent to specifying the -d option. If set to an integer, it is equivalent to specifying -d multiple times. PYTHONDONTWRITEBYTECODE If this is set to a non-empty string it is equivalent to specifying the -B option (don't try to write .pyc files). PYTHONINSPECT If this is set to a non-empty string it is equivalent to specifying the -i option. PYTHONIOENCODING If this is set before running the interpreter, it overrides the encoding used for stdin/stdout/stderr, in the syntax encodingname:errorhandler The errorhandler part is optional and has the same meaning as in str.encode. For stderr, the errorhandler part is ignored; the handler will always be ´backslashreplace´. PYTHONNOUSERSITE If this is set to a non-empty string it is equivalent to specifying the -s option (Don't add the user site directory to sys.path). PYTHONUNBUFFERED If this is set to a non-empty string it is equivalent to specifying the -u option. PYTHONVERBOSE If this is set to a non-empty string it is equivalent to specifying the -v option. If set to an integer, it is equivalent to specifying -v multiple times. PYTHONWARNINGS If this is set to a comma-separated string it is equivalent to specifying the -W option for each separate value. PYTHONHASHSEED If this variable is set to "random", a random value is used to seed the hashes of str and bytes objects. If PYTHONHASHSEED is set to an integer value, it is used as a fixed seed for generating the hash() of the types covered by the hash randomization. Its purpose is to allow repeatable hashing, such as for selftests for the interpreter itself, or to allow a cluster of python processes to share hash values. The integer must be a decimal number in the range [0,4294967295]. Specifying the value 0 will disable hash randomization. PYTHONINTMAXSTRDIGITS Limit the maximum digit characters in an int value when converting from a string and when converting an int back to a str. A value of 0 disables the limit. Conversions to or from bases 2, 4, 8, 16, and 32 are never limited. PYTHONMALLOC Set the Python memory allocators and/or install debug hooks. The available memory allocators are malloc and pymalloc. The available debug hooks are debug, malloc_debug, and pymalloc_debug. When Python is compiled in debug mode, the default is pymalloc_debug and the debug hooks are automatically used. Otherwise, the default is pymalloc. PYTHONMALLOCSTATS If set to a non-empty string, Python will print statistics of the pymalloc memory allocator every time a new pymalloc object arena is created, and on shutdown. This variable is ignored if the $PYTHONMALLOC environment variable is used to force the malloc(3) allocator of the C library, or if Python is configured without pymalloc support. PYTHONASYNCIODEBUG If this environment variable is set to a non-empty string, enable the debug mode of the asyncio module. PYTHONTRACEMALLOC If this environment variable is set to a non-empty string, start tracing Python memory allocations using the tracemalloc module. The value of the variable is the maximum number of frames stored in a traceback of a trace. For example, PYTHONTRACEMALLOC=1 stores only the most recent frame. PYTHONFAULTHANDLER If this environment variable is set to a non-empty string, faulthandler.enable() is called at startup: install a handler for SIGSEGV, SIGFPE, SIGABRT, SIGBUS and SIGILL signals to dump the Python traceback. This is equivalent to the -X faulthandler option. PYTHONEXECUTABLE If this environment variable is set, sys.argv[0] will be set to its value instead of the value got through the C runtime. Only works on Mac OS X. PYTHONUSERBASE Defines the user base directory, which is used to compute the path of the user site-packages directory and Distutils installation paths for python setup.py install --user. PYTHONPROFILEIMPORTTIME If this environment variable is set to a non-empty string, Python will show how long each import takes. This is exactly equivalent to setting -X importtime on the command line. PYTHONBREAKPOINT If this environment variable is set to 0, it disables the default debugger. It can be set to the callable of your debugger of choice. Debug-mode variables Setting these variables only has an effect in a debug build of Python, that is, if Python was configured with the --with-pydebug build option. PYTHONTHREADDEBUG If this environment variable is set, Python will print threading debug info. The feature is deprecated in Python 3.10 and will be removed in Python 3.12. PYTHONDUMPREFS If this environment variable is set, Python will dump objects and reference counts still alive after shutting down the interpreter. AUTHOR The Python Software Foundation: https://www.python.org/psf/ INTERNET RESOURCES Main website: https://www.python.org/ Documentation: https://docs.python.org/ Developer resources: https://devguide.python.org/ Downloads: https://www.python.org/downloads/ Module repository: https://pypi.org/ Newsgroups: comp.lang.python, comp.lang.python.announce LICENSING Python is distributed under an Open Source license. See the file "LICENSE" in the Python source distribution for information on terms & conditions for accessing and otherwise using Python and for a DISCLAIMER OF ALL WARRANTIES. PYTHON(1)
python - an interpreted, interactive, object-oriented programming language
python [ -B ] [ -b ] [ -d ] [ -E ] [ -h ] [ -i ] [ -I ] [ -m module-name ] [ -q ] [ -O ] [ -OO ] [ -P ] [ -s ] [ -S ] [ -u ] [ -v ] [ -V ] [ -W argument ] [ -x ] [ -X option ] [ -? ] [ --check-hash-based-pycs default | always | never ] [ --help ] [ --help-env ] [ --help-xoptions ] [ --help-all ] [ -c command | script | - ] [ arguments ]
null
null
conda-inspect
null
null
null
null
null
mysqlpump
• mysqlpump Invocation Syntax • mysqlpump Option Summary • mysqlpump Option Descriptions • mysqlpump Object Selection • mysqlpump Parallel Processing • mysqlpump Restrictions The mysqlpump 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. Note mysqlpump is deprecated as of MySQL 8.0.34 / 8.1.0; expect it to be removed in a future version of MySQL. You can use such MySQL programs as mysqldump and MySQL Shell to perform logical backups, dump databases, and similar tasks instead. 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]. mysqlpump features include: • Parallel processing of databases, and of objects within databases, to speed up the dump process • Better control over which databases and database objects (tables, stored programs, user accounts) to dump • Dumping of user accounts as account-management statements (CREATE USER, GRANT) rather than as inserts into the mysql system database • Capability of creating compressed output • Progress indicator (the values are estimates) • For dump file reloading, faster secondary index creation for InnoDB tables by adding indexes after rows are inserted Note mysqlpump uses MySQL features introduced in MySQL 5.7, and thus assumes use with MySQL 5.7 or higher. mysqlpump requires at least the SELECT privilege for dumped tables, SHOW VIEW for dumped views, TRIGGER for dumped triggers, and LOCK TABLES if the --single-transaction option is not used. The SELECT privilege on the mysql system database is required to dump user definitions. 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. Note A dump made using PowerShell on Windows with output redirection creates a file that has UTF-16 encoding: mysqlpump [options] > dump.sql However, UTF-16 is not permitted as a connection character set (see Section 10.4, “Connection Character Sets and Collations”), 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: mysqlpump [options] --result-file=dump.sql mysqlpump Invocation Syntax By default, mysqlpump dumps all databases (with certain exceptions noted in mysqlpump Restrictions). To specify this behavior explicitly, use the --all-databases option: mysqlpump --all-databases To dump a single database, or certain tables within that database, name the database on the command line, optionally followed by table names: mysqlpump db_name mysqlpump db_name tbl_name1 tbl_name2 ... To treat all name arguments as database names, use the --databases option: mysqlpump --databases db_name1 db_name2 ... By default, mysqlpump does not dump user account definitions, even if you dump the mysql system database that contains the grant tables. To dump grant table contents as logical definitions in the form of CREATE USER and GRANT statements, use the --users option and suppress all database dumping: mysqlpump --exclude-databases=% --users In the preceding command, % is a wildcard that matches all database names for the --exclude-databases option. mysqlpump supports several options for including or excluding databases, tables, stored programs, and user definitions. See mysqlpump Object Selection. To reload a dump file, execute the statements that it contains. For example, use the mysql client: mysqlpump [options] > dump.sql mysql < dump.sql The following discussion provides additional mysqlpump usage examples. To see a list of the options mysqlpump supports, issue the command mysqlpump --help. mysqlpump Option Summary mysqlpump supports the following options, which can be specified on the command line or in the [mysqlpump] and [client] groups of an option file. mysqlpump also reads the [mysql_dump] group but this behavior is deprecated. For information about option files used by MySQL programs, see Section 4.2.2.2, “Using Option Files”. mysqlpump Option Descriptions • --help, -? ┌────────────────────┬────────┐ │Command-Line Format │ --help │ └────────────────────┴────────┘ Display a help message and exit. • --add-drop-database ┌────────────────────┬─────────────────────┐ │Command-Line Format │ --add-drop-database │ └────────────────────┴─────────────────────┘ Write a DROP DATABASE statement before each CREATE DATABASE statement. 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-user ┌────────────────────┬─────────────────┐ │Command-Line Format │ --add-drop-user │ └────────────────────┴─────────────────┘ Write a DROP USER statement before each CREATE USER statement. • --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”. This option does not work with parallelism because INSERT statements from different tables can be interleaved and UNLOCK TABLES following the end of the inserts for one table could release locks on tables for which inserts remain. --add-locks and --single-transaction are mutually exclusive. • --all-databases, -A ┌────────────────────┬─────────────────┐ │Command-Line Format │ --all-databases │ └────────────────────┴─────────────────┘ Dump all databases (with certain exceptions noted in mysqlpump Restrictions). This is the default behavior if no other is specified explicitly. --all-databases and --databases are mutually exclusive. 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. • --bind-address=ip_address ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --bind-address=ip_address │ └────────────────────┴───────────────────────────┘ On a computer having multiple network interfaces, use this option to select which interface to use for connecting to the MySQL server. • --character-sets-dir=path ┌────────────────────┬───────────────────────────────┐ │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”. • --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. • --complete-insert ┌────────────────────┬───────────────────┐ │Command-Line Format │ --complete-insert │ └────────────────────┴───────────────────┘ Write complete INSERT statements that include column names. • --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”. • --compress-output=algorithm ┌────────────────────┬─────────────────────────────┐ │Command-Line Format │ --compress-output=algorithm │ ├────────────────────┼─────────────────────────────┤ │Type │ Enumeration │ ├────────────────────┼─────────────────────────────┤ │Valid Values │ LZ4 ZLIB │ └────────────────────┴─────────────────────────────┘ By default, mysqlpump does not compress output. This option specifies output compression using the specified algorithm. Permitted algorithms are LZ4 and ZLIB. To uncompress compressed output, you must have an appropriate utility. If the system commands lz4 and openssl zlib are not available, MySQL distributions include lz4_decompress and zlib_decompress utilities that can be used to decompress mysqlpump output that was compressed using the --compress-output=LZ4 and --compress-output=ZLIB options. For more information, see lz4_decompress(1), and zlib_decompress(1). • --compression-algorithms=value ┌────────────────────┬────────────────────────────────┐ │Command-Line Format │ --compression-algorithms=value │ ├────────────────────┼────────────────────────────────┤ │Type │ Set │ ├────────────────────┼────────────────────────────────┤ │Default Value │ uncompressed │ ├────────────────────┼────────────────────────────────┤ │Valid Values │ zlib zstd uncompressed │ └────────────────────┴────────────────────────────────┘ The permitted compression algorithms for connections to the server. The available algorithms are the same as for the protocol_compression_algorithms system variable. The default value is uncompressed. For more information, see Section 4.2.8, “Connection Compression Control”. • --databases, -B ┌────────────────────┬─────────────┐ │Command-Line Format │ --databases │ └────────────────────┴─────────────┘ Normally, mysqlpump treats the first name argument on the command line as a database name and any following names as table names. With this option, it treats all name arguments as database names. CREATE DATABASE statements are included in the output before each new database. --all-databases and --databases are mutually exclusive. Note See the --add-drop-database description for information about an incompatibility of that option with --databases. • --debug[=debug_options], -# [debug_options] ┌────────────────────┬────────────────────────────┐ │Command-Line Format │ --debug[=debug_options] │ ├────────────────────┼────────────────────────────┤ │Type │ String │ ├────────────────────┼────────────────────────────┤ │Default Value │ d:t:O,/tmp/mysqlpump.trace │ └────────────────────┴────────────────────────────┘ Write a debugging log. A typical debug_options string is d:t:o,file_name. The default is d:t:O,/tmp/mysqlpump.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, -T ┌────────────────────┬──────────────┐ │Command-Line Format │ --debug-info │ ├────────────────────┼──────────────┤ │Type │ Boolean │ ├────────────────────┼──────────────┤ │Default Value │ FALSE │ └────────────────────┴──────────────┘ Print debugging information and memory and CPU usage statistics when the program exits. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. • --default-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”. • --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, mysqlpump uses utf8mb4. • --default-parallelism=N ┌────────────────────┬─────────────────────────┐ │Command-Line Format │ --default-parallelism=N │ ├────────────────────┼─────────────────────────┤ │Type │ Integer │ ├────────────────────┼─────────────────────────┤ │Default Value │ 2 │ └────────────────────┴─────────────────────────┘ The default number of threads for each parallel processing queue. The default is 2. The --parallel-schemas option also affects parallelism and can be used to override the default number of threads. For more information, see mysqlpump Parallel Processing. With --default-parallelism=0 and no --parallel-schemas options, mysqlpump runs as a single-threaded process and creates no queues. With parallelism enabled, it is possible for output from different databases to be interleaved. • --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, mysqlpump normally reads the [client] and [mysqlpump] groups. If this option is given as --defaults-group-suffix=_other, mysqlpump also reads the [client_other] and [mysqlpump_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”. • --defer-table-indexes ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --defer-table-indexes │ ├────────────────────┼───────────────────────┤ │Type │ Boolean │ ├────────────────────┼───────────────────────┤ │Default Value │ TRUE │ └────────────────────┴───────────────────────┘ In the dump output, defer index creation for each table until after its rows have been loaded. This works for all storage engines, but for InnoDB applies only for secondary indexes. This option is enabled by default; use --skip-defer-table-indexes to disable it. • --events ┌────────────────────┬──────────┐ │Command-Line Format │ --events │ ├────────────────────┼──────────┤ │Type │ Boolean │ ├────────────────────┼──────────┤ │Default Value │ TRUE │ └────────────────────┴──────────┘ Include Event Scheduler events for the dumped databases in the output. Event dumping requires the EVENT privileges for those databases. The output generated by using --events contains CREATE EVENT statements to create the events. This option is enabled by default; use --skip-events to disable it. • --exclude-databases=db_list ┌────────────────────┬─────────────────────────────┐ │Command-Line Format │ --exclude-databases=db_list │ ├────────────────────┼─────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────┘ Do not dump the databases in db_list, which is a list of one or more comma-separated database names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection. • --exclude-events=event_list ┌────────────────────┬─────────────────────────────┐ │Command-Line Format │ --exclude-events=event_list │ ├────────────────────┼─────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────┘ Do not dump the databases in event_list, which is a list of one or more comma-separated event names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection. • --exclude-routines=routine_list ┌────────────────────┬─────────────────────────────────┐ │Command-Line Format │ --exclude-routines=routine_list │ ├────────────────────┼─────────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────────┘ Do not dump the events in routine_list, which is a list of one or more comma-separated routine (stored procedure or function) names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection. • --exclude-tables=table_list ┌────────────────────┬─────────────────────────────┐ │Command-Line Format │ --exclude-tables=table_list │ ├────────────────────┼─────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────┘ Do not dump the tables in table_list, which is a list of one or more comma-separated table names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection. • --exclude-triggers=trigger_list ┌────────────────────┬─────────────────────────────────┐ │Command-Line Format │ --exclude-triggers=trigger_list │ ├────────────────────┼─────────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────────┘ Do not dump the triggers in trigger_list, which is a list of one or more comma-separated trigger names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection. • --exclude-users=user_list ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --exclude-users=user_list │ ├────────────────────┼───────────────────────────┤ │Type │ String │ └────────────────────┴───────────────────────────┘ Do not dump the user accounts in user_list, which is a list of one or more comma-separated account names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection. • --extended-insert=N ┌────────────────────┬─────────────────────┐ │Command-Line Format │ --extended-insert=N │ └────────────────────┴─────────────────────┘ 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. The option value indicates the number of rows to include in each INSERT statement. The default is 250. A value of 1 produces one INSERT statement per table row. • --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”. • --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. • --host=host_name, -h host_name ┌────────────────────┬────────┐ │Command-Line Format │ --host │ └────────────────────┴────────┘ Dump data from the MySQL server on the given host. • --include-databases=db_list ┌────────────────────┬─────────────────────────────┐ │Command-Line Format │ --include-databases=db_list │ ├────────────────────┼─────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────┘ Dump the databases in db_list, which is a list of one or more comma-separated database names. The dump includes all objects in the named databases. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection. • --include-events=event_list ┌────────────────────┬─────────────────────────────┐ │Command-Line Format │ --include-events=event_list │ ├────────────────────┼─────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────┘ Dump the events in event_list, which is a list of one or more comma-separated event names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection. • --include-routines=routine_list ┌────────────────────┬─────────────────────────────────┐ │Command-Line Format │ --include-routines=routine_list │ ├────────────────────┼─────────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────────┘ Dump the routines in routine_list, which is a list of one or more comma-separated routine (stored procedure or function) names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection. • --include-tables=table_list ┌────────────────────┬─────────────────────────────┐ │Command-Line Format │ --include-tables=table_list │ ├────────────────────┼─────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────┘ Dump the tables in table_list, which is a list of one or more comma-separated table names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection. • --include-triggers=trigger_list ┌────────────────────┬─────────────────────────────────┐ │Command-Line Format │ --include-triggers=trigger_list │ ├────────────────────┼─────────────────────────────────┤ │Type │ String │ └────────────────────┴─────────────────────────────────┘ Dump the triggers in trigger_list, which is a list of one or more comma-separated trigger names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection. • --include-users=user_list ┌────────────────────┬───────────────────────────┐ │Command-Line Format │ --include-users=user_list │ ├────────────────────┼───────────────────────────┤ │Type │ String │ └────────────────────┴───────────────────────────┘ Dump the user accounts in user_list, which is a list of one or more comma-separated user names. Multiple instances of this option are additive. For more information, see mysqlpump Object Selection. • --insert-ignore ┌────────────────────┬─────────────────┐ │Command-Line Format │ --insert-ignore │ └────────────────────┴─────────────────┘ Write INSERT IGNORE statements rather than INSERT statements. • --log-error-file=file_name ┌────────────────────┬────────────────────────────┐ │Command-Line Format │ --log-error-file=file_name │ ├────────────────────┼────────────────────────────┤ │Type │ File name │ └────────────────────┴────────────────────────────┘ Log warnings and errors by appending them to the named file. If this option is not given, mysqlpump writes warnings and errors to the standard error output. • --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”. • --max-allowed-packet=N ┌────────────────────┬────────────────────────┐ │Command-Line Format │ --max-allowed-packet=N │ ├────────────────────┼────────────────────────┤ │Type │ Numeric │ ├────────────────────┼────────────────────────┤ │Default Value │ 25165824 │ └────────────────────┴────────────────────────┘ The maximum size of the buffer for client/server communication. The default is 24MB, the maximum is 1GB. • --net-buffer-length=N ┌────────────────────┬───────────────────────┐ │Command-Line Format │ --net-buffer-length=N │ ├────────────────────┼───────────────────────┤ │Type │ Numeric │ ├────────────────────┼───────────────────────┤ │Default Value │ 1047552 │ └────────────────────┴───────────────────────┘ The initial size of the buffer for client/server communication. When creating multiple-row INSERT statements (as with the --extended-insert option), mysqlpump creates rows up to N bytes long. If you use this option to increase the value, ensure that the MySQL server net_buffer_length system variable has a value at least this large. • --no-create-db ┌────────────────────┬────────────────┐ │Command-Line Format │ --no-create-db │ └────────────────────┴────────────────┘ Suppress any CREATE DATABASE statements that might otherwise be included in the output. • --no-create-info, -t ┌────────────────────┬──────────────────┐ │Command-Line Format │ --no-create-info │ └────────────────────┴──────────────────┘ Do not write CREATE TABLE statements that create each dumped table. • --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”. • --parallel-schemas=[N:]db_list ┌────────────────────┬────────────────────────────────────┐ │Command-Line Format │ --parallel-schemas=[N:]schema_list │ ├────────────────────┼────────────────────────────────────┤ │Type │ String │ └────────────────────┴────────────────────────────────────┘ Create a queue for processing the databases in db_list, which is a list of one or more comma-separated database names. If N is given, the queue uses N threads. If N is not given, the --default-parallelism option determines the number of queue threads. Multiple instances of this option create multiple queues. mysqlpump also creates a default queue to use for databases not named in any --parallel-schemas option, and for dumping user definitions if command options select them. For more information, see mysqlpump Parallel Processing. • --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, mysqlpump 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 mysqlpump 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, mysqlpump 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 mysqlpump 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. • --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 mysqlpump does not find it. See Section 6.2.17, “Pluggable Authentication”. • --port=port_num, -P port_num ┌────────────────────┬─────────────────┐ │Command-Line Format │ --port=port_num │ ├────────────────────┼─────────────────┤ │Type │ Numeric │ ├────────────────────┼─────────────────┤ │Default Value │ 3306 │ └────────────────────┴─────────────────┘ For TCP/IP connections, the port number to use. • --print-defaults ┌────────────────────┬──────────────────┐ │Command-Line Format │ --print-defaults │ └────────────────────┴──────────────────┘ Print the program name and all options that it gets from option files. For additional information about this and other option-file options, see Section 4.2.2.3, “Command-Line Options that Affect Option-File Handling”. • --protocol={TCP|SOCKET|PIPE|MEMORY} ┌────────────────────┬────────────────────────┐ │Command-Line Format │ --protocol=type │ ├────────────────────┼────────────────────────┤ │Type │ String │ ├────────────────────┼────────────────────────┤ │Default Value │ [see text] │ ├────────────────────┼────────────────────────┤ │Valid Values │ TCP SOCKET PIPE │ │ │ MEMORY │ └────────────────────┴────────────────────────┘ The transport protocol to use for connecting to the server. It is useful when the other connection parameters normally result in use of a protocol other than the one you want. For details on the permissible values, see Section 4.2.7, “Connection Transport Protocols”. • --replace ┌────────────────────┬───────────┐ │Command-Line Format │ --replace │ └────────────────────┴───────────┘ Write REPLACE statements rather than INSERT statements. • --result-file=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. • --routines ┌────────────────────┬────────────┐ │Command-Line Format │ --routines │ ├────────────────────┼────────────┤ │Type │ Boolean │ ├────────────────────┼────────────┤ │Default Value │ TRUE │ └────────────────────┴────────────┘ 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. This option is enabled by default; use --skip-routines to disable it. • --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”. • --set-charset ┌────────────────────┬───────────────┐ │Command-Line Format │ --set-charset │ └────────────────────┴───────────────┘ Write SET NAMES default_character_set to the output. This option is enabled by default. To disable it and suppress the SET NAMES statement, use --skip-set-charset. • --set-gtid-purged=value ┌────────────────────┬─────────────────────────┐ │Command-Line Format │ --set-gtid-purged=value │ ├────────────────────┼─────────────────────────┤ │Type │ Enumeration │ ├────────────────────┼─────────────────────────┤ │Default Value │ AUTO │ ├────────────────────┼─────────────────────────┤ │Valid Values │ OFF ON AUTO │ └────────────────────┴─────────────────────────┘ This option enables control over global transaction ID (GTID) information written to the dump file, by indicating whether to add a SET @@GLOBAL.gtid_purged statement to the output. This option may also cause a statement to be written to the output that disables binary logging while the dump file is being reloaded. The following table shows the permitted option values. The default value is AUTO. ┌──────┬────────────────────────────┐ │Value │ Meaning │ ├──────┼────────────────────────────┤ │OFF │ Add no SET statement to │ │ │ the output. │ ├──────┼────────────────────────────┤ │ON │ Add a SET statement to the │ │ │ output. An error occurs if │ │ │ GTIDs are not enabled on │ │ │ the server. │ ├──────┼────────────────────────────┤ │AUTO │ Add a SET statement to the │ │ │ output if GTIDs are │ │ │ enabled on the server. │ └──────┴────────────────────────────┘ The --set-gtid-purged option has the following effect on binary logging when the dump file is reloaded: • --set-gtid-purged=OFF: SET @@SESSION.SQL_LOG_BIN=0; is not added to the output. • --set-gtid-purged=ON: SET @@SESSION.SQL_LOG_BIN=0; is added to the output. • --set-gtid-purged=AUTO: SET @@SESSION.SQL_LOG_BIN=0; is added to the output if GTIDs are enabled on the server you are backing up (that is, if AUTO evaluates to ON). • --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. 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 mysqlpump to retrieve the table contents to obtain incorrect contents or fail. --add-locks and --single-transaction are mutually exclusive. • --skip-definer ┌────────────────────┬────────────────┐ │Command-Line Format │ --skip-definer │ ├────────────────────┼────────────────┤ │Type │ Boolean │ ├────────────────────┼────────────────┤ │Default Value │ FALSE │ └────────────────────┴────────────────┘ Omit DEFINER and SQL SECURITY clauses from the CREATE statements for views and stored programs. The dump file, when reloaded, creates objects that use the default DEFINER and SQL SECURITY values. See Section 25.6, “Stored Object Access Control”. • --skip-dump-rows, -d ┌────────────────────┬──────────────────┐ │Command-Line Format │ --skip-dump-rows │ ├────────────────────┼──────────────────┤ │Type │ Boolean │ ├────────────────────┼──────────────────┤ │Default Value │ FALSE │ └────────────────────┴──────────────────┘ Do not dump table rows. • --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 (GIPKs) to be excluded from the dump. See Section 13.1.20.11, “Generated Invisible Primary Keys”, for more information about GIPKs and GIPK mode. • --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”. • --triggers ┌────────────────────┬────────────┐ │Command-Line Format │ --triggers │ ├────────────────────┼────────────┤ │Type │ Boolean │ ├────────────────────┼────────────┤ │Default Value │ TRUE │ └────────────────────┴────────────┘ Include triggers for each dumped table in the output. This option is enabled by default; use --skip-triggers to disable it. • --tz-utc ┌────────────────────┬──────────┐ │Command-Line Format │ --tz-utc │ └────────────────────┴──────────┘ This option enables TIMESTAMP columns to be dumped and reloaded between servers in different time zones. mysqlpump 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. This option is enabled by default; use --skip-tz-utc to disable it. • --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. • --users ┌────────────────────┬─────────┐ │Command-Line Format │ --users │ ├────────────────────┼─────────┤ │Type │ Boolean │ ├────────────────────┼─────────┤ │Default Value │ FALSE │ └────────────────────┴─────────┘ Dump user accounts as logical definitions in the form of CREATE USER and GRANT statements. User definitions are stored in the grant tables in the mysql system database. By default, mysqlpump does not include the grant tables in mysql database dumps. To dump the contents of the grant tables as logical definitions, use the --users option and suppress all database dumping: mysqlpump --exclude-databases=% --users • --version, -V ┌────────────────────┬───────────┐ │Command-Line Format │ --version │ └────────────────────┴───────────┘ Display version information and exit. • --watch-progress ┌────────────────────┬──────────────────┐ │Command-Line Format │ --watch-progress │ ├────────────────────┼──────────────────┤ │Type │ Boolean │ ├────────────────────┼──────────────────┤ │Default Value │ TRUE │ └────────────────────┴──────────────────┘ Periodically display a progress indicator that provides information about the completed and total number of tables, rows, and other objects. This option is enabled by default; use --skip-watch-progress to disable it. • --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”. mysqlpump Object Selection mysqlpump has a set of inclusion and exclusion options that enable filtering of several object types and provide flexible control over which objects to dump: • --include-databases and --exclude-databases apply to databases and all objects within them. • --include-tables and --exclude-tables apply to tables. These options also affect triggers associated with tables unless the trigger-specific options are given. • --include-triggers and --exclude-triggers apply to triggers. • --include-routines and --exclude-routines apply to stored procedures and functions. If a routine option matches a stored procedure name, it also matches a stored function of the same name. • --include-events and --exclude-events apply to Event Scheduler events. • --include-users and --exclude-users apply to user accounts. Any inclusion or exclusion option may be given multiple times. The effect is additive. Order of these options does not matter. The value of each inclusion and exclusion option is a list of comma-separated names of the appropriate object type. For example: --exclude-databases=test,world --include-tables=customer,invoice Wildcard characters are permitted in the object names: • % matches any sequence of zero or more characters. • _ matches any single character. For example, --include-tables=t%,__tmp matches all table names that begin with t and all five-character table names that end with tmp. For users, a name specified without a host part is interpreted with an implied host of %. For example, u1 and u1@% are equivalent. This is the same equivalence that applies in MySQL generally (see Section 6.2.4, “Specifying Account Names”). Inclusion and exclusion options interact as follows: • By default, with no inclusion or exclusion options, mysqlpump dumps all databases (with certain exceptions noted in mysqlpump Restrictions). • If inclusion options are given in the absence of exclusion options, only the objects named as included are dumped. • If exclusion options are given in the absence of inclusion options, all objects are dumped except those named as excluded. • If inclusion and exclusion options are given, all objects named as excluded and not named as included are not dumped. All other objects are dumped. If multiple databases are being dumped, it is possible to name tables, triggers, and routines in a specific database by qualifying the object names with the database name. The following command dumps databases db1 and db2, but excludes tables db1.t1 and db2.t2: mysqlpump --include-databases=db1,db2 --exclude-tables=db1.t1,db2.t2 The following options provide alternative ways to specify which databases to dump: • The --all-databases option dumps all databases (with certain exceptions noted in mysqlpump Restrictions). It is equivalent to specifying no object options at all (the default mysqlpump action is to dump everything). --include-databases=% is similar to --all-databases, but selects all databases for dumping, even those that are exceptions for --all-databases. • The --databases option causes mysqlpump to treat all name arguments as names of databases to dump. It is equivalent to an --include-databases option that names the same databases. mysqlpump Parallel Processing mysqlpump can use parallelism to achieve concurrent processing. You can select concurrency between databases (to dump multiple databases simultaneously) and within databases (to dump multiple objects from a given database simultaneously). By default, mysqlpump sets up one queue with two threads. You can create additional queues and control the number of threads assigned to each one, including the default queue: • --default-parallelism=N specifies the default number of threads used for each queue. In the absence of this option, N is 2. The default queue always uses the default number of threads. Additional queues use the default number of threads unless you specify otherwise. • --parallel-schemas=[N:]db_list sets up a processing queue for dumping the databases named in db_list and optionally specifies how many threads the queue uses. db_list is a list of comma-separated database names. If the option argument begins with N:, the queue uses N threads. Otherwise, the --default-parallelism option determines the number of queue threads. Multiple instances of the --parallel-schemas option create multiple queues. Names in the database list are permitted to contain the same % and _ wildcard characters supported for filtering options (see mysqlpump Object Selection). mysqlpump uses the default queue for processing any databases not named explicitly with a --parallel-schemas option, and for dumping user definitions if command options select them. In general, with multiple queues, mysqlpump uses parallelism between the sets of databases processed by the queues, to dump multiple databases simultaneously. For a queue that uses multiple threads, mysqlpump uses parallelism within databases, to dump multiple objects from a given database simultaneously. Exceptions can occur; for example, mysqlpump may block queues while it obtains from the server lists of objects in databases. With parallelism enabled, it is possible for output from different databases to be interleaved. For example, INSERT statements from multiple tables dumped in parallel can be interleaved; the statements are not written in any particular order. This does not affect reloading because output statements qualify object names with database names or are preceded by USE statements as required. The granularity for parallelism is a single database object. For example, a single table cannot be dumped in parallel using multiple threads. Examples: mysqlpump --parallel-schemas=db1,db2 --parallel-schemas=db3 mysqlpump sets up a queue to process db1 and db2, another queue to process db3, and a default queue to process all other databases. All queues use two threads. mysqlpump --parallel-schemas=db1,db2 --parallel-schemas=db3 --default-parallelism=4 This is the same as the previous example except that all queues use four threads. mysqlpump --parallel-schemas=5:db1,db2 --parallel-schemas=3:db3 The queue for db1 and db2 uses five threads, the queue for db3 uses three threads, and the default queue uses the default of two threads. As a special case, with --default-parallelism=0 and no --parallel-schemas options, mysqlpump runs as a single-threaded process and creates no queues. mysqlpump Restrictions mysqlpump does not dump the performance_schema, ndbinfo, 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 or --include-databases option. mysqlpump does not dump the INFORMATION_SCHEMA schema. mysqlpump does not dump InnoDB CREATE TABLESPACE statements. mysqlpump dumps user accounts in logical form using CREATE USER and GRANT statements (for example, when you use the --include-users or --users option). For this reason, dumps of the mysql system database do not by default include the grant tables that contain user definitions: user, db, tables_priv, columns_priv, procs_priv, or proxies_priv. To dump any of the grant tables, name the mysql database followed by the table names: mysqlpump mysql user db ... 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 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 MYSQLPUMP(1)
mysqlpump - a database backup program
mysqlpump [options] [db_name [tbl_name ...]]
null
null
xml2-config
xml2-config is a tool that is used to determine the compile and linker flags that should be used to compile and link programs that use GNOME- XML.
xml2-config - script to get information about the installed version of GNOME-XML
xml2-config [--prefix[=DIR]] [--libs] [--cflags] [--version] [--help]
xml2-config accepts the following options: --version Print the currently installed version of GNOME-XML on the standard output. --libs Print the linker flags that are necessary to link a GNOME-XML program. Add --dynamic after --libs to print only shared library linking information. --cflags Print the compiler flags that are necessary to compile a GNOME- XML program. --prefix=PREFIX If specified, use PREFIX instead of the installation prefix that GNOME-XML was built with when computing the output for the --cflags and --libs options. This option must be specified before any --libs or --cflags options. AUTHOR This manual page was written by Fredrik Hallenberg <hallon@lysator.liu.se>, for the Debian GNU/linux system (but may be used by others). Version 3 July 1999 GNOME-XML(1)
null
python3.1
null
null
null
null
null
djpeg
djpeg decompresses the named JPEG file, or the standard input if no file is named, and produces an image file on the standard output. PBMPLUS (PPM/PGM), BMP, GIF, or Targa output format can be selected.
djpeg - decompress a JPEG file to an image file
djpeg [ options ] [ filename ]
All switch names may be abbreviated; for example, -grayscale may be written -gray or -gr. Most of the "basic" switches can be abbreviated to as little as one letter. Upper and lower case are equivalent (thus -BMP is the same as -bmp). British spellings are also accepted (e.g., -greyscale), though for brevity these are not mentioned below. The basic switches are: -colors N Reduce image to at most N colors. This reduces the number of colors used in the output image, so that it can be displayed on a colormapped display or stored in a colormapped file format. For example, if you have an 8-bit display, you'd need to reduce to 256 or fewer colors. -quantize N Same as -colors. -colors is the recommended name, -quantize is provided only for backwards compatibility. -fast Select recommended processing options for fast, low quality output. (The default options are chosen for highest quality output.) Currently, this is equivalent to -dct fast -nosmooth -onepass -dither ordered. -grayscale Force grayscale output even if JPEG file is color. Useful for viewing on monochrome displays; also, djpeg runs noticeably faster in this mode. -rgb Force RGB output even if JPEG file is grayscale. -scale M/N Scale the output image by a factor M/N. Currently the scale factor must be M/8, where M is an integer between 1 and 16 inclusive, or any reduced fraction thereof (such as 1/2, 3/4, etc.) Scaling is handy if the image is larger than your screen; also, djpeg runs much faster when scaling down the output. -bmp Select BMP output format (Windows flavor). 8-bit colormapped format is emitted if -colors or -grayscale is specified, or if the JPEG file is grayscale; otherwise, 24-bit full-color format is emitted. -gif Select GIF output format (LZW-compressed). Since GIF does not support more than 256 colors, -colors 256 is assumed (unless you specify a smaller number of colors). If you specify -fast, the default number of colors is 216. -gif0 Select GIF output format (uncompressed). Since GIF does not support more than 256 colors, -colors 256 is assumed (unless you specify a smaller number of colors). If you specify -fast, the default number of colors is 216. -os2 Select BMP output format (OS/2 1.x flavor). 8-bit colormapped format is emitted if -colors or -grayscale is specified, or if the JPEG file is grayscale; otherwise, 24-bit full-color format is emitted. -pnm Select PBMPLUS (PPM/PGM) output format (this is the default format). PGM is emitted if the JPEG file is grayscale or if -grayscale is specified; otherwise PPM is emitted. -targa Select Targa output format. Grayscale format is emitted if the JPEG file is grayscale or if -grayscale is specified; otherwise, colormapped format is emitted if -colors is specified; otherwise, 24-bit full-color format is emitted. Switches for advanced users: -dct int Use accurate integer DCT method (default). -dct fast Use less accurate integer DCT method [legacy feature]. When the Independent JPEG Group's software was first released in 1991, the decompression time for a 1-megapixel JPEG image on a mainstream PC was measured in minutes. Thus, the fast integer DCT algorithm provided noticeable performance benefits. On modern CPUs running libjpeg-turbo, however, the decompression time for a 1-megapixel JPEG image is measured in milliseconds, and thus the performance benefits of the fast algorithm are much less noticeable. On modern x86/x86-64 CPUs that support AVX2 instructions, the fast and int methods have similar performance. On other types of CPUs, the fast method is generally about 5-15% faster than the int method. If the JPEG image was compressed using a quality level of 85 or below, then there should be little or no perceptible quality difference between the two algorithms. When decompressing images that were compressed using quality levels above 85, however, the difference between the fast and int methods becomes more pronounced. With images compressed using quality=97, for instance, the fast method incurs generally about a 4-6 dB loss in PSNR relative to the int method, but this can be larger for some images. If you can avoid it, do not use the fast method when decompressing images that were compressed using quality levels above 97. The algorithm often degenerates for such images and can actually produce a more lossy output image than if the JPEG image had been compressed using lower quality levels. -dct float Use floating-point DCT method [legacy feature]. The float method does not produce significantly more accurate results than the int method, and it is much slower. The float method may also give different results on different machines due to varying roundoff behavior, whereas the integer methods should give the same results on all machines. -dither fs Use Floyd-Steinberg dithering in color quantization. -dither ordered Use ordered dithering in color quantization. -dither none Do not use dithering in color quantization. By default, Floyd- Steinberg dithering is applied when quantizing colors; this is slow but usually produces the best results. Ordered dither is a compromise between speed and quality; no dithering is fast but usually looks awful. Note that these switches have no effect unless color quantization is being done. Ordered dither is only available in -onepass mode. -icc file Extract ICC color management profile to the specified file. -map file Quantize to the colors used in the specified image file. This is useful for producing multiple files with identical color maps, or for forcing a predefined set of colors to be used. The file must be a GIF or PPM file. This option overrides -colors and -onepass. -nosmooth Use a faster, lower-quality upsampling routine. -onepass Use one-pass instead of two-pass color quantization. The one- pass method is faster and needs less memory, but it produces a lower-quality image. -onepass is ignored unless you also say -colors N. Also, the one-pass method is always used for grayscale output (the two-pass method is no improvement then). -maxmemory N Set limit for amount of memory to use in processing large images. Value is in thousands of bytes, or millions of bytes if "M" is attached to the number. For example, -max 4m selects 4000000 bytes. If more space is needed, an error will occur. -maxscans N Abort if the JPEG image contains more than N scans. This feature demonstrates a method by which applications can guard against denial-of-service attacks instigated by specially- crafted malformed JPEG images containing numerous scans with missing image data or image data consisting only of "EOB runs" (a feature of progressive JPEG images that allows potentially hundreds of thousands of adjoining zero-value pixels to be represented using only a few bytes.) Attempting to decompress such malformed JPEG images can cause excessive CPU activity, since the decompressor must fully process each scan (even if the scan is corrupt) before it can proceed to the next scan. -outfile name Send output image to the named file, not to standard output. -memsrc Load input file into memory before decompressing. This feature was implemented mainly as a way of testing the in-memory source manager (jpeg_mem_src().) -report Report decompression progress. -skip Y0,Y1 Decompress all rows of the JPEG image except those between Y0 and Y1 (inclusive.) Note that if decompression scaling is being used, then Y0 and Y1 are relative to the scaled image dimensions. -crop WxH+X+Y Decompress only a rectangular subregion of the image, starting at point X,Y with width W and height H. If necessary, X will be shifted left to the nearest iMCU boundary, and the width will be increased accordingly. Note that if decompression scaling is being used, then X, Y, W, and H are relative to the scaled image dimensions. Currently this option only works with the PBMPLUS (PPM/PGM), GIF, and Targa output formats. -strict Treat all warnings as fatal. This feature also demonstrates a method by which applications can guard against attacks instigated by specially-crafted malformed JPEG images. Enabling this option will cause the decompressor to abort if the JPEG image contains incomplete or corrupt image data. -verbose Enable debug printout. More -v's give more output. Also, version information is printed at startup. -debug Same as -verbose. -version Print version information and exit.
This example decompresses the JPEG file foo.jpg, quantizes it to 256 colors, and saves the output in 8-bit BMP format in foo.bmp: djpeg -colors 256 -bmp foo.jpg > foo.bmp HINTS To get a quick preview of an image, use the -grayscale and/or -scale switches. -grayscale -scale 1/8 is the fastest case. Several options are available that trade off image quality to gain speed. -fast turns on the recommended settings. -dct fast and/or -nosmooth gain speed at a small sacrifice in quality. When producing a color-quantized image, -onepass -dither ordered is fast but much lower quality than the default behavior. -dither none may give acceptable results in two-pass mode, but is seldom tolerable in one-pass mode. ENVIRONMENT JPEGMEM If this environment variable is set, its value is the default memory limit. The value is specified as described for the -maxmemory switch. JPEGMEM overrides the default value specified when the program was compiled, and itself is overridden by an explicit -maxmemory. SEE ALSO cjpeg(1), jpegtran(1), rdjpgcom(1), wrjpgcom(1) ppm(5), pgm(5) Wallace, Gregory K. "The JPEG Still Picture Compression Standard", Communications of the ACM, April 1991 (vol. 34, no. 4), pp. 30-44. AUTHOR Independent JPEG Group This file was modified by The libjpeg-turbo Project to include only information relevant to libjpeg-turbo, to wordsmith certain sections, and to describe features not present in libjpeg. 4 November 2020 DJPEG(1)
gst-discoverer-1.0
null
null
null
null
null
zopfli
null
null
null
null
null
deep
null
null
null
null
null
segedit
segedit extracts or replaces named sections from the input_file. When extracting sections, segedit will write the contents of each requested section into data_file. When replacing sections, segedit will write a new output_file formed from the input_file and the requested replacement section content from data_file. The segment and section names are the same as those given to ld(1) with the -sectcreate option. The segment and section names of an object file can be examined with the -l option to otool(1). Only sections in segments that have no relocation to or from them (i.e., segments marked with the SG_NORELOC flag) can be replaced but all sections can be extracted. The options to segedit(1): -extract seg_name sect_name data_file Extracts each section specified by the segment and section names and places the contents in the specified data_file. If the output file is `-' the section contents will be written to the standard output. -replace seg_name sect_name data_file Replaces each section specified by the segment and section names and takes the new section content from the specified data_file. The -output output_file option must also be specified. The resulting size of the section will be rounded to a multiple of 4 bytes and padded with zero bytes if necessary. -output output_file Specifies the new file to create when replacing sections. SEE ALSO ld(1), otool(1), lipo(1) LIMITATIONS Only Mach-O format files that are laid out in a contiguous address space and with their segments in increasing address order can have their segments replaced by this program. This layout is what ld(1) produces by default. Only sections in segments that have no relocation to or from them (i.e., segments marked with the SG_NORELOC flag) can be replaced. segedit will not extract or replace sections from universal files. If necessary, use lipo(1) to extract the desired Mach-O files from a universal file before running segedit. Apple, Inc. June 25, 2018 SEGEDIT(1)
segedit - extract and replace sections from object files
segedit input_file [-extract seg_name sect_name data_file] ... segedit input_file [-replace seg_name sect_name data_file] ... -output output_file
null
null
jupyter-labhub
null
null
null
null
null
xmlpatternsvalidator
null
null
null
null
null
arm64-apple-darwin20.0.0-seg_addr_table
seg_addr_table re-lays out, updates or checks a segment address table. If it can do its operation with out problems seg_addr_table(l) exits with zero status. Else it exits with a non-zero status and prints an error message about the problem. The Apple Build and Integration team uses the segment address table in /AppleInternal/Developer/seg_addr_table to set the preferred addresses of dynamic libraries. See the ld(1) man page under the -seg_addr_table option and its environment variable LD_SEG_ADDR_TABLE. The format of segment address table are lines of three forms. The entries in the table are lines containing either a single hex address and an install name or two hex addresses and an install name. In the first form the single hex address is used for ``flat'' libraries and is the -seg1addr . In the second form is used for ``split'' libraries and the first address is the -segs_read_only_addr address and the second is the -segs_read_write_addr address. The third form is used for fixed regions that are not to be allocated. They have a hex addresses and a hex size and the literal string <<< Fixed address and size not to assign >>> . Lines starting with the # character are treated as comments. The output table of seg_addr_table(l) also contains two special entries. One for the next addresses to assign ``flat'' libraries and one for the next addresses to assign to ``split'' libraries. Comments are generated before these entries stating they must not be removed. The following option must be specified when using the -relayout or -update options: -o output_file Write the new segment address table to output_file. One of the following operations must be specified: -relayout This causes the entire table to be re-laied out and all dynamic libraries to be assigned addresses. The address are assigned in the order specified and the space given to each is based on the libraries virtual address sizes. -update Only entries with zero address values are assigned addresses. The address assignment is based on the special entries in the table for the next addresses to assign. -update_overlaps Detects overlaps in the table and reassigns the lower of the two addresses. The address assignment is based on the special entries in the table for the next addresses to assign. This action is similar to detecting overlaps with -checkonly, setting the overlapping library to 0x00000000 and running with -update. -relayout_nonsplit Similar to relayout except it only causes all the non split libraries to re-laied out and all non-split dynamic libraries to be assigned addresses. The addresses are assigned in order specified and the space given to each is based on the libraries virtual address sizes. -checkonly This option only checks the entries in the table for overlaps. The following options may be specified with any of the operations: -seg_addr_table filename This is the input segment address table. If not specified the default is /AppleInternal/Developer/seg_addr_table. -release release_name For each ``flat'' entry in the table try finding and using the dynamic library from the $(SYMROOT) from the specified release_name to base the size of the library on. If the file in not found in the $(SYMROOT) or it is a ``split'' entry then use the dynamic library in the $(DSTROOT) from the specified release_name to base the size of the library on. Without this option the library with the install name on the machine running is used. With this option the library with the install name on the machine running is never used. The following options may be specified with the -relayout operation: -seg1addr addr Specifies the starting address to layout ``flat'' libraries. addr is a hexadecimal number and should be a multiple of the target pagesize. The default if not specified is 0x41300000 when the environment variable MACOSX_DEPLOYMENT_TARGET is 10.1 or not set and allocations are into increasing addresses. When MACOSX_DEPLOYMENT_TARGET is 10.2 or greater the default is 0x7ffc0000 and allocations are into decreasing addresses. -allocate_flat direction Specifies which direction to allocate flat addresses into. The argument direction can be either increasing or decreasing. The default if not specified is increasing when the environment variable MACOSX_DEPLOYMENT_TARGET is 10.1 or not set and when MACOSX_DEPLOYMENT_TARGET is 10.2 or greater the default is decreasing. -segs_read_only_addr addr Specifies the starting address to layout the read-only segments of ``split'' libraries. addr is a hexadecimal number and should be a multiple of the target pagesize. The default if not specified is 0x70000000 when the environment variable MACOSX_DEPLOYMENT_TARGET is 10.1 or not set and when MACOSX_DEPLOYMENT_TARGET is 10.2 or greater the default is 0x90000000. -segs_read_write_addr addr Specifies the starting address to layout the read-write segments of ``split'' libraries. addr is a hexadecimal number and should be a multiple of the target pagesize. The default if not specified is 0x80000000 when the environment variable MACOSX_DEPLOYMENT_TARGET is 10.1 or not set and when MACOSX_DEPLOYMENT_TARGET is 10.2 or greater the default is 0xa0000000. The following options may be specified with any operation: -disablewarnings This option disables a small number of warnings which is useful for B&I when running the -update operation and there are entries in the table that have problems. These entries are then removed from the table when creating the output. -arch arch_type Specifies the architecture, arch_type, in the files to use for the sizes. More than one -arch arch_type can be specified. The default is -arch all which uses all architectures in the file. See arch(3) for the currently known arch_types. SEE ALSO ld(1) Apple Computer, Inc. May 24, 2002 SEG_ADDR_TABLE(l)
seg_addr_table - re-layout, update or check a segment address table
seg_addr_table [operation] [options] [-o output_file]
null
null
jupyter-server
null
null
null
null
null
pydocstyle
null
null
null
null
null
msgmerge
Merges two Uniforum style .po files together. The def.po file is an existing PO file with translations which will be taken over to the newly created file as long as they still match; comments will be preserved, but extracted comments and file positions will be discarded. The ref.pot file is the last created PO file with up-to-date source references but old translations, or a PO Template file (generally created by xgettext); any translations or comments in the file will be discarded, however dot comments and file positions will be preserved. Where an exact match cannot be found, fuzzy matching is used to produce better results. Mandatory arguments to long options are mandatory for short options too. Input file location: def.po translations referring to old sources ref.pot references to new sources -D, --directory=DIRECTORY add DIRECTORY to list for input files search -C, --compendium=FILE additional library of message translations, may be specified more than once Operation mode: -U, --update update def.po, do nothing if def.po already up to date 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 -. Output file location in update mode: The result is written back to def.po. --backup=CONTROL make a backup of def.po --suffix=SUFFIX override the usual backup suffix The version control method may be selected via the --backup option or through the VERSION_CONTROL environment variable. Here are the values: none, off never make backups (even if --backup is given) numbered, t make numbered backups existing, nil numbered if numbered backups exist, simple otherwise simple, never always make simple backups The backup suffix is '~', unless set with --suffix or the SIMPLE_BACKUP_SUFFIX environment variable. Operation modifiers: -m, --multi-domain apply ref.pot to each of the domains in def.po --for-msgfmt produce output for 'msgfmt', not for a translator -N, --no-fuzzy-matching do not use fuzzy matching --previous keep previous msgids of translated messages Input file syntax: -P, --properties-input input files are in Java .properties syntax --stringtable-input input files are in NeXTstep/GNUstep .strings syntax Output details: --lang=CATALOGNAME set 'Language' field in the header entry --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 indented output style --no-location suppress '#: filename:line' lines -n, --add-location preserve '#: filename:line' lines (default) --strict strict Uniforum output style -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 -v, --verbose increase verbosity level -q, --quiet, --silent suppress progress indicators AUTHOR Written by Peter Miller. 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 msgmerge is maintained as a Texinfo manual. If the info and msgmerge programs are properly installed at your site, the command info msgmerge should give you access to the complete manual. GNU gettext-tools 0.22.5 February 2024 MSGMERGE(1)
msgmerge - merge message catalog and template
msgmerge [OPTION] def.po ref.pot
null
null
tiffcrop
null
null
null
null
null
isort
null
null
null
null
null