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 |
|---|---|---|---|---|---|
conda-verify
| null | null | null | null | null |
cpuinfo
| null | null | null | null | null |
mysqladmin
|
mysqladmin is a client for performing administrative operations. You can use it to check the server's configuration and current status, to create and drop databases, and more. Invoke mysqladmin like this: mysqladmin [options] command [command-arg] [command [command-arg]] ... mysqladmin supports the following commands. Some of the commands take an argument following the command name. β’ create db_name Create a new database named db_name. β’ debug Prior to MySQL 8.0.20, tell the server to write debug information to the error log. The connected user must have the SUPER privilege. Format and content of this information is subject to change. This includes information about the Event Scheduler. See Section 25.4.5, βEvent Scheduler Statusβ. β’ drop db_name Delete the database named db_name and all its tables. β’ extended-status Display the server status variables and their values. β’ flush-hosts Flush all information in the host cache. See Section 5.1.12.3, βDNS Lookups and the Host Cacheβ. β’ flush-logs [log_type ...] Flush all logs. The mysqladmin flush-logs command permits optional log types to be given, to specify which logs to flush. Following the flush-logs command, you can provide a space-separated list of one or more of the following log types: binary, engine, error, general, relay, slow. These correspond to the log types that can be specified for the FLUSH LOGS SQL statement. β’ flush-privileges Reload the grant tables (same as reload). β’ flush-status Clear status variables. β’ flush-tables Flush all tables. β’ kill id,id,... Kill server threads. If multiple thread ID values are given, there must be no spaces in the list. To kill threads belonging to other users, the connected user must have the CONNECTION_ADMIN privilege (or the deprecated SUPER privilege). β’ password new_password Set a new password. This changes the password to new_password for the account that you use with mysqladmin for connecting to the server. Thus, the next time you invoke mysqladmin (or any other client program) using the same account, you must specify the new password. Warning Setting a password using mysqladmin should be considered insecure. On some systems, your password becomes visible to system status programs such as ps that may be invoked by other users to display command lines. MySQL clients typically overwrite the command-line password argument with zeros during their initialization sequence. However, there is still a brief interval during which the value is visible. Also, on some systems this overwriting strategy is ineffective and the password remains visible to ps. (SystemV Unix systems and perhaps others are subject to this problem.) If the new_password value contains spaces or other characters that are special to your command interpreter, you need to enclose it within quotation marks. On Windows, be sure to use double quotation marks rather than single quotation marks; single quotation marks are not stripped from the password, but rather are interpreted as part of the password. For example: mysqladmin password "my new password" The new password can be omitted following the password command. In this case, mysqladmin prompts for the password value, which enables you to avoid specifying the password on the command line. Omitting the password value should be done only if password is the final command on the mysqladmin command line. Otherwise, the next argument is taken as the password. Caution Do not use this command used if the server was started with the --skip-grant-tables option. No password change is applied. This is true even if you precede the password command with flush-privileges on the same command line to re-enable the grant tables because the flush operation occurs after you connect. However, you can use mysqladmin flush-privileges to re-enable the grant table and then use a separate mysqladmin password command to change the password. β’ ping Check whether the server is available. The return status from mysqladmin is 0 if the server is running, 1 if it is not. This is 0 even in case of an error such as Access denied, because this means that the server is running but refused the connection, which is different from the server not running. β’ processlist Show a list of active server threads. This is like the output of the SHOW PROCESSLIST statement. If the --verbose option is given, the output is like that of SHOW FULL PROCESSLIST. (See Section 13.7.7.31, βSHOW PROCESSLIST Statementβ.) β’ reload Reload the grant tables. β’ refresh Flush all tables and close and open log files. β’ shutdown Stop the server. β’ start-replica Start replication on a replica server. β’ start-slave This is a deprecated alias for start-replica. β’ status Display a short server status message. β’ stop-replica Stop replication on a replica server. β’ stop-slave This is a deprecated alias for stop-replica. β’ variables Display the server system variables and their values. β’ version Display version information from the server. All commands can be shortened to any unique prefix. For example: $> mysqladmin proc stat +----+-------+-----------+----+---------+------+-------+------------------+ | Id | User | Host | db | Command | Time | State | Info | +----+-------+-----------+----+---------+------+-------+------------------+ | 51 | jones | localhost | | Query | 0 | | show processlist | +----+-------+-----------+----+---------+------+-------+------------------+ Uptime: 1473624 Threads: 1 Questions: 39487 Slow queries: 0 Opens: 541 Flush tables: 1 Open tables: 19 Queries per second avg: 0.0268 The mysqladmin status command result displays the following values: β’ Uptime The number of seconds the MySQL server has been running. β’ Threads The number of active threads (clients). β’ Questions The number of questions (queries) from clients since the server was started. β’ Slow queries The number of queries that have taken more than long_query_time seconds. See Section 5.4.5, βThe Slow Query Logβ. β’ Opens The number of tables the server has opened. β’ Flush tables The number of flush-*, refresh, and reload commands the server has executed. β’ Open tables The number of tables that currently are open. If you execute mysqladmin shutdown when connecting to a local server using a Unix socket file, mysqladmin waits until the server's process ID file has been removed, to ensure that the server has stopped properly. mysqladmin supports the following options, which can be specified on the command line or in the [mysqladmin] 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β. β’ --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β. β’ --connect-timeout=value ββββββββββββββββββββββ¬ββββββββββββββββββββββββββ βCommand-Line Format β --connect-timeout=value β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βDefault Value β 43200 β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββ The maximum number of seconds before connection timeout. The default value is 43200 (12 hours). β’ --count=N, -c N ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --count=# β ββββββββββββββββββββββ΄ββββββββββββ The number of iterations to make for repeated command execution if the --sleep option is given. β’ --debug[=debug_options], -# [debug_options] ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββ βCommand-Line Format β --debug[=debug_options] β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββ€ βDefault Value β d:t:o,/tmp/mysqladmin.trace β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββ Write a debugging log. A typical debug_options string is d:t:o,file_name. The default is d:t:o,/tmp/mysqladmin.trace. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. β’ --debug-check ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --debug-check β ββββββββββββββββββββββΌββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄ββββββββββββββββ Print some debugging information when the program exits. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. β’ --debug-info ββββββββββββββββββββββ¬βββββββββββββββ βCommand-Line Format β --debug-info β ββββββββββββββββββββββΌβββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄βββββββββββββββ Print debugging information and memory and CPU usage statistics when the program exits. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. β’ --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 β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ 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, mysqladmin normally reads the [client] and [mysqladmin] groups. If this option is given as --defaults-group-suffix=_other, mysqladmin also reads the [client_other] and [mysqladmin_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β. β’ --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β.) β’ --force, -f ββββββββββββββββββββββ¬ββββββββββ βCommand-Line Format β --force β ββββββββββββββββββββββ΄ββββββββββ Do not ask for confirmation for the drop db_name command. With multiple commands, continue even if an 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β. β’ --no-beep, -b ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --no-beep β ββββββββββββββββββββββ΄ββββββββββββ Suppress the warning beep that is emitted by default for errors such as a failure to connect to the server. β’ --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, mysqladmin 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 mysqladmin 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, mysql 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 mysqladmin 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 mysqladmin 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β. β’ --relative, -r ββββββββββββββββββββββ¬βββββββββββββ βCommand-Line Format β --relative β ββββββββββββββββββββββ΄βββββββββββββ Show the difference between the current and previous values when used with the --sleep option. This option works only with the extended-status command. β’ --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. β’ --show-warnings ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --show-warnings β ββββββββββββββββββββββ΄ββββββββββββββββββ Show warnings resulting from execution of statements sent to the server. β’ --shutdown-timeout=value ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββ βCommand-Line Format β --shutdown-timeout=seconds β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βDefault Value β 3600 β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββ The maximum number of seconds to wait for server shutdown. The default value is 3600 (1 hour). β’ --silent, -s ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --silent β ββββββββββββββββββββββ΄βββββββββββ Exit silently if a connection to the server cannot be established. β’ --sleep=delay, -i delay ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --sleep=delay β ββββββββββββββββββββββ΄ββββββββββββββββ Execute commands repeatedly, sleeping for delay seconds in between. The --count option determines the number of iterations. If --count is not given, mysqladmin executes commands indefinitely until interrupted. β’ --socket=path, -S path ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ βCommand-Line Format β --socket={file_name|pipe_name} β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ For connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use. On Windows, this option applies only if the server was started with the named_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by the named_pipe_full_access_group system variable. β’ --ssl* Options that begin with --ssl specify whether to connect to the server using encryption and indicate where to find SSL keys and certificates. See the section called βCommand Options for Encrypted Connectionsβ. β’ --ssl-fips-mode={OFF|ON|STRICT} ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββ βCommand-Line Format β --ssl-fips-mode={OFF|ON|STRICT} β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βType β Enumeration β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βDefault Value β OFF β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βValid Values β OFF ON STRICT β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββ Controls whether to enable FIPS mode on the client side. The --ssl-fips-mode option differs from other --ssl-xxx options in that it is not used to establish encrypted connections, but rather to affect which cryptographic operations to permit. See Section 6.8, βFIPS Supportβ. These --ssl-fips-mode values are permitted: β’ OFF: Disable FIPS mode. β’ ON: Enable FIPS mode. β’ STRICT: Enable βstrictβ FIPS mode. Note If the OpenSSL FIPS Object Module is not available, the only permitted value for --ssl-fips-mode is OFF. In this case, setting --ssl-fips-mode to ON or STRICT causes the client to produce a warning at startup and to operate in non-FIPS mode. This option is deprecated. Expect it to be removed in a future version of MySQL. β’ --tls-ciphersuites=ciphersuite_list ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --tls-ciphersuites=ciphersuite_list β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββ The permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a list of one or more colon-separated ciphersuite names. The ciphersuites that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, βEncrypted Connection TLS Protocols and Ciphersβ. β’ --tls-sni-servername=server_name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββ βCommand-Line Format β --tls-sni-servername=server_name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββ When specified, the name is passed to the libmysqlclient C API library using the MYSQL_OPT_TLS_SNI_SERVERNAME option of mysql_options(). The server name is not case-sensitive. To show which server name the client specified for the current session, if any, check the Tls_sni_server_name status variable. Server Name Indication (SNI) is an extension to the TLS protocol (OpenSSL must be compiled using TLS extensions for this option to function). The MySQL implementation of SNI represents the client-side only. β’ --tls-version=protocol_list ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββ βCommand-Line Format β --tls-version=protocol_list β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββ€ βDefault Value β TLSv1,TLSv1.1,TLSv1.2,TLSv1.3 β β β (OpenSSL 1.1.1 or higher) β β β TLSv1,TLSv1.1,TLSv1.2 β β β (otherwise) β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββ The permissible TLS protocols for encrypted connections. The value is a list of one or more comma-separated protocol names. The protocols that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, βEncrypted Connection TLS Protocols and Ciphersβ. β’ --user=user_name, -u user_name ββββββββββββββββββββββ¬ββββββββββββββββββββ βCommand-Line Format β --user=user_name, β ββββββββββββββββββββββΌββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββ The user name of the MySQL account to use for connecting to the server. If you are using the Rewriter plugin, grant this user the SKIP_QUERY_REWRITE privilege. β’ --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. β’ --vertical, -E ββββββββββββββββββββββ¬βββββββββββββ βCommand-Line Format β --vertical β ββββββββββββββββββββββ΄βββββββββββββ Print output vertically. This is similar to --relative, but prints output vertically. β’ --wait[=count], -w[count] ββββββββββββββββββββββ¬βββββββββ βCommand-Line Format β --wait β ββββββββββββββββββββββ΄βββββββββ If the connection cannot be established, wait and retry instead of aborting. If a count value is given, it indicates the number of times to retry. The default is one time. β’ --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 MYSQLADMIN(1)
|
mysqladmin - a MySQL server administration program
|
mysqladmin [options] command [command-options] [command [command-options]] ...
| null | null |
ptdump
| null | null | null | null | null |
kadmin
|
kadmin and kadmin.local are command-line interfaces to the Kerberos V5 administration system. They provide nearly identical functionalities; the difference is that kadmin.local directly accesses the KDC database, while kadmin performs operations using kadmind(8). Except as explicitly noted otherwise, this man page will use "kadmin" to refer to both versions. kadmin provides for the maintenance of Kerberos principals, password policies, and service key tables (keytabs). The remote kadmin client uses Kerberos to authenticate to kadmind using the service principal kadmin/admin or kadmin/ADMINHOST (where ADMINHOST is the fully-qualified hostname of the admin server). If the credentials cache contains a ticket for one of these principals, and the -c credentials_cache option is specified, that ticket is used to authenticate to kadmind. Otherwise, the -p and -k options are used to specify the client Kerberos principal name used to authenticate. Once kadmin has determined the principal name, it requests a service ticket from the KDC, and uses that service ticket to authenticate to kadmind. Since kadmin.local directly accesses the KDC database, it usually must be run directly on the primary KDC with sufficient permissions to read the KDC database. If the KDC database uses the LDAP database module, kadmin.local can be run on any host which can access the LDAP server.
|
kadmin - Kerberos V5 database administration program
|
kadmin [-O|-N] [-r realm] [-p principal] [-q query] [[-c cache_name]|[-k [-t keytab]]|-n] [-w password] [-s admin_server[:port]] [command args...] kadmin.local [-r realm] [-p principal] [-q query] [-d dbname] [-e enc:salt ...] [-m] [-x db_args] [command args...]
|
-r realm Use realm as the default database realm. -p principal Use principal to authenticate. Otherwise, kadmin will append /admin to the primary principal name of the default ccache, the value of the USER environment variable, or the username as obtained with getpwuid, in order of preference. -k Use a keytab to decrypt the KDC response instead of prompting for a password. In this case, the default principal will be host/hostname. If there is no keytab specified with the -t option, then the default keytab will be used. -t keytab Use keytab to decrypt the KDC response. This can only be used with the -k option. -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. -c credentials_cache Use credentials_cache as the credentials cache. The cache should contain a service ticket for the kadmin/admin or kadmin/ADMINHOST (where ADMINHOST is the fully-qualified hostname of the admin server) service; it can be acquired with the kinit(1) program. If this option is not specified, kadmin requests a new service ticket from the KDC, and stores it in its own temporary ccache. -w password Use password instead of prompting for one. Use this option with care, as it may expose the password to other users on the system via the process list. -q query Perform the specified query and then exit. -d dbname Specifies the name of the KDC database. This option does not apply to the LDAP database module. -s admin_server[:port] Specifies the admin server which kadmin should contact. -m If using kadmin.local, prompt for the database master password instead of reading it from a stash file. -e "enc:salt ..." Sets the keysalt list to be used for any new keys created. See Keysalt_lists in kdc.conf(5) for a list of possible values. -O Force use of old AUTH_GSSAPI authentication flavor. -N Prevent fallback to AUTH_GSSAPI authentication flavor. -x db_args Specifies the database specific arguments. See the next section for supported options. Starting with release 1.14, if any command-line arguments remain after the options, they will be treated as a single query to be executed. This mode of operation is intended for scripts and behaves differently from the interactive mode in several respects: β’ Query arguments are split by the shell, not by kadmin. β’ Informational and warning messages are suppressed. Error messages and query output (e.g. for get_principal) will still be displayed. β’ Confirmation prompts are disabled (as if -force was given). Password prompts will still be issued as required. β’ The exit status will be non-zero if the query fails. The -q option does not carry these behavior differences; the query will be processed as if it was entered interactively. The -q option cannot be used in combination with a query in the remaining arguments. DATABASE OPTIONS Database options can be used to override database-specific defaults. Supported options for the DB2 module are: -x dbname=*filename* Specifies the base filename of the DB2 database. -x lockiter Make iteration operations hold the lock for the duration of the entire operation, rather than temporarily releasing the lock while handling each principal. This is the default behavior, but this option exists to allow command line override of a [dbmodules] setting. First introduced in release 1.13. -x unlockiter Make iteration operations unlock the database for each principal, instead of holding the lock for the duration of the entire operation. First introduced in release 1.13. Supported options for the LDAP module are: -x host=ldapuri Specifies the LDAP server to connect to by a LDAP URI. -x binddn=bind_dn Specifies the DN used to bind to the LDAP server. -x bindpwd=password Specifies the password or SASL secret used to bind to the LDAP server. Using this option may expose the password to other users on the system via the process list; to avoid this, instead stash the password using the stashsrvpw command of kdb5_ldap_util(8). -x sasl_mech=mechanism Specifies the SASL mechanism used to bind to the LDAP server. The bind DN is ignored if a SASL mechanism is used. New in release 1.13. -x sasl_authcid=name Specifies the authentication name used when binding to the LDAP server with a SASL mechanism, if the mechanism requires one. New in release 1.13. -x sasl_authzid=name Specifies the authorization name used when binding to the LDAP server with a SASL mechanism. New in release 1.13. -x sasl_realm=realm Specifies the realm used when binding to the LDAP server with a SASL mechanism, if the mechanism uses one. New in release 1.13. -x debug=level sets the OpenLDAP client library debug level. level is an integer to be interpreted by the library. Debugging messages are printed to standard error. New in release 1.12. COMMANDS When using the remote client, available commands may be restricted according to the privileges specified in the kadm5.acl(5) file on the admin server. add_principal add_principal [options] newprinc Creates the principal newprinc, prompting twice for a password. If no password policy is specified with the -policy option, and the policy named default is assigned to the principal if it exists. However, creating a policy named default will not automatically assign this policy to previously existing principals. This policy assignment can be suppressed with the -clearpolicy option. This command requires the add privilege. Aliases: addprinc, ank Options: -expire expdate (getdate string) The expiration date of the principal. -pwexpire pwexpdate (getdate string) The password expiration date. -maxlife maxlife (duration or getdate string) The maximum ticket life for the principal. -maxrenewlife maxrenewlife (duration or getdate string) The maximum renewable life of tickets for the principal. -kvno kvno The initial key version number. -policy policy The password policy used by this principal. If not specified, the policy default is used if it exists (unless -clearpolicy is specified). -clearpolicy Prevents any policy from being assigned when -policy is not specified. {-|+}allow_postdated -allow_postdated prohibits this principal from obtaining postdated tickets. +allow_postdated clears this flag. {-|+}allow_forwardable -allow_forwardable prohibits this principal from obtaining forwardable tickets. +allow_forwardable clears this flag. {-|+}allow_renewable -allow_renewable prohibits this principal from obtaining renewable tickets. +allow_renewable clears this flag. {-|+}allow_proxiable -allow_proxiable prohibits this principal from obtaining proxiable tickets. +allow_proxiable clears this flag. {-|+}allow_dup_skey -allow_dup_skey disables user-to-user authentication for this principal by prohibiting others from obtaining a service ticket encrypted in this principal's TGT session key. +allow_dup_skey clears this flag. {-|+}requires_preauth +requires_preauth requires this principal to preauthenticate before being allowed to kinit. -requires_preauth clears this flag. When +requires_preauth is set on a service principal, the KDC will only issue service tickets for that service principal if the client's initial authentication was performed using preauthentication. {-|+}requires_hwauth +requires_hwauth requires this principal to preauthenticate using a hardware device before being allowed to kinit. -requires_hwauth clears this flag. When +requires_hwauth is set on a service principal, the KDC will only issue service tickets for that service principal if the client's initial authentication was performed using a hardware device to preauthenticate. {-|+}ok_as_delegate +ok_as_delegate sets the okay as delegate flag on tickets issued with this principal as the service. Clients may use this flag as a hint that credentials should be delegated when authenticating to the service. -ok_as_delegate clears this flag. {-|+}allow_svr -allow_svr prohibits the issuance of service tickets for this principal. In release 1.17 and later, user-to-user service tickets are still allowed unless the -allow_dup_skey flag is also set. +allow_svr clears this flag. {-|+}allow_tgs_req -allow_tgs_req specifies that a Ticket-Granting Service (TGS) request for a service ticket for this principal is not permitted. +allow_tgs_req clears this flag. {-|+}allow_tix -allow_tix forbids the issuance of any tickets for this principal. +allow_tix clears this flag. {-|+}needchange +needchange forces a password change on the next initial authentication to this principal. -needchange clears this flag. {-|+}password_changing_service +password_changing_service marks this principal as a password change service principal. {-|+}ok_to_auth_as_delegate +ok_to_auth_as_delegate allows this principal to acquire forwardable tickets to itself from arbitrary users, for use with constrained delegation. {-|+}no_auth_data_required +no_auth_data_required prevents PAC or AD-SIGNEDPATH data from being added to service tickets for the principal. {-|+}lockdown_keys +lockdown_keys prevents keys for this principal from leaving the KDC via kadmind. The chpass and extract operations are denied for a principal with this attribute. The chrand operation is allowed, but will not return the new keys. The delete and rename operations are also denied if this attribute is set, in order to prevent a malicious administrator from replacing principals like krbtgt/* or kadmin/* with new principals without the attribute. This attribute can be set via the network protocol, but can only be removed using kadmin.local. -randkey Sets the key of the principal to a random value. -nokey Causes the principal to be created with no key. New in release 1.12. -pw password Sets the password of the principal to the specified string and does not prompt for a password. Note: using this option in a shell script may expose the password to other users on the system via the process list. -e enc:salt,... Uses the specified keysalt list for setting the keys of the principal. See Keysalt_lists in kdc.conf(5) for a list of possible values. -x db_princ_args Indicates database-specific options. The options for the LDAP database module are: -x dn=dn Specifies the LDAP object that will contain the Kerberos principal being created. -x linkdn=dn Specifies the LDAP object to which the newly created Kerberos principal object will point. -x containerdn=container_dn Specifies the container object under which the Kerberos principal is to be created. -x tktpolicy=policy Associates a ticket policy to the Kerberos principal. NOTE: β’ The containerdn and linkdn options cannot be specified with the dn option. β’ If the dn or containerdn options are not specified while adding the principal, the principals are created under the principal container configured in the realm or the realm container. β’ dn and containerdn should be within the subtrees or principal container configured in the realm. Example: kadmin: addprinc jennifer No policy specified for "jennifer@ATHENA.MIT.EDU"; defaulting to no policy. Enter password for principal jennifer@ATHENA.MIT.EDU: Re-enter password for principal jennifer@ATHENA.MIT.EDU: Principal "jennifer@ATHENA.MIT.EDU" created. kadmin: modify_principal modify_principal [options] principal Modifies the specified principal, changing the fields as specified. The options to add_principal also apply to this command, except for the -randkey, -pw, and -e options. In addition, the option -clearpolicy will clear the current policy of a principal. This command requires the modify privilege. Alias: modprinc Options (in addition to the addprinc options): -unlock Unlocks a locked principal (one which has received too many failed authentication attempts without enough time between them according to its password policy) so that it can successfully authenticate. rename_principal rename_principal [-force] old_principal new_principal Renames the specified old_principal to new_principal. This command prompts for confirmation, unless the -force option is given. This command requires the add and delete privileges. Alias: renprinc delete_principal delete_principal [-force] principal Deletes the specified principal from the database. This command prompts for deletion, unless the -force option is given. This command requires the delete privilege. Alias: delprinc change_password change_password [options] principal Changes the password of principal. Prompts for a new password if neither -randkey or -pw is specified. This command requires the changepw privilege, or that the principal running the program is the same as the principal being changed. Alias: cpw The following options are available: -randkey Sets the key of the principal to a random value. -pw password Set the password to the specified string. Using this option in a script may expose the password to other users on the system via the process list. -e enc:salt,... Uses the specified keysalt list for setting the keys of the principal. See Keysalt_lists in kdc.conf(5) for a list of possible values. -keepold Keeps the existing keys in the database. This flag is usually not necessary except perhaps for krbtgt principals. Example: kadmin: cpw systest Enter password for principal systest@BLEEP.COM: Re-enter password for principal systest@BLEEP.COM: Password for systest@BLEEP.COM changed. kadmin: purgekeys purgekeys [-all|-keepkvno oldest_kvno_to_keep] principal Purges previously retained old keys (e.g., from change_password -keepold) from principal. If -keepkvno is specified, then only purges keys with kvnos lower than oldest_kvno_to_keep. If -all is specified, then all keys are purged. The -all option is new in release 1.12. This command requires the modify privilege. get_principal get_principal [-terse] principal Gets the attributes of principal. With the -terse option, outputs fields as quoted tab-separated strings. This command requires the inquire privilege, or that the principal running the the program to be the same as the one being listed. Alias: getprinc Examples: kadmin: getprinc tlyu/admin Principal: tlyu/admin@BLEEP.COM Expiration date: [never] Last password change: Mon Aug 12 14:16:47 EDT 1996 Password expiration date: [never] Maximum ticket life: 0 days 10:00:00 Maximum renewable life: 7 days 00:00:00 Last modified: Mon Aug 12 14:16:47 EDT 1996 (bjaspan/admin@BLEEP.COM) Last successful authentication: [never] Last failed authentication: [never] Failed password attempts: 0 Number of keys: 1 Key: vno 1, aes256-cts-hmac-sha384-192 MKey: vno 1 Attributes: Policy: [none] kadmin: getprinc -terse systest systest@BLEEP.COM 3 86400 604800 1 785926535 753241234 785900000 tlyu/admin@BLEEP.COM 786100034 0 0 kadmin: list_principals list_principals [expression] Retrieves all or some principal names. expression is a shell-style glob expression that can contain the wild-card characters ?, *, and []. All principal names matching the expression are printed. If no expression is provided, all principal names are printed. If the expression does not contain an @ character, an @ character followed by the local realm is appended to the expression. This command requires the list privilege. Alias: listprincs, get_principals, getprincs Example: kadmin: listprincs test* test3@SECURE-TEST.OV.COM test2@SECURE-TEST.OV.COM test1@SECURE-TEST.OV.COM testuser@SECURE-TEST.OV.COM kadmin: get_strings get_strings principal Displays string attributes on principal. This command requires the inquire privilege. Alias: getstrs set_string set_string principal name value Sets a string attribute on principal. String attributes are used to supply per-principal configuration to the KDC and some KDC plugin modules. The following string attribute names are recognized by the KDC: require_auth Specifies an authentication indicator which is required to authenticate to the principal as a service. Multiple indicators can be specified, separated by spaces; in this case any of the specified indicators will be accepted. (New in release 1.14.) session_enctypes Specifies the encryption types supported for session keys when the principal is authenticated to as a server. See Encryption_types in kdc.conf(5) for a list of the accepted values. otp Enables One Time Passwords (OTP) preauthentication for a client principal. The value is a JSON string representing an array of objects, each having optional type and username fields. pkinit_cert_match Specifies a matching expression that defines the certificate attributes required for the client certificate used by the principal during PKINIT authentication. The matching expression is in the same format as those used by the pkinit_cert_match option in krb5.conf(5). (New in release 1.16.) This command requires the modify privilege. Alias: setstr Example: set_string host/foo.mit.edu session_enctypes aes128-cts set_string user@FOO.COM otp "[{""type"":""hotp"",""username"":""al""}]" del_string del_string principal key Deletes a string attribute from principal. This command requires the delete privilege. Alias: delstr add_policy add_policy [options] policy Adds a password policy named policy to the database. This command requires the add privilege. Alias: addpol The following options are available: -maxlife time (duration or getdate string) Sets the maximum lifetime of a password. -minlife time (duration or getdate string) Sets the minimum lifetime of a password. -minlength length Sets the minimum length of a password. -minclasses number Sets the minimum number of character classes required in a password. The five character classes are lower case, upper case, numbers, punctuation, and whitespace/unprintable characters. -history number Sets the number of past keys kept for a principal. This option is not supported with the LDAP KDC database module. -maxfailure maxnumber Sets the number of authentication failures before the principal is locked. Authentication failures are only tracked for principals which require preauthentication. The counter of failed attempts resets to 0 after a successful attempt to authenticate. A maxnumber value of 0 (the default) disables lockout. -failurecountinterval failuretime (duration or getdate string) Sets the allowable time between authentication failures. If an authentication failure happens after failuretime has elapsed since the previous failure, the number of authentication failures is reset to 1. A failuretime value of 0 (the default) means forever. -lockoutduration lockouttime (duration or getdate string) Sets the duration for which the principal is locked from authenticating if too many authentication failures occur without the specified failure count interval elapsing. A duration of 0 (the default) means the principal remains locked out until it is administratively unlocked with modprinc -unlock. -allowedkeysalts Specifies the key/salt tuples supported for long-term keys when setting or changing a principal's password/keys. See Keysalt_lists in kdc.conf(5) for a list of the accepted values, but note that key/salt tuples must be separated with commas (',') only. To clear the allowed key/salt policy use a value of '-'. Example: kadmin: add_policy -maxlife "2 days" -minlength 5 guests kadmin: modify_policy modify_policy [options] policy Modifies the password policy named policy. Options are as described for add_policy. This command requires the modify privilege. Alias: modpol delete_policy delete_policy [-force] policy Deletes the password policy named policy. Prompts for confirmation before deletion. The command will fail if the policy is in use by any principals. This command requires the delete privilege. Alias: delpol Example: kadmin: del_policy guests Are you sure you want to delete the policy "guests"? (yes/no): yes kadmin: get_policy get_policy [ -terse ] policy Displays the values of the password policy named policy. With the -terse flag, outputs the fields as quoted strings separated by tabs. This command requires the inquire privilege. Alias: getpol Examples: kadmin: get_policy admin Policy: admin Maximum password life: 180 days 00:00:00 Minimum password life: 00:00:00 Minimum password length: 6 Minimum number of password character classes: 2 Number of old keys kept: 5 Reference count: 17 kadmin: get_policy -terse admin admin 15552000 0 6 2 5 17 kadmin: The "Reference count" is the number of principals using that policy. With the LDAP KDC database module, the reference count field is not meaningful. list_policies list_policies [expression] Retrieves all or some policy names. expression is a shell-style glob expression that can contain the wild-card characters ?, *, and []. All policy names matching the expression are printed. If no expression is provided, all existing policy names are printed. This command requires the list privilege. Aliases: listpols, get_policies, getpols. Examples: kadmin: listpols test-pol dict-only once-a-min test-pol-nopw kadmin: listpols t* test-pol test-pol-nopw kadmin: ktadd ktadd [options] principal ktadd [options] -glob princ-exp Adds a principal, or all principals matching princ-exp, to a keytab file. Each principal's keys are randomized in the process. The rules for princ-exp are described in the list_principals command. This command requires the inquire and changepw privileges. With the -glob form, it also requires the list privilege. The options are: -k[eytab] keytab Use keytab as the keytab file. Otherwise, the default keytab is used. -e enc:salt,... Uses the specified keysalt list for setting the new keys of the principal. See Keysalt_lists in kdc.conf(5) for a list of possible values. -q Display less verbose information. -norandkey Do not randomize the keys. The keys and their version numbers stay unchanged. This option cannot be specified in combination with the -e option. An entry for each of the principal's unique encryption types is added, ignoring multiple keys with the same encryption type but different salt types. Alias: xst Example: kadmin: ktadd -k /tmp/foo-new-keytab host/foo.mit.edu Entry for principal host/foo.mit.edu@ATHENA.MIT.EDU with kvno 3, encryption type aes256-cts-hmac-sha1-96 added to keytab FILE:/tmp/foo-new-keytab kadmin: ktremove ktremove [options] principal [kvno | all | old] Removes entries for the specified principal from a keytab. Requires no permissions, since this does not require database access. If the string "all" is specified, all entries for that principal are removed; if the string "old" is specified, all entries for that principal except those with the highest kvno are removed. Otherwise, the value specified is parsed as an integer, and all entries whose kvno match that integer are removed. The options are: -k[eytab] keytab Use keytab as the keytab file. Otherwise, the default keytab is used. -q Display less verbose information. Alias: ktrem Example: kadmin: ktremove kadmin/admin all Entry for principal kadmin/admin with kvno 3 removed from keytab FILE:/etc/krb5.keytab kadmin: lock Lock database exclusively. Use with extreme caution! This command only works with the DB2 KDC database module. unlock Release the exclusive database lock. list_requests Lists available for kadmin requests. Aliases: lr, ? quit Exit program. If the database was locked, the lock is released. Aliases: exit, q HISTORY The kadmin program was originally written by Tom Yu at MIT, as an interface to the OpenVision Kerberos administration program. ENVIRONMENT See kerberos(7) for a description of Kerberos environment variables. SEE ALSO kpasswd(1), kadmind(8), kerberos(7) AUTHOR MIT COPYRIGHT 1985-2022, MIT 1.20.1 KADMIN(1)
| null |
xmlcatalog
|
xmlcatalog is a command line application allowing users to monitor and manipulate XML and SGML catalogs. It is included in libxml(3). Its functions can be invoked from a single command from the command line, or it can perform multiple functions in interactive mode. It can operate on both XML and SGML files.
|
xmlcatalog - Command line tool to parse and manipulate XML or SGML catalog files.
|
xmlcatalog [--sgml | --shell | --create | --del VALUE(S) | [ --add TYPE ORIG REPLACE | --add FILENAME] | --noout | --no-super-update | [-v | --verbose]] {CATALOGFILE} {ENTITIES...}
|
xmlcatalog accepts the following options (in alphabetical order): --add TYPE ORIG REPLACE Add an entry to CATALOGFILE. TYPE indicates the type of entry. Possible types are: public, system, uri, rewriteSystem, rewriteURI, delegatePublic, delegateSystem, delegateURI, nextCatalog. ORIG is the original reference to be replaced, and REPLACE is the URI of the replacement entity to be used. The --add option will not overwrite CATALOGFILE, outputting to stdout, unless --noout is used. The --add will always take three parameters even if some of the XML catalog constructs will have only a single argument. --add FILENAME If the --add option is used following the --sgml option, only a single argument, a FILENAME, is used. This is used to add the name of a catalog file to an SGML supercatalog, a file that contains references to other included SGML catalog files. --create Create a new XML catalog. Outputs to stdout, ignoring filename unless --noout is used, in which case it creates a new catalog file filename. --del VALUE(S) Remove entries from CATALOGFILE matching VALUE(S). The --del option will not overwrite CATALOGFILE, outputting to stdout, unless --noout is used. --noout Save output to the named file rather than outputting to stdout. --no-super-update Do not update the SGML super catalog. --shell Run a shell allowing interactive queries on catalog file CATALOGFILE. For the set of available commands see the section called βSHELL COMMANDSβ. --sgml Uses SGML super catalogs for --add and --del options. -v, --verbose Output debugging information. Invoking xmlcatalog non-interactively without a designated action (imposed with options like --add) will result in a lookup of the catalog entry for ENTITIES in the catalog denoted with CATALOGFILE. The corresponding entries will be output to the command line. This mode of operation, together with --shell mode and non-modifying (i.e. without --noout) direct actions, allows for a special shortcut of the void CATALOGFILE specification (possibly expressed as "" in the shell environment) appointing the default system catalog. That simplifies the handling when its exact location is irrelevant but the respective built-in still needs to be consulted. SHELL COMMANDS Invoking xmlcatalog with the --shell CATALOGFILE option opens a command line shell allowing interactive access to the catalog file identified by CATALOGFILE. Invoking the shell provides a command line prompt after which the following commands (described in alphabetical order) can be entered. add TYPE ORIG REPLACE Add an entry to the catalog file. TYPE indicates the type of entry. Possible types are: public, system, uri, rewriteSystem, rewriteURI, delegatePublic, delegateSystem, delegateURI, nextCatalog. ORIG is the original reference to be replaced, and REPLACE is the URI of the replacement entity to be used. The --add option will not overwrite CATALOGFILE, outputting to stdout, unless --noout is used. The --add will always take three parameters even if some of the XML catalog constructs will have only a single argument. debug Print debugging statements showing the steps xmlcatalog is executing. del VALUE(S) Remove the catalog entry corresponding to VALUE(S). dump Print the current catalog. exit Quit the shell. public PUBLIC-ID Execute a Formal Public Identifier lookup of the catalog entry for PUBLIC-ID. The corresponding entry will be output to the command line. quiet Stop printing debugging statements. system SYSTEM-ID Execute a Formal Public Identifier lookup of the catalog entry for SYSTEM-ID. The corresponding entry will be output to the command line. ENVIRONMENT XML_CATALOG_FILES XML catalog behavior can be changed by redirecting queries to the user's own set of catalogs. This can be done by setting the XML_CATALOG_FILES environment variable to a space-separated list of catalogs. Use percent-encoding to escape spaces or other characters. An empty variable should deactivate loading the default /etc/xml/catalog catalog. DIAGNOSTICS xmlcatalog return codes provide information that can be used when calling it from scripts. 0 No error 1 Failed to remove an entry from the catalog 2 Failed to save to the catalog, check file permissions 3 Failed to add an entry to the catalog 4 Failed to look up an entry in the catalog SEE ALSO libxml(3) More information can be found at β’ libxml(3) web page https://gitlab.gnome.org/GNOME/libxml2 β’ libxml(3) catalog support web page at https://gitlab.gnome.org/GNOME/libxml2/-/wikis/Catalog-support β’ James Clark's SGML catalog page http://www.jclark.com/sp/catalog.htm β’ OASIS XML catalog specification http://www.oasis- open.org/committees/entity/spec.html AUTHOR John Fleck <jfleck@inkstain.net> Author. COPYRIGHT Copyright Β© 2001, 2004 libxml2 02/19/2022 XMLCATALOG(1)
| null |
msgfilter
|
Applies a filter to all translations of a translation catalog. Mandatory arguments to long options are mandatory for short options too. Input file location: -i, --input=INPUTFILE input PO file -D, --directory=DIRECTORY add DIRECTORY to list for input files search If no input file is given or if it is -, standard input is read. Output file location: -o, --output-file=FILE write output to specified file The results are written to standard output if no output file is specified or if it is -. The FILTER can be any program that reads a translation from standard input and writes a modified translation to standard output. Filter input and output: --newline add a newline at the end of input and remove a newline from the end of output Useful FILTER-OPTIONs when the FILTER is 'sed': -e, --expression=SCRIPT add SCRIPT to the commands to be executed -f, --file=SCRIPTFILE add the contents of SCRIPTFILE to the commands to be executed -n, --quiet, --silent suppress automatic printing of pattern space Input file syntax: -P, --properties-input input file is in Java .properties syntax --stringtable-input input file is in NeXTstep/GNUstep .strings syntax Output details: --color use colors and other text attributes always --color=WHEN use colors and other text attributes if WHEN. WHEN may be 'always', 'never', 'auto', or 'html'. --style=STYLEFILE specify CSS style rule file for --color --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 --indent indented output style --keep-header keep header entry unmodified, don't filter it --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 msgfilter is maintained as a Texinfo manual. If the info and msgfilter programs are properly installed at your site, the command info msgfilter should give you access to the complete manual. GNU gettext-tools 0.22.5 February 2024 MSGFILTER(1)
|
msgfilter - edit translations of message catalog
|
msgfilter [OPTION] FILTER [FILTER-OPTION]
| null | null |
pypdfium2
| null | null | null | null | null |
lzfgrep
|
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 |
installcheck
|
The installcheck tool checks if all packages in REPO1...REPON are installable. A package is installable if there is a set of packages from the repositories that satisfies its dependencies. The repositories after the --nocheck option are only used for dependency resolving, but the tool does not check if the packages in them are installable. A Repository can be a solv file, a rpmmd primary.xml.gz file, a SUSE packages or packages.gz file, or a Debian Packages or Packages.gz file. AUTHOR Michael Schroeder <mls@suse.de> libsolv 09/14/2018 INSTALLCHECK(1)
|
installcheck - find out which packages cannot be installed
|
installcheck ARCH REPO1 REPO2... --nocheck NREPO1 NREPO2...
| null | null |
black
| null | null | null | null | null |
arm64-apple-darwin20.0.0-mtoc
|
mtoc converts the input EFI file built as a Mach-O file into an output PEFOFF file. -subsystem type specifies the EFI subsystem type which can be application, boot or runtime. The default is application. -section_alignment value Specifies the PECOFF section alignment. value is a hexadecimal number that must be an integral power of 2. The default is the Mac OS X target pagesize (1000 hex). This value should match the value used for -segalign when linking the Mach-O file. -align value Specifies the PECOFF file and section alignment. value is a hexadecimal number that must be an integral power of 2. The default is 400 hex. This value should match the value used for -segalign when linking the Mach-O file. -version major.minor Specifies the PECOFF major and minor versions for the MajorImageVersion and MinorImageVersion fields. -d filename" Specifies the filename to be used to create a debug directory entry with. Apple, Inc. July 21, 2017 MTOC(1)
|
mtoc - convert a Mach-O file to a PECOFF file
|
mtoc [ -subsystem type ] [ -section_alignment value ] [ -align value ] [ -version major.minor ] [ -d filename ] input output
| null | null |
conda-env
| null | null | null | null | null |
rst2pseudoxml.py
| null | null | null | null | null |
glib-mkenums
| null | null | null | null | null |
jupyter-qtconsole
| null | null | null | null | null |
xzmore
|
xzmore displays text from compressed files to a terminal using more(1). Files supported by xz(1) are decompressed; other files are assumed to be in uncompressed form already. If no files are given, xzmore reads from standard input. See the more(1) manual for the keyboard commands. Note that scrolling backwards might not be possible depending on the implementation of more(1). This is because xzmore uses a pipe to pass the decompressed data to more(1). xzless(1) uses less(1) which provides more advanced features. The command lzmore is provided for backward compatibility with LZMA Utils. ENVIRONMENT PAGER If PAGER is set, its value is used as the pager instead of more(1). SEE ALSO more(1), xz(1), xzless(1), zmore(1) Tukaani 2024-02-12 XZMORE(1)
|
xzmore, lzmore - view xz or lzma compressed (text) files
|
xzmore [file...] lzmore [file...]
| null | null |
cwebp
|
This manual page documents the cwebp command. cwebp compresses an image using the WebP format. Input format can be either PNG, JPEG, TIFF, WebP or raw Y'CbCr samples. Note: Animated PNG and WebP files are not supported.
|
cwebp - compress an image file to a WebP file
|
cwebp [options] input_file -o output_file.webp
|
The basic options are: -o string Specify the name of the output WebP file. If omitted, cwebp will perform compression but only report statistics. Using "-" as output name will direct output to 'stdout'. -- string Explicitly specify the input file. This option is useful if the input file starts with a '-' for instance. This option must appear last. Any other options afterward will be ignored. -h, -help A short usage summary. -H, -longhelp A summary of all the possible options. -version Print the version number (as major.minor.revision) and exit. -lossless Encode the image without any loss. For images with fully transparent area, the invisible pixel values (R/G/B or Y/U/V) will be preserved only if the -exact option is used. -near_lossless int Specify the level of near-lossless image preprocessing. This option adjusts pixel values to help compressibility, but has minimal impact on the visual quality. It triggers lossless compression mode automatically. The range is 0 (maximum preprocessing) to 100 (no preprocessing, the default). The typical value is around 60. Note that lossy with -q 100 can at times yield better results. -q float Specify the compression factor for RGB channels between 0 and 100. The default is 75. In case of lossy compression (default), a small factor produces a smaller file with lower quality. Best quality is achieved by using a value of 100. In case of lossless compression (specified by the -lossless option), a small factor enables faster compression speed, but produces a larger file. Maximum compression is achieved by using a value of 100. -z int Switch on lossless compression mode with the specified level between 0 and 9, with level 0 being the fastest, 9 being the slowest. Fast mode produces larger file size than slower ones. A good default is -z 6. This option is actually a shortcut for some predefined settings for quality and method. If options -q or -m are subsequently used, they will invalidate the effect of this option. -alpha_q int Specify the compression factor for alpha compression between 0 and 100. Lossless compression of alpha is achieved using a value of 100, while the lower values result in a lossy compression. The default is 100. -preset string Specify a set of pre-defined parameters to suit a particular type of source material. Possible values are: default, photo, picture, drawing, icon, text. Since -preset overwrites the other parameters' values (except the -q one), this option should preferably appear first in the order of the arguments. -m int Specify the compression method to use. This parameter controls the trade off between encoding speed and the compressed file size and quality. Possible values range from 0 to 6. Default value is 4. When higher values are used, the encoder will spend more time inspecting additional encoding possibilities and decide on the quality gain. Lower value can result in faster processing time at the expense of larger file size and lower compression quality. -crop x_position y_position width height Crop the source to a rectangle with top-left corner at coordinates (x_position, y_position) and size width x height. This cropping area must be fully contained within the source rectangle. Note: the cropping is applied before any scaling. -resize width height Resize the source to a rectangle with size width x height. If either (but not both) of the width or height parameters is 0, the value will be calculated preserving the aspect-ratio. Note: scaling is applied after cropping. -mt Use multi-threading for encoding, if possible. -low_memory Reduce memory usage of lossy encoding by saving four times the compressed size (typically). This will make the encoding slower and the output slightly different in size and distortion. This flag is only effective for methods 3 and up, and is off by default. Note that leaving this flag off will have some side effects on the bitstream: it forces certain bitstream features like number of partitions (forced to 1). Note that a more detailed report of bitstream size is printed by cwebp when using this option. LOSSY OPTIONS These options are only effective when doing lossy encoding (the default, with or without alpha). -size int Specify a target size (in bytes) to try and reach for the compressed output. The compressor will make several passes of partial encoding in order to get as close as possible to this target. If both -size and -psnr are used, -size value will prevail. -psnr float Specify a target PSNR (in dB) to try and reach for the compressed output. The compressor will make several passes of partial encoding in order to get as close as possible to this target. If both -size and -psnr are used, -size value will prevail. -pass int Set a maximum number of passes to use during the dichotomy used by options -size or -psnr. Maximum value is 10, default is 1. If options -size or -psnr were used, but -pass wasn't specified, a default value of '6' passes will be used. If -pass is specified, but neither -size nor -psnr are, a target PSNR of 40dB will be used. -qrange int int Specifies the permissible interval for the quality factor. This is particularly useful when using multi-pass (-size or -psnr options). Default is 0 100. If the quality factor is outside this range, it will be clamped. If the minimum value must be less or equal to the maximum one. -af Turns auto-filter on. This algorithm will spend additional time optimizing the filtering strength to reach a well-balanced quality. -jpeg_like Change the internal parameter mapping to better match the expected size of JPEG compression. This flag will generally produce an output file of similar size to its JPEG equivalent (for the same -q setting), but with less visual distortion. Advanced options: -f int Specify the strength of the deblocking filter, between 0 (no filtering) and 100 (maximum filtering). A value of 0 will turn off any filtering. Higher value will increase the strength of the filtering process applied after decoding the picture. The higher the value the smoother the picture will appear. Typical values are usually in the range of 20 to 50. -sharpness int Specify the sharpness of the filtering (if used). Range is 0 (sharpest) to 7 (least sharp). Default is 0. -strong Use strong filtering (if filtering is being used thanks to the -f option). Strong filtering is on by default. -nostrong Disable strong filtering (if filtering is being used thanks to the -f option) and use simple filtering instead. -sharp_yuv Use more accurate and sharper RGB->YUV conversion if needed. Note that this process is slower than the default 'fast' RGB->YUV conversion. -sns int Specify the amplitude of the spatial noise shaping. Spatial noise shaping (or sns for short) refers to a general collection of built-in algorithms used to decide which area of the picture should use relatively less bits, and where else to better transfer these bits. The possible range goes from 0 (algorithm is off) to 100 (the maximal effect). The default value is 50. -segments int Change the number of partitions to use during the segmentation of the sns algorithm. Segments should be in range 1 to 4. Default value is 4. This option has no effect for methods 3 and up, unless -low_memory is used. -partition_limit int Degrade quality by limiting the number of bits used by some macroblocks. Range is 0 (no degradation, the default) to 100 (full degradation). Useful values are usually around 30-70 for moderately large images. In the VP8 format, the so-called control partition has a limit of 512k and is used to store the following information: whether the macroblock is skipped, which segment it belongs to, whether it is coded as intra 4x4 or intra 16x16 mode, and finally the prediction modes to use for each of the sub-blocks. For a very large image, 512k only leaves room for a few bits per 16x16 macroblock. The absolute minimum is 4 bits per macroblock. Skip, segment, and mode information can use up almost all these 4 bits (although the case is unlikely), which is problematic for very large images. The partition_limit factor controls how frequently the most bit-costly mode (intra 4x4) will be used. This is useful in case the 512k limit is reached and the following message is displayed: Error code: 6 (PARTITION0_OVERFLOW: Partition #0 is too big to fit 512k). If using -partition_limit is not enough to meet the 512k constraint, one should use less segments in order to save more header bits per macroblock. See the -segments option. Note the -m and -q options also influence the encoder's decisions and ability to hit this limit. LOGGING OPTIONS These options control the level of output: -v Print extra information (encoding time in particular). -print_psnr Compute and report average PSNR (Peak-Signal-To-Noise ratio). -print_ssim Compute and report average SSIM (structural similarity metric, see https://en.wikipedia.org/wiki/SSIM for additional details). -print_lsim Compute and report local similarity metric (sum of lowest error amongst the collocated pixel neighbors). -progress Report encoding progress in percent. -quiet Do not print anything. -short Only print brief information (output file size and PSNR) for testing purposes. -map int Output additional ASCII-map of encoding information. Possible map values range from 1 to 6. This is only meant to help debugging. ADDITIONAL OPTIONS More advanced options are: -s width height Specify that the input file actually consists of raw Y'CbCr samples following the ITU-R BT.601 recommendation, in 4:2:0 linear format. The luma plane has size width x height. -pre int Specify some preprocessing steps. Using a value of '2' will trigger quality-dependent pseudo-random dithering during RGBA->YUVA conversion (lossy compression only). -alpha_filter string Specify the predictive filtering method for the alpha plane. One of 'none', 'fast' or 'best', in increasing complexity and slowness order. Default is 'fast'. Internally, alpha filtering is performed using four possible predictions (none, horizontal, vertical, gradient). The 'best' mode will try each mode in turn and pick the one which gives the smaller size. The 'fast' mode will just try to form an a priori guess without testing all modes. -alpha_method int Specify the algorithm used for alpha compression: 0 or 1. Algorithm 0 denotes no compression, 1 uses WebP lossless format for compression. The default is 1. -exact Preserve RGB values in transparent area. The default is off, to help compressibility. -blend_alpha int This option blends the alpha channel (if present) with the source using the background color specified in hexadecimal as 0xrrggbb. The alpha channel is afterward reset to the opaque value 255. -noalpha Using this option will discard the alpha channel. -hint string Specify the hint about input image type. Possible values are: photo, picture or graph. -metadata string A comma separated list of metadata to copy from the input to the output if present. Valid values: all, none, exif, icc, xmp. The default is none. Note: each input format may not support all combinations. -noasm Disable all assembly optimizations. BUGS Please report all bugs to the issue tracker: https://bugs.chromium.org/p/webp Patches welcome! See this page to get started: https://www.webmproject.org/code/contribute/submitting-patches/
|
cwebp -q 50 -lossless picture.png -o picture_lossless.webp cwebp -q 70 picture_with_alpha.png -o picture_with_alpha.webp cwebp -sns 70 -f 50 -size 60000 picture.png -o picture.webp cwebp -o picture.webp -- ---picture.png AUTHORS cwebp is a part of libwebp and was written by the WebP team. The latest source tree is available at https://chromium.googlesource.com/webm/libwebp This manual page was written by Pascal Massimino <pascal.massimino@gmail.com>, for the Debian project (and may be used by others). SEE ALSO dwebp(1), gif2webp(1) Please refer to https://developers.google.com/speed/webp/ for additional information. March 26, 2024 CWEBP(1)
|
tiffmedian
| null | null | null | null | null |
arm64-apple-darwin20.0.0-check_dylib
|
Check_dylib is a tool used by Apple's Build and Integration team to perform checks on a Mach-O dynamic library as part of the build process. The checks are performed and check_dylib(l) returns the status of the checks as exit values. The checks are performed in the following order: If the install name of the dynamic library does not start with @executable_path check the install name of the dynamic library file against the specified -install_name argument and if it does not match it exit with a value of 2. Check the segment address table specified by -seg_addr_table for an entry with the path_name argument of the -seg_addr_table_filename and if one is not found in the table exit with a value of 3. Check the dynamic library file's address against the address in the matching entry in the segment address table specified by -seg_addr_table and -seg_addr_table_filename and if it does not match exit with a value of 4. Check the address of the dynamic library and if it is zero exit with a value of 5. If there is any other errors check_dylib(l) exits with a value of 1. If no checks fail then check_dylib(l) exits with a value of 0. SEE ALSO seg_addr_table(l), doug(0) Apple Computer, Inc. September 10, 2001 CHECK_DYLIB(l)
|
check_dylib - perform checks on a dynamic library file
|
check_dylib filename -install_name install_name -seg_addr_table seg_addr_table -seg_addr_table_filename path_name
| null | null |
mysqldump
|
The mysqldump client utility performs logical backups, producing a set of SQL statements that can be executed to reproduce the original database object definitions and table data. It dumps one or more MySQL databases for backup or transfer to another SQL server. The mysqldump command can also generate output in CSV, other delimited text, or XML format. Tip Consider using the MySQL Shell dump utilities[1], which provide parallel dumping with multiple threads, file compression, and progress information display, as well as cloud features such as Oracle Cloud Infrastructure Object Storage streaming, and MySQL HeatWave Service compatibility checks and modifications. Dumps can be easily imported into a MySQL Server instance or a MySQL HeatWave Service DB System using the MySQL Shell load dump utilities[2]. Installation instructions for MySQL Shell can be found here[3]. β’ Performance and Scalability Considerations β’ Invocation Syntax β’ Option Syntax - Alphabetical Summary β’ Connection Options β’ Option-File Options β’ DDL Options β’ Debug Options β’ Help Options β’ Internationalization Options β’ Replication Options β’ Format Options β’ Filtering Options β’ Performance Options β’ Transactional Options β’ Option Groups β’ Examples β’ Restrictions mysqldump requires at least the SELECT privilege for dumped tables, SHOW VIEW for dumped views, TRIGGER for dumped triggers, LOCK TABLES if the --single-transaction option is not used, PROCESS if the --no-tablespaces option is not used, and the RELOAD or FLUSH_TABLES priviledge with --single-transaction if both gtid_mode=ON and --set-gtid=purged=ON|AUTO. Certain options might require other privileges as noted in the option descriptions. To reload a dump file, you must have the privileges required to execute the statements that it contains, such as the appropriate CREATE privileges for objects created by those statements. mysqldump output can include ALTER DATABASE statements that change the database collation. These may be used when dumping stored programs to preserve their character encodings. To reload a dump file containing such statements, the ALTER privilege for the affected database is required. Note A dump made using PowerShell on Windows with output redirection creates a file that has UTF-16 encoding: mysqldump [options] > dump.sql However, UTF-16 is not permitted as a connection character set (see the section called βImpermissible Client Character Setsβ), so the dump file cannot be loaded correctly. To work around this issue, use the --result-file option, which creates the output in ASCII format: mysqldump [options] --result-file=dump.sql It is not recommended to load a dump file when GTIDs are enabled on the server (gtid_mode=ON), if your dump file includes system tables. mysqldump issues DML instructions for the system tables which use the non-transactional MyISAM storage engine, and this combination is not permitted when GTIDs are enabled. Performance and Scalability Considerations mysqldump advantages include the convenience and flexibility of viewing or even editing the output before restoring. You can clone databases for development and DBA work, or produce slight variations of an existing database for testing. It is not intended as a fast or scalable solution for backing up substantial amounts of data. With large data sizes, even if the backup step takes a reasonable time, restoring the data can be very slow because replaying the SQL statements involves disk I/O for insertion, index creation, and so on. For large-scale backup and restore, a physical backup is more appropriate, to copy the data files in their original format so that they can be restored quickly. If your tables are primarily InnoDB tables, or if you have a mix of InnoDB and MyISAM tables, consider using mysqlbackup, which is available as part of MySQL Enterprise. This tool provides high performance for InnoDB backups with minimal disruption; it can also back up tables from MyISAM and other storage engines; it also provides a number of convenient options to accommodate different backup scenarios. See Section 30.2, βMySQL Enterprise Backup Overviewβ. mysqldump can retrieve and dump table contents row by row, or it can retrieve the entire content from a table and buffer it in memory before dumping it. Buffering in memory can be a problem if you are dumping large tables. To dump tables row by row, use the --quick option (or --opt, which enables --quick). The --opt option (and hence --quick) is enabled by default, so to enable memory buffering, use --skip-quick. If you are using a recent version of mysqldump to generate a dump to be reloaded into a very old MySQL server, use the --skip-opt option instead of the --opt or --extended-insert option. For additional information about mysqldump, see Section 7.4, βUsing mysqldump for Backupsβ. Invocation Syntax There are in general three ways to use mysqldumpβin order to dump a set of one or more tables, a set of one or more complete databases, or an entire MySQL serverβas shown here: mysqldump [options] db_name [tbl_name ...] mysqldump [options] --databases db_name ... mysqldump [options] --all-databases To dump entire databases, do not name any tables following db_name, or use the --databases or --all-databases option. To see a list of the options your version of mysqldump supports, issue the command mysqldump --help. Option Syntax - Alphabetical Summary mysqldump supports the following options, which can be specified on the command line or in the [mysqldump] and [client] groups of an option file. For information about option files used by MySQL programs, see Section 4.2.2.2, βUsing Option Filesβ. Connection Options The mysqldump command logs into a MySQL server to extract information. The following options specify how to connect to the MySQL server, either on the same machine or a remote system. β’ --bind-address=ip_address ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --bind-address=ip_address β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ On a computer having multiple network interfaces, use this option to select which interface to use for connecting to the MySQL server. β’ --compress, -C ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --compress[={OFF|ON}] β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βDefault Value β OFF β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ Compress all information sent between the client and the server if possible. See Section 4.2.8, βConnection Compression Controlβ. This option is deprecated. Expect it to be removed in a future version of MySQL. See the section called βConfiguring Legacy Connection Compressionβ. β’ --compression-algorithms=value ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ βCommand-Line Format β --compression-algorithms=value β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βType β Set β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βDefault Value β uncompressed β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βValid Values β zlib zstd uncompressed β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ The permitted compression algorithms for connections to the server. The available algorithms are the same as for the protocol_compression_algorithms system variable. The default value is uncompressed. For more information, see Section 4.2.8, βConnection Compression Controlβ. β’ --default-auth=plugin ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --default-auth=plugin β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ A hint about which client-side authentication plugin to use. See Section 6.2.17, βPluggable Authenticationβ. β’ --enable-cleartext-plugin ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --enable-cleartext-plugin β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ Enable the mysql_clear_password cleartext authentication plugin. (See Section 6.4.1.4, βClient-Side Cleartext Pluggable Authenticationβ.) β’ --get-server-public-key ββββββββββββββββββββββ¬ββββββββββββββββββββββββββ βCommand-Line Format β --get-server-public-key β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββ Request from the server the public key required for RSA key pair-based password exchange. This option applies to clients that authenticate with the caching_sha2_password authentication plugin. For that plugin, the server does not send the public key unless requested. This option is ignored for accounts that do not authenticate with that plugin. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection. If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over --get-server-public-key. For information about the caching_sha2_password plugin, see Section 6.4.1.2, βCaching SHA-2 Pluggable Authenticationβ. β’ --host=host_name, -h host_name ββββββββββββββββββββββ¬βββββββββ βCommand-Line Format β --host β ββββββββββββββββββββββ΄βββββββββ Dump data from the MySQL server on the given host. The default host is localhost. β’ --login-path=name ββββββββββββββββββββββ¬ββββββββββββββββββββ βCommand-Line Format β --login-path=name β ββββββββββββββββββββββΌββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββ Read options from the named login path in the .mylogin.cnf login path file. A βlogin pathβ is an option group containing options that specify which MySQL server to connect to and which account to authenticate as. To create or modify a login path file, use the mysql_config_editor utility. See mysql_config_editor(1). For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --no-login-paths ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --no-login-paths β ββββββββββββββββββββββ΄βββββββββββββββββββ Skips reading options from the login path file. See --login-path for related information. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --password[=password], -p[password] ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --password[=password] β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ The password of the MySQL account used for connecting to the server. The password value is optional. If not given, mysqldump prompts for one. If given, there must be no space between --password= or -p and the password following it. If no password option is specified, the default is to send no password. Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 6.1.2.1, βEnd-User Guidelines for Password Securityβ. To explicitly specify that there is no password and that mysqldump should not prompt for one, use the --skip-password option. β’ --password1[=pass_val] The password for multifactor authentication factor 1 of the MySQL account used for connecting to the server. The password value is optional. If not given, mysqldump prompts for one. If given, there must be no space between --password1= and the password following it. If no password option is specified, the default is to send no password. Specifying a password on the command line should be considered insecure. To avoid giving the password on the command line, use an option file. See Section 6.1.2.1, βEnd-User Guidelines for Password Securityβ. To explicitly specify that there is no password and that mysqldump should not prompt for one, use the --skip-password1 option. --password1 and --password are synonymous, as are --skip-password1 and --skip-password. β’ --password2[=pass_val] The password for multifactor authentication factor 2 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for --password1; see the description of that option for details. β’ --password3[=pass_val] The password for multifactor authentication factor 3 of the MySQL account used for connecting to the server. The semantics of this option are similar to the semantics for --password1; see the description of that option for details. β’ --pipe, -W ββββββββββββββββββββββ¬βββββββββ βCommand-Line Format β --pipe β ββββββββββββββββββββββΌβββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββ On Windows, connect to the server using a named pipe. This option applies only if the server was started with the named_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by the named_pipe_full_access_group system variable. β’ --plugin-authentication-kerberos-client-mode=value ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --plugin-authentication-kerberos-client-mode β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββββββββ€ βDefault Value β SSPI β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββββββββ€ βValid Values β GSSAPI β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββββββββ On Windows, the authentication_kerberos_client authentication plugin supports this plugin option. It provides two possible values that the client user can set at runtime: SSPI and GSSAPI. The default value for the client-side plugin option uses Security Support Provider Interface (SSPI), which is capable of acquiring credentials from the Windows in-memory cache. Alternatively, the client user can select a mode that supports Generic Security Service Application Program Interface (GSSAPI) through the MIT Kerberos library on Windows. GSSAPI is capable of acquiring cached credentials previously generated by using the kinit command. For more information, see Commands for Windows Clients in GSSAPI Mode. β’ --plugin-dir=dir_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --plugin-dir=dir_name β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β Directory name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ The directory in which to look for plugins. Specify this option if the --default-auth option is used to specify an authentication plugin but mysqldump does not find it. See Section 6.2.17, βPluggable Authenticationβ. β’ --port=port_num, -P port_num ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --port=port_num β ββββββββββββββββββββββΌββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌββββββββββββββββββ€ βDefault Value β 3306 β ββββββββββββββββββββββ΄ββββββββββββββββββ For TCP/IP connections, the port number to use. β’ --protocol={TCP|SOCKET|PIPE|MEMORY} ββββββββββββββββββββββ¬βββββββββββββββββββββββββ βCommand-Line Format β --protocol=type β ββββββββββββββββββββββΌβββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌβββββββββββββββββββββββββ€ βDefault Value β [see text] β ββββββββββββββββββββββΌβββββββββββββββββββββββββ€ βValid Values β TCP SOCKET PIPE β β β MEMORY β ββββββββββββββββββββββ΄βββββββββββββββββββββββββ The transport protocol to use for connecting to the server. It is useful when the other connection parameters normally result in use of a protocol other than the one you want. For details on the permissible values, see Section 4.2.7, βConnection Transport Protocolsβ. β’ --server-public-key-path=file_name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --server-public-key-path=file_name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββ The path name to a file in PEM format containing a client-side copy of the public key required by the server for RSA key pair-based password exchange. This option applies to clients that authenticate with the sha256_password or caching_sha2_password authentication plugin. This option is ignored for accounts that do not authenticate with one of those plugins. It is also ignored if RSA-based password exchange is not used, as is the case when the client connects to the server using a secure connection. If --server-public-key-path=file_name is given and specifies a valid public key file, it takes precedence over --get-server-public-key. For sha256_password, this option applies only if MySQL was built using OpenSSL. For information about the sha256_password and caching_sha2_password plugins, see Section 6.4.1.3, βSHA-256 Pluggable Authenticationβ, and Section 6.4.1.2, βCaching SHA-2 Pluggable Authenticationβ. β’ --socket=path, -S path ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ βCommand-Line Format β --socket={file_name|pipe_name} β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ For connections to localhost, the Unix socket file to use, or, on Windows, the name of the named pipe to use. On Windows, this option applies only if the server was started with the named_pipe system variable enabled to support named-pipe connections. In addition, the user making the connection must be a member of the Windows group specified by the named_pipe_full_access_group system variable. β’ --ssl* Options that begin with --ssl specify whether to connect to the server using encryption and indicate where to find SSL keys and certificates. See the section called βCommand Options for Encrypted Connectionsβ. β’ --ssl-fips-mode={OFF|ON|STRICT} ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββ βCommand-Line Format β --ssl-fips-mode={OFF|ON|STRICT} β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βType β Enumeration β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βDefault Value β OFF β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βValid Values β OFF ON STRICT β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββ Controls whether to enable FIPS mode on the client side. The --ssl-fips-mode option differs from other --ssl-xxx options in that it is not used to establish encrypted connections, but rather to affect which cryptographic operations to permit. See Section 6.8, βFIPS Supportβ. These --ssl-fips-mode values are permitted: β’ OFF: Disable FIPS mode. β’ ON: Enable FIPS mode. β’ STRICT: Enable βstrictβ FIPS mode. Note If the OpenSSL FIPS Object Module is not available, the only permitted value for --ssl-fips-mode is OFF. In this case, setting --ssl-fips-mode to ON or STRICT causes the client to produce a warning at startup and to operate in non-FIPS mode. This option is deprecated. Expect it to be removed in a future version of MySQL. β’ --tls-ciphersuites=ciphersuite_list ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --tls-ciphersuites=ciphersuite_list β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββ The permissible ciphersuites for encrypted connections that use TLSv1.3. The value is a list of one or more colon-separated ciphersuite names. The ciphersuites that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, βEncrypted Connection TLS Protocols and Ciphersβ. β’ --tls-sni-servername=server_name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββ βCommand-Line Format β --tls-sni-servername=server_name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββ When specified, the name is passed to the libmysqlclient C API library using the MYSQL_OPT_TLS_SNI_SERVERNAME option of mysql_options(). The server name is not case-sensitive. To show which server name the client specified for the current session, if any, check the Tls_sni_server_name status variable. Server Name Indication (SNI) is an extension to the TLS protocol (OpenSSL must be compiled using TLS extensions for this option to function). The MySQL implementation of SNI represents the client-side only. β’ --tls-version=protocol_list ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββ βCommand-Line Format β --tls-version=protocol_list β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββ€ βDefault Value β TLSv1,TLSv1.1,TLSv1.2,TLSv1.3 β β β (OpenSSL 1.1.1 or higher) β β β TLSv1,TLSv1.1,TLSv1.2 β β β (otherwise) β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββ The permissible TLS protocols for encrypted connections. The value is a list of one or more comma-separated protocol names. The protocols that can be named for this option depend on the SSL library used to compile MySQL. For details, see Section 6.3.2, βEncrypted Connection TLS Protocols and Ciphersβ. β’ --user=user_name, -u user_name ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --user=user_name β ββββββββββββββββββββββΌβββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββ The user name of the MySQL account to use for connecting to the server. If you are using the Rewriter plugin, you should grant this user the SKIP_QUERY_REWRITE privilege. β’ --zstd-compression-level=level ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββ βCommand-Line Format β --zstd-compression-level=# β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βType β Integer β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββ The compression level to use for connections to the server that use the zstd compression algorithm. The permitted levels are from 1 to 22, with larger values indicating increasing levels of compression. The default zstd compression level is 3. The compression level setting has no effect on connections that do not use zstd compression. For more information, see Section 4.2.8, βConnection Compression Controlβ. Option-File Options These options are used to control which option files to read. β’ --defaults-extra-file=file_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββ βCommand-Line Format β --defaults-extra-file=file_name β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββ Read this option file after the global option file but (on Unix) before the user option file. If the file does not exist or is otherwise inaccessible, an error occurs. If file_name is not an absolute path name, it is interpreted relative to the current directory. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --defaults-file=file_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --defaults-file=file_name β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ Use only the given option file. If the file does not exist or is otherwise inaccessible, an error occurs. If file_name is not an absolute path name, it is interpreted relative to the current directory. Exception: Even with --defaults-file, client programs read .mylogin.cnf. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --defaults-group-suffix=str ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββ βCommand-Line Format β --defaults-group-suffix=str β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββ Read not only the usual option groups, but also groups with the usual names and a suffix of str. For example, mysqldump normally reads the [client] and [mysqldump] groups. If this option is given as --defaults-group-suffix=_other, mysqldump also reads the [client_other] and [mysqldump_other] groups. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --no-defaults ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --no-defaults β ββββββββββββββββββββββ΄ββββββββββββββββ Do not read any option files. If program startup fails due to reading unknown options from an option file, --no-defaults can be used to prevent them from being read. The exception is that the .mylogin.cnf file is read in all cases, if it exists. This permits passwords to be specified in a safer way than on the command line even when --no-defaults is used. To create .mylogin.cnf, use the mysql_config_editor utility. See mysql_config_editor(1). For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --print-defaults ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --print-defaults β ββββββββββββββββββββββ΄βββββββββββββββββββ Print the program name and all options that it gets from option files. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. DDL Options Usage scenarios for mysqldump include setting up an entire new MySQL instance (including database tables), and replacing data inside an existing instance with existing databases and tables. The following options let you specify which things to tear down and set up when restoring a dump, by encoding various DDL statements within the dump file. β’ --add-drop-database ββββββββββββββββββββββ¬ββββββββββββββββββββββ βCommand-Line Format β --add-drop-database β ββββββββββββββββββββββ΄ββββββββββββββββββββββ Write a DROP DATABASE statement before each CREATE DATABASE statement. This option is typically used in conjunction with the --all-databases or --databases option because no CREATE DATABASE statements are written unless one of those options is specified. Note In MySQL 8.3, the mysql schema is considered a system schema that cannot be dropped by end users. If --add-drop-database is used with --all-databases or with --databases where the list of schemas to be dumped includes mysql, the dump file contains a DROP DATABASE `mysql` statement that causes an error when the dump file is reloaded. Instead, to use --add-drop-database, use --databases with a list of schemas to be dumped, where the list does not include mysql. β’ --add-drop-table ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --add-drop-table β ββββββββββββββββββββββ΄βββββββββββββββββββ Write a DROP TABLE statement before each CREATE TABLE statement. β’ --add-drop-trigger ββββββββββββββββββββββ¬βββββββββββββββββββββ βCommand-Line Format β --add-drop-trigger β ββββββββββββββββββββββ΄βββββββββββββββββββββ Write a DROP TRIGGER statement before each CREATE TRIGGER statement. β’ --all-tablespaces, -Y ββββββββββββββββββββββ¬ββββββββββββββββββββ βCommand-Line Format β --all-tablespaces β ββββββββββββββββββββββ΄ββββββββββββββββββββ Adds to a table dump all SQL statements needed to create any tablespaces used by an NDB table. This information is not otherwise included in the output from mysqldump. This option is currently relevant only to NDB Cluster tables. β’ --no-create-db, -n ββββββββββββββββββββββ¬βββββββββββββββββ βCommand-Line Format β --no-create-db β ββββββββββββββββββββββ΄βββββββββββββββββ Suppress the CREATE DATABASE statements that are otherwise included in the output if the --databases or --all-databases option is given. β’ --no-create-info, -t ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --no-create-info β ββββββββββββββββββββββ΄βββββββββββββββββββ Do not write CREATE TABLE statements that create each dumped table. Note This option does not exclude statements creating log file groups or tablespaces from mysqldump output; however, you can use the --no-tablespaces option for this purpose. β’ --no-tablespaces, -y ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --no-tablespaces β ββββββββββββββββββββββ΄βββββββββββββββββββ This option suppresses all CREATE LOGFILE GROUP and CREATE TABLESPACE statements in the output of mysqldump. β’ --replace ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --replace β ββββββββββββββββββββββ΄ββββββββββββ Write REPLACE statements rather than INSERT statements. Debug Options The following options print debugging information, encode debugging information in the dump file, or let the dump operation proceed regardless of potential problems. β’ --allow-keywords ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --allow-keywords β ββββββββββββββββββββββ΄βββββββββββββββββββ Permit creation of column names that are keywords. This works by prefixing each column name with the table name. β’ --comments, -i ββββββββββββββββββββββ¬βββββββββββββ βCommand-Line Format β --comments β ββββββββββββββββββββββ΄βββββββββββββ Write additional information in the dump file such as program version, server version, and host. This option is enabled by default. To suppress this additional information, use --skip-comments. β’ --debug[=debug_options], -# [debug_options] ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββ βCommand-Line Format β --debug[=debug_options] β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βDefault Value β d:t:o,/tmp/mysqldump.trace β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββ Write a debugging log. A typical debug_options string is d:t:o,file_name. The default value is d:t:o,/tmp/mysqldump.trace. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. β’ --debug-check ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --debug-check β ββββββββββββββββββββββΌββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄ββββββββββββββββ Print some debugging information when the program exits. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. β’ --debug-info ββββββββββββββββββββββ¬βββββββββββββββ βCommand-Line Format β --debug-info β ββββββββββββββββββββββΌβββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄βββββββββββββββ Print debugging information and memory and CPU usage statistics when the program exits. This option is available only if MySQL was built using WITH_DEBUG. MySQL release binaries provided by Oracle are not built using this option. β’ --dump-date ββββββββββββββββββββββ¬ββββββββββββββ βCommand-Line Format β --dump-date β ββββββββββββββββββββββΌββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββ€ βDefault Value β TRUE β ββββββββββββββββββββββ΄ββββββββββββββ If the --comments option is given, mysqldump produces a comment at the end of the dump of the following form: -- Dump completed on DATE However, the date causes dump files taken at different times to appear to be different, even if the data are otherwise identical. --dump-date and --skip-dump-date control whether the date is added to the comment. The default is --dump-date (include the date in the comment). --skip-dump-date suppresses date printing. β’ --force, -f ββββββββββββββββββββββ¬ββββββββββ βCommand-Line Format β --force β ββββββββββββββββββββββ΄ββββββββββ Ignore all errors; continue even if an SQL error occurs during a table dump. One use for this option is to cause mysqldump to continue executing even when it encounters a view that has become invalid because the definition refers to a table that has been dropped. Without --force, mysqldump exits with an error message. With --force, mysqldump prints the error message, but it also writes an SQL comment containing the view definition to the dump output and continues executing. If the --ignore-error option is also given to ignore specific errors, --force takes precedence. β’ --log-error=file_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --log-error=file_name β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ Log warnings and errors by appending them to the named file. The default is to do no logging. β’ --skip-comments ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --skip-comments β ββββββββββββββββββββββ΄ββββββββββββββββββ See the description for the --comments option. β’ --verbose, -v ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --verbose β ββββββββββββββββββββββ΄ββββββββββββ Verbose mode. Print more information about what the program does. Help Options The following options display information about the mysqldump command itself. β’ --help, -? ββββββββββββββββββββββ¬βββββββββ βCommand-Line Format β --help β ββββββββββββββββββββββ΄βββββββββ Display a help message and exit. β’ --version, -V ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --version β ββββββββββββββββββββββ΄ββββββββββββ Display version information and exit. Internationalization Options The following options change how the mysqldump command represents character data with national language settings. β’ --character-sets-dir=dir_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββ βCommand-Line Format β --character-sets-dir=dir_name β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββ€ βType β Directory name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββ The directory where character sets are installed. See Section 10.15, βCharacter Set Configurationβ. β’ --default-character-set=charset_name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --default-character-set=charset_name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββ€ βDefault Value β utf8 β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ Use charset_name as the default character set. See Section 10.15, βCharacter Set Configurationβ. If no character set is specified, mysqldump uses utf8mb4. β’ --no-set-names, -N ββββββββββββββββββββββ¬βββββββββββββββββ βCommand-Line Format β --no-set-names β ββββββββββββββββββββββΌβββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββ΄βββββββββββββββββ Turns off the --set-charset setting, the same as specifying --skip-set-charset. β’ --set-charset ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --set-charset β ββββββββββββββββββββββΌβββββββββββββββββββ€ βDisabled by β skip-set-charset β ββββββββββββββββββββββ΄βββββββββββββββββββ Write SET NAMES default_character_set to the output. This option is enabled by default. To suppress the SET NAMES statement, use --skip-set-charset. Replication Options The mysqldump command is frequently used to create an empty instance, or an instance including data, on a replica server in a replication configuration. The following options apply to dumping and restoring data on replication source servers and replicas. β’ --apply-replica-statements ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββ βCommand-Line Format β --apply-replica-statements β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββ For a replica dump produced with the --dump-replica option, this option adds a STOP REPLICA statement before the statement with the binary log coordinates, and a START REPLICA statement at the end of the output. β’ --apply-slave-statements ββββββββββββββββββββββ¬βββββββββββββββββββββββββββ βCommand-Line Format β --apply-slave-statements β ββββββββββββββββββββββΌβββββββββββββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββΌβββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββ This is a deprecated alias for --apply-replica-statements. β’ --delete-source-logs ββββββββββββββββββββββ¬βββββββββββββββββββββββ βCommand-Line Format β --delete-source-logs β ββββββββββββββββββββββ΄βββββββββββββββββββββββ On a replication source server, delete the binary logs by sending a PURGE BINARY LOGS statement to the server after performing the dump operation. The options require the RELOAD privilege as well as privileges sufficient to execute that statement. This option automatically enables --source-data. β’ --delete-master-logs ββββββββββββββββββββββ¬βββββββββββββββββββββββ βCommand-Line Format β --delete-master-logs β ββββββββββββββββββββββΌβββββββββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββ΄βββββββββββββββββββββββ This is a deprecated alias for --delete-source-logs. β’ --dump-replica[=value] ββββββββββββββββββββββ¬βββββββββββββββββββββββββ βCommand-Line Format β --dump-replica[=value] β ββββββββββββββββββββββΌβββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌβββββββββββββββββββββββββ€ βDefault Value β 1 β ββββββββββββββββββββββΌβββββββββββββββββββββββββ€ βValid Values β 1 2 β ββββββββββββββββββββββ΄βββββββββββββββββββββββββ This option is similar to --source-data, except that it's used to dump a replica server to produce a dump file that can be used to set up another server as a replica that has the same source as the dumped server. The option causes the dump output to include a CHANGE REPLICATION SOURCE TO statement that indicates the binary log coordinates (file name and position) of the dumped replica's source. The CHANGE REPLICATION SOURCE TO statement reads the values of Relay_Master_Log_File and Exec_Master_Log_Pos from the SHOW REPLICA STATUS output and uses them for SOURCE_LOG_FILE and SOURCE_LOG_POS respectively. These are the replication source server coordinates from which the replica starts replicating. Note Inconsistencies in the sequence of transactions from the relay log which have been executed can cause the wrong position to be used. See Section 17.5.1.34, βReplication and Transaction Inconsistenciesβ for more information. --dump-replica causes the coordinates from the source to be used rather than those of the dumped server, as is done by the --source-data option. In addition, specifying this option overrides the --source-data option. Warning --dump-replica should not be used if the server where the dump is going to be applied uses gtid_mode=ON and SOURCE_AUTO_POSITION=1. The option value is handled the same way as for --source-data. Setting no value or 1 causes a CHANGE REPLICATION SOURCE TO statement to be written to the dump. Setting 2 causes the statement to be written but encased in SQL comments. It has the same effect as --source-data in terms of enabling or disabling other options and in how locking is handled. --dump-replica causes mysqldump to stop the replication SQL thread before the dump and restart it again after. --dump-replica sends a SHOW REPLICA STATUS statement to the server to obtain information, so they require privileges sufficient to execute that statement. --apply-replica-statements and --include-source-host-port options can be used in conjunction with --dump-replica. β’ --dump-slave[=value] ββββββββββββββββββββββ¬βββββββββββββββββββββββ βCommand-Line Format β --dump-slave[=value] β ββββββββββββββββββββββΌβββββββββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββΌβββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌβββββββββββββββββββββββ€ βDefault Value β 1 β ββββββββββββββββββββββΌβββββββββββββββββββββββ€ βValid Values β 1 2 β ββββββββββββββββββββββ΄βββββββββββββββββββββββ This is a deprecated alias for --dump-replica. β’ --include-source-host-port ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββ βCommand-Line Format β --include-source-host-port β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββ Adds the SOURCE_HOST and SOURCE_PORT options for the host name and TCP/IP port number of the replica's source, to the CHANGE REPLICATION SOURCE TO statement in a replica dump produced with the --dump-replica option. β’ --include-master-host-port ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββ βCommand-Line Format β --include-master-host-port β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββ This is a deprecated alias for --include-source-host-port. β’ --master-data[=value] ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --master-data[=value] β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βDefault Value β 1 β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βValid Values β 1 2 β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ This is a deprecated alias for --source-data. β’ --output-as-version=value ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββ βCommand-Line Format β --output-as-version=value β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βType β Enumeration β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βDefault Value β SERVER β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βValid Values β BEFORE_8_0_23 β β β BEFORE_8_2_0 β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββ Determines the level of terminology used for statements relating to replicas and events, making it possible to create dumps compatible with older versions of MySQL that do not accept the newer terminology. This option can take any one of the following values, with effects described as listed here: β’ SERVER: Reads the server version and uses the latest versions of statements compatible with that version. This is the default value. β’ BEFORE_8_0_23: Replication SQL statements using deprecated terms such as βslaveβ and βmasterβ are written to the output in place of those using βreplicaβ and βsourceβ, as in MySQL versions prior to 8.0.23. This option also duplicates the effects of BEFORE_8_2_0 on the output of SHOW CREATE EVENT. β’ BEFORE_8_2_0: This option causes SHOW CREATE EVENT to reflect how the event would have been created in a MySQL server prior to version 8.2.0, displaying DISABLE ON SLAVE rather than DISABLE ON REPLICA. This option affects the output from --events, --dump-replica, --source-data, --apply-replica-statements, and --include-source-host-port. Added in MySQL 8.2.0. β’ --source-data[=value] ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --source-data[=value] β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βDefault Value β 1 β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βValid Values β 1 2 β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ Used to dump a replication source server to produce a dump file that can be used to set up another server as a replica of the source. The options cause the dump output to include a CHANGE REPLICATION SOURCE TO statement that indicates the binary log coordinates (file name and position) of the dumped server. These are the replication source server coordinates from which the replica should start replicating after you load the dump file into the replica. If the option value is 2, the CHANGE REPLICATION SOURCE TO statement is written as an SQL comment, and thus is informative only; it has no effect when the dump file is reloaded. If the option value is 1, the statement is not written as a comment and takes effect when the dump file is reloaded. If no option value is specified, the default value is 1. --source-data sends a SHOW BINARY LOG STATUS statement to the server to obtain information, so they require privileges sufficient to execute that statement. This option also requires the RELOAD privilege and the binary log must be enabled. --source-data automatically turns off --lock-tables. They also turn on --lock-all-tables, unless --single-transaction also is specified, in which case, a global read lock is acquired only for a short time at the beginning of the dump (see the description for --single-transaction). In all cases, any action on logs happens at the exact moment of the dump. It is also possible to set up a replica by dumping an existing replica of the source, using the --dump-replica option, which overrides --source-data causing it to be ignored. β’ --set-gtid-purged=value ββββββββββββββββββββββ¬ββββββββββββββββββββββββββ βCommand-Line Format β --set-gtid-purged=value β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βType β Enumeration β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βDefault Value β AUTO β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βValid Values β OFF ON AUTO β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββ This option is for servers that use GTID-based replication (gtid_mode=ON). It controls the inclusion of a SET @@GLOBAL.gtid_purged statement in the dump output, which updates the value of gtid_purged on a server where the dump file is reloaded, to add the GTID set from the source server's gtid_executed system variable. gtid_purged holds the GTIDs of all transactions that have been applied on the server, but do not exist on any binary log file on the server. mysqldump therefore adds the GTIDs for the transactions that were executed on the source server, so that the target server records these transactions as applied, although it does not have them in its binary logs. --set-gtid-purged also controls the inclusion of a SET @@SESSION.sql_log_bin=0 statement, which disables binary logging while the dump file is being reloaded. This statement prevents new GTIDs from being generated and assigned to the transactions in the dump file as they are executed, so that the original GTIDs for the transactions are used. If you do not set the --set-gtid-purged option, the default is that a SET @@GLOBAL.gtid_purged statement is included in the dump output if GTIDs are enabled on the server you are backing up, and the set of GTIDs in the global value of the gtid_executed system variable is not empty. A SET @@SESSION.sql_log_bin=0 statement is also included if GTIDs are enabled on the server. You can either replace the value of gtid_purged with a specified GTID set, or add a plus sign (+) to the statement to append a specified GTID set to the GTID set that is already held by gtid_purged. The SET @@GLOBAL.gtid_purged statement recorded by mysqldump includes a plus sign (+) in a version-specific comment, such that MySQL adds the GTID set from the dump file to the existing gtid_purged value. It is important to note that the value that is included by mysqldump for the SET @@GLOBAL.gtid_purged statement includes the GTIDs of all transactions in the gtid_executed set on the server, even those that changed suppressed parts of the database, or other databases on the server that were not included in a partial dump. This can mean that after the gtid_purged value has been updated on the server where the dump file is replayed, GTIDs are present that do not relate to any data on the target server. If you do not replay any further dump files on the target server, the extraneous GTIDs do not cause any problems with the future operation of the server, but they make it harder to compare or reconcile GTID sets on different servers in the replication topology. If you do replay a further dump file on the target server that contains the same GTIDs (for example, another partial dump from the same origin server), any SET @@GLOBAL.gtid_purged statement in the second dump file fails. In this case, either remove the statement manually before replaying the dump file, or output the dump file without the statement. If the SET @@GLOBAL.gtid_purged statement would not have the desired result on your target server, you can exclude the statement from the output, or include it but comment it out so that it is not actioned automatically. You can also include the statement but manually edit it in the dump file to achieve the desired result. The possible values for the --set-gtid-purged option are as follows: AUTO The default value. If GTIDs are enabled on the server you are backing up and gtid_executed is not empty, SET @@GLOBAL.gtid_purged is added to the output, containing the GTID set from gtid_executed. If GTIDs are enabled, SET @@SESSION.sql_log_bin=0 is added to the output. If GTIDs are not enabled on the server, the statements are not added to the output. OFF SET @@GLOBAL.gtid_purged is not added to the output, and SET @@SESSION.sql_log_bin=0 is not added to the output. For a server where GTIDs are not in use, use this option or AUTO. Only use this option for a server where GTIDs are in use if you are sure that the required GTID set is already present in gtid_purged on the target server and should not be changed, or if you plan to identify and add any missing GTIDs manually. ON If GTIDs are enabled on the server you are backing up, SET @@GLOBAL.gtid_purged is added to the output (unless gtid_executed is empty), and SET @@SESSION.sql_log_bin=0 is added to the output. An error occurs if you set this option but GTIDs are not enabled on the server. For a server where GTIDs are in use, use this option or AUTO, unless you are sure that the GTIDs in gtid_executed are not needed on the target server. COMMENTED If GTIDs are enabled on the server you are backing up, SET @@GLOBAL.gtid_purged is added to the output (unless gtid_executed is empty), but it is commented out. This means that the value of gtid_executed is available in the output, but no action is taken automatically when the dump file is reloaded. SET @@SESSION.sql_log_bin=0 is added to the output, and it is not commented out. With COMMENTED, you can control the use of the gtid_executed set manually or through automation. For example, you might prefer to do this if you are migrating data to another server that already has different active databases. Format Options The following options specify how to represent the entire dump file or certain kinds of data in the dump file. They also control whether certain optional information is written to the dump file. β’ --compact ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --compact β ββββββββββββββββββββββ΄ββββββββββββ Produce more compact output. This option enables the --skip-add-drop-table, --skip-add-locks, --skip-comments, --skip-disable-keys, and --skip-set-charset options. β’ --compatible=name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββ βCommand-Line Format β --compatible=name[,name,...] β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββ€ βDefault Value β β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββ€ βValid Values β ansi mysql323 mysql40 β β β postgresql oracle mssql β β β db2 maxdb no_key_options β β β no_table_options β β β no_key_options β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββ Produce output that is more compatible with other database systems or with older MySQL servers. The only permitted value for this option is ansi, which has the same meaning as the corresponding option for setting the server SQL mode. See Section 5.1.11, βServer SQL Modesβ. β’ --complete-insert, -c ββββββββββββββββββββββ¬ββββββββββββββββββββ βCommand-Line Format β --complete-insert β ββββββββββββββββββββββ΄ββββββββββββββββββββ Use complete INSERT statements that include column names. β’ --create-options ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --create-options β ββββββββββββββββββββββ΄βββββββββββββββββββ Include all MySQL-specific table options in the CREATE TABLE statements. β’ --fields-terminated-by=..., --fields-enclosed-by=..., --fields-optionally-enclosed-by=..., --fields-escaped-by=... ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββ βCommand-Line Format β --fields-terminated-by=string β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββ ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββ βCommand-Line Format β --fields-enclosed-by=string β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββ ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --fields-optionally-enclosed-by=string β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ ββββββββββββββββββββββ¬ββββββββββββββββββββββ βCommand-Line Format β --fields-escaped-by β ββββββββββββββββββββββΌββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββ These options are used with the --tab option and have the same meaning as the corresponding FIELDS clauses for LOAD DATA. See Section 13.2.9, βLOAD DATA Statementβ. β’ --hex-blob ββββββββββββββββββββββ¬βββββββββββββ βCommand-Line Format β --hex-blob β ββββββββββββββββββββββ΄βββββββββββββ Dump binary columns using hexadecimal notation (for example, 'abc' becomes 0x616263). The affected data types are BINARY, VARBINARY, BLOB types, BIT, all spatial data types, and other non-binary data types when used with the binary character set. The --hex-blob option is ignored when the --tab is used. β’ --lines-terminated-by=... ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββ βCommand-Line Format β --lines-terminated-by=string β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββ This option is used with the --tab option and has the same meaning as the corresponding LINES clause for LOAD DATA. See Section 13.2.9, βLOAD DATA Statementβ. β’ --quote-names, -Q ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --quote-names β ββββββββββββββββββββββΌβββββββββββββββββββ€ βDisabled by β skip-quote-names β ββββββββββββββββββββββ΄βββββββββββββββββββ Quote identifiers (such as database, table, and column names) within ` characters. If the ANSI_QUOTES SQL mode is enabled, identifiers are quoted within " characters. This option is enabled by default. It can be disabled with --skip-quote-names, but this option should be given after any option such as --compatible that may enable --quote-names. β’ --result-file=file_name, -r file_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββ βCommand-Line Format β --result-file=file_name β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββ Direct output to the named file. The result file is created and its previous contents overwritten, even if an error occurs while generating the dump. This option should be used on Windows to prevent newline \n characters from being converted to \r\n carriage return/newline sequences. β’ --show-create-skip-secondary-engine=value ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --show-create-skip-secondary-engine β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββ Excludes the SECONDARY ENGINE clause from CREATE TABLE statements. It does so by enabling the show_create_table_skip_secondary_engine system variable for the duration of the dump operation. Alternatively, you can enable the show_create_table_skip_secondary_engine system variable prior to using mysqldump. β’ --tab=dir_name, -T dir_name ββββββββββββββββββββββ¬βββββββββββββββββ βCommand-Line Format β --tab=dir_name β ββββββββββββββββββββββΌβββββββββββββββββ€ βType β Directory name β ββββββββββββββββββββββ΄βββββββββββββββββ Produce tab-separated text-format data files. For each dumped table, mysqldump creates a tbl_name.sql file that contains the CREATE TABLE statement that creates the table, and the server writes a tbl_name.txt file that contains its data. The option value is the directory in which to write the files. Note This option should be used only when mysqldump is run on the same machine as the mysqld server. Because the server creates *.txt files in the directory that you specify, the directory must be writable by the server and the MySQL account that you use must have the FILE privilege. Because mysqldump creates *.sql in the same directory, it must be writable by your system login account. By default, the .txt data files are formatted using tab characters between column values and a newline at the end of each line. The format can be specified explicitly using the --fields-xxx and --lines-terminated-by options. Column values are converted to the character set specified by the --default-character-set option. β’ --tz-utc ββββββββββββββββββββββ¬ββββββββββββββ βCommand-Line Format β --tz-utc β ββββββββββββββββββββββΌββββββββββββββ€ βDisabled by β skip-tz-utc β ββββββββββββββββββββββ΄ββββββββββββββ This option enables TIMESTAMP columns to be dumped and reloaded between servers in different time zones. mysqldump sets its connection time zone to UTC and adds SET TIME_ZONE='+00:00' to the dump file. Without this option, TIMESTAMP columns are dumped and reloaded in the time zones local to the source and destination servers, which can cause the values to change if the servers are in different time zones. --tz-utc also protects against changes due to daylight saving time. --tz-utc is enabled by default. To disable it, use --skip-tz-utc. β’ --xml, -X ββββββββββββββββββββββ¬ββββββββ βCommand-Line Format β --xml β ββββββββββββββββββββββ΄ββββββββ Write dump output as well-formed XML. NULL, 'NULL', and Empty Values: For a column named column_name, the NULL value, an empty string, and the string value 'NULL' are distinguished from one another in the output generated by this option as follows. βββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββ βValue: β XML Representation: β βββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βNULL (unknown value) β <field name="column_name" β β β xsi:nil="true" /> β βββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ β(empty string) β <field β β β name="column_name"></field> β βββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ β(string value) β <field β β β name="column_name">NULL</field> β βββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββ The output from the mysql client when run using the --xml option also follows the preceding rules. (See the section called βMYSQL CLIENT OPTIONSβ.) XML output from mysqldump includes the XML namespace, as shown here: $> mysqldump --xml -u root world City <?xml version="1.0"?> <mysqldump xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <database name="world"> <table_structure name="City"> <field Field="ID" Type="int(11)" Null="NO" Key="PRI" Extra="auto_increment" /> <field Field="Name" Type="char(35)" Null="NO" Key="" Default="" Extra="" /> <field Field="CountryCode" Type="char(3)" Null="NO" Key="" Default="" Extra="" /> <field Field="District" Type="char(20)" Null="NO" Key="" Default="" Extra="" /> <field Field="Population" Type="int(11)" Null="NO" Key="" Default="0" Extra="" /> <key Table="City" Non_unique="0" Key_name="PRIMARY" Seq_in_index="1" Column_name="ID" Collation="A" Cardinality="4079" Null="" Index_type="BTREE" Comment="" /> <options Name="City" Engine="MyISAM" Version="10" Row_format="Fixed" Rows="4079" Avg_row_length="67" Data_length="273293" Max_data_length="18858823439613951" Index_length="43008" Data_free="0" Auto_increment="4080" Create_time="2007-03-31 01:47:01" Update_time="2007-03-31 01:47:02" Collation="latin1_swedish_ci" Create_options="" Comment="" /> </table_structure> <table_data name="City"> <row> <field name="ID">1</field> <field name="Name">Kabul</field> <field name="CountryCode">AFG</field> <field name="District">Kabol</field> <field name="Population">1780000</field> </row> ... <row> <field name="ID">4079</field> <field name="Name">Rafah</field> <field name="CountryCode">PSE</field> <field name="District">Rafah</field> <field name="Population">92020</field> </row> </table_data> </database> </mysqldump> Filtering Options The following options control which kinds of schema objects are written to the dump file: by category, such as triggers or events; by name, for example, choosing which databases and tables to dump; or even filtering rows from the table data using a WHERE clause. β’ --all-databases, -A ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --all-databases β ββββββββββββββββββββββ΄ββββββββββββββββββ Dump all tables in all databases. This is the same as using the --databases option and naming all the databases on the command line. Note See the --add-drop-database description for information about an incompatibility of that option with --all-databases. Prior to MySQL 8.3, the --routines and --events options for mysqldump and mysqlpump were not required to include stored routines and events when using the --all-databases option: The dump included the mysql system database, and therefore also the mysql.proc and mysql.event tables containing stored routine and event definitions. As of MySQL 8.3, the mysql.event and mysql.proc tables are not used. Definitions for the corresponding objects are stored in data dictionary tables, but those tables are not dumped. To include stored routines and events in a dump made using --all-databases, use the --routines and --events options explicitly. β’ --databases, -B ββββββββββββββββββββββ¬ββββββββββββββ βCommand-Line Format β --databases β ββββββββββββββββββββββ΄ββββββββββββββ Dump several databases. Normally, mysqldump treats the first name argument on the command line as a database name and following names as table names. With this option, it treats all name arguments as database names. CREATE DATABASE and USE statements are included in the output before each new database. This option may be used to dump the performance_schema database, which normally is not dumped even with the --all-databases option. (Also use the --skip-lock-tables option.) Note See the --add-drop-database description for information about an incompatibility of that option with --databases. β’ --events, -E ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --events β ββββββββββββββββββββββ΄βββββββββββ Include Event Scheduler events for the dumped databases in the output. This option requires the EVENT privileges for those databases. The output generated by using --events contains CREATE EVENT statements to create the events. β’ --ignore-error=error[,error]... ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββ βCommand-Line Format β --ignore-error=error[,error]... β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββ Ignore the specified errors. The option value is a list of comma-separated error numbers specifying the errors to ignore during mysqldump execution. If the --force option is also given to ignore all errors, --force takes precedence. β’ --ignore-table=db_name.tbl_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββ βCommand-Line Format β --ignore-table=db_name.tbl_name β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββ Do not dump the given table, which must be specified using both the database and table names. To ignore multiple tables, use this option multiple times. This option also can be used to ignore views. β’ --ignore-views=boolean ββββββββββββββββββββββ¬βββββββββββββββββ βCommand-Line Format β --ignore-views β ββββββββββββββββββββββΌβββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄βββββββββββββββββ Skips table views in the dump file. Option added in MySQL 8.2.0. β’ --init-command=str ββββββββββββββββββββββ¬βββββββββββββββββββββ βCommand-Line Format β --init-command=str β ββββββββββββββββββββββΌβββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββ Single SQL statement to execute after connecting to the MySQL server. The definition resets existing statements defined by it or init-command-add. Option added in MySQL 8.2.0. β’ --init-command-add=str ββββββββββββββββββββββ¬βββββββββββββββββββββββββ βCommand-Line Format β --init-command-add=str β ββββββββββββββββββββββΌβββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββ Add an additional SQL statement to execute after connecting or reconnecting to the MySQL server. It's usable without --init-command but has no effect if used before it because init-command resets the list of commands to call. Option added in MySQL 8.2.0. β’ --no-data, -d ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --no-data β ββββββββββββββββββββββ΄ββββββββββββ Do not write any table row information (that is, do not dump table contents). This is useful if you want to dump only the CREATE TABLE statement for the table (for example, to create an empty copy of the table by loading the dump file). β’ --routines, -R ββββββββββββββββββββββ¬βββββββββββββ βCommand-Line Format β --routines β ββββββββββββββββββββββ΄βββββββββββββ Include stored routines (procedures and functions) for the dumped databases in the output. This option requires the global SELECT privilege. The output generated by using --routines contains CREATE PROCEDURE and CREATE FUNCTION statements to create the routines. β’ --skip-generated-invisible-primary-key ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --skip-generated-invisible-primary-key β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββ This option causes generated invisible primary keys to be excluded from the output. For more information, see Section 13.1.20.11, βGenerated Invisible Primary Keysβ. β’ --tables ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --tables β ββββββββββββββββββββββ΄βββββββββββ Override the --databases or -B option. mysqldump regards all name arguments following the option as table names. β’ --triggers ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --triggers β ββββββββββββββββββββββΌββββββββββββββββ€ βDisabled by β skip-triggers β ββββββββββββββββββββββ΄ββββββββββββββββ Include triggers for each dumped table in the output. This option is enabled by default; disable it with --skip-triggers. To be able to dump a table's triggers, you must have the TRIGGER privilege for the table. Multiple triggers are permitted. mysqldump dumps triggers in activation order so that when the dump file is reloaded, triggers are created in the same activation order. However, if a mysqldump dump file contains multiple triggers for a table that have the same trigger event and action time, an error occurs for attempts to load the dump file into an older server that does not support multiple triggers. (For a workaround, see Downgrade Notes[4]; you can convert triggers to be compatible with older servers.) β’ --where='where_condition', -w 'where_condition' ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --where='where_condition' β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ Dump only rows selected by the given WHERE condition. Quotes around the condition are mandatory if it contains spaces or other characters that are special to your command interpreter. Examples: --where="user='jimf'" -w"userid>1" -w"userid<1" Performance Options The following options are the most relevant for the performance particularly of the restore operations. For large data sets, restore operation (processing the INSERT statements in the dump file) is the most time-consuming part. When it is urgent to restore data quickly, plan and test the performance of this stage in advance. For restore times measured in hours, you might prefer an alternative backup and restore solution, such as MySQL Enterprise Backup for InnoDB-only and mixed-use databases. Performance is also affected by the transactional options, primarily for the dump operation. β’ --column-statistics ββββββββββββββββββββββ¬ββββββββββββββββββββββ βCommand-Line Format β --column-statistics β ββββββββββββββββββββββΌββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββββββββ€ βDefault Value β OFF β ββββββββββββββββββββββ΄ββββββββββββββββββββββ Add ANALYZE TABLE statements to the output to generate histogram statistics for dumped tables when the dump file is reloaded. This option is disabled by default because histogram generation for large tables can take a long time. β’ --disable-keys, -K ββββββββββββββββββββββ¬βββββββββββββββββ βCommand-Line Format β --disable-keys β ββββββββββββββββββββββ΄βββββββββββββββββ For each table, surround the INSERT statements with /*!40000 ALTER TABLE tbl_name DISABLE KEYS */; and /*!40000 ALTER TABLE tbl_name ENABLE KEYS */; statements. This makes loading the dump file faster because the indexes are created after all rows are inserted. This option is effective only for nonunique indexes of MyISAM tables. β’ --extended-insert, -e ββββββββββββββββββββββ¬βββββββββββββββββββββββ βCommand-Line Format β --extended-insert β ββββββββββββββββββββββΌβββββββββββββββββββββββ€ βDisabled by β skip-extended-insert β ββββββββββββββββββββββ΄βββββββββββββββββββββββ Write INSERT statements using multiple-row syntax that includes several VALUES lists. This results in a smaller dump file and speeds up inserts when the file is reloaded. β’ --insert-ignore ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --insert-ignore β ββββββββββββββββββββββ΄ββββββββββββββββββ Write INSERT IGNORE statements rather than INSERT statements. β’ --max-allowed-packet=value ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββ βCommand-Line Format β --max-allowed-packet=value β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βDefault Value β 25165824 β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββ The maximum size of the buffer for client/server communication. The default is 24MB, the maximum is 1GB. Note The value of this option is specific to mysqldump and should not be confused with the MySQL server's max_allowed_packet system variable; the server value cannot be exceeded by a single packet from mysqldump, regardless of any setting for the mysqldump option, even if the latter is larger. β’ --mysqld-long-query-time=value ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ βCommand-Line Format β --mysqld-long-query-time=value β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βDefault Value β Server global setting β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ Set the session value of the long_query_time system variable. Use this option if you want to increase the time allowed for mysqldump's queries before they are logged to the slow query log file. mysqldump performs a full table scan, which means its queries can often exceed a global long_query_time setting that is useful for regular queries. The default global setting is 10 seconds. You can use --mysqld-long-query-time to specify a session value from 0 (meaning that every query from mysqldump is logged to the slow query log) to 31536000, which is 365 days in seconds. For mysqldumpβs option, you can only specify whole seconds. When you do not specify this option, the serverβs global setting applies to mysqldumpβs queries. β’ --net-buffer-length=value ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --net-buffer-length=value β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βDefault Value β 16384 β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ The initial size of the buffer for client/server communication. When creating multiple-row INSERT statements (as with the --extended-insert or --opt option), mysqldump creates rows up to --net-buffer-length bytes long. If you increase this variable, ensure that the MySQL server net_buffer_length system variable has a value at least this large. β’ --network-timeout, -M ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --network-timeout[={0|1}] β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βDefault Value β TRUE β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ Enable large tables to be dumped by setting --max-allowed-packet to its maximum value and network read and write timeouts to a large value. This option is enabled by default. To disable it, use --skip-network-timeout. β’ --opt ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --opt β ββββββββββββββββββββββΌβββββββββββ€ βDisabled by β skip-opt β ββββββββββββββββββββββ΄βββββββββββ This option, enabled by default, is shorthand for the combination of --add-drop-table --add-locks --create-options --disable-keys --extended-insert --lock-tables --quick --set-charset. It gives a fast dump operation and produces a dump file that can be reloaded into a MySQL server quickly. Because the --opt option is enabled by default, you only specify its converse, the --skip-opt to turn off several default settings. See the discussion of mysqldump option groups for information about selectively enabling or disabling a subset of the options affected by --opt. β’ --quick, -q ββββββββββββββββββββββ¬βββββββββββββ βCommand-Line Format β --quick β ββββββββββββββββββββββΌβββββββββββββ€ βDisabled by β skip-quick β ββββββββββββββββββββββ΄βββββββββββββ This option is useful for dumping large tables. It forces mysqldump to retrieve rows for a table from the server a row at a time rather than retrieving the entire row set and buffering it in memory before writing it out. β’ --skip-opt ββββββββββββββββββββββ¬βββββββββββββ βCommand-Line Format β --skip-opt β ββββββββββββββββββββββ΄βββββββββββββ See the description for the --opt option. Transactional Options The following options trade off the performance of the dump operation, against the reliability and consistency of the exported data. β’ --add-locks ββββββββββββββββββββββ¬ββββββββββββββ βCommand-Line Format β --add-locks β ββββββββββββββββββββββ΄ββββββββββββββ Surround each table dump with LOCK TABLES and UNLOCK TABLES statements. This results in faster inserts when the dump file is reloaded. See Section 8.2.5.1, βOptimizing INSERT Statementsβ. β’ --flush-logs, -F ββββββββββββββββββββββ¬βββββββββββββββ βCommand-Line Format β --flush-logs β ββββββββββββββββββββββ΄βββββββββββββββ Flush the MySQL server log files before starting the dump. This option requires the RELOAD privilege. If you use this option in combination with the --all-databases option, the logs are flushed for each database dumped. The exception is when using --lock-all-tables, --source-data, or --single-transaction. In these cases, the logs are flushed only once, corresponding to the moment that all tables are locked by FLUSH TABLES WITH READ LOCK. If you want your dump and the log flush to happen at exactly the same moment, you should use --flush-logs together with --lock-all-tables, --source-data, or --single-transaction. β’ --flush-privileges ββββββββββββββββββββββ¬βββββββββββββββββββββ βCommand-Line Format β --flush-privileges β ββββββββββββββββββββββ΄βββββββββββββββββββββ Add a FLUSH PRIVILEGES statement to the dump output after dumping the mysql database. This option should be used any time the dump contains the mysql database and any other database that depends on the data in the mysql database for proper restoration. Because the dump file contains a FLUSH PRIVILEGES statement, reloading the file requires privileges sufficient to execute that statement. Note For upgrades to MySQL 5.7 or higher from older versions, do not use --flush-privileges. For upgrade instructions in this case, see Section 2.10.4, βChanges in MySQL 8.3β. β’ --lock-all-tables, -x ββββββββββββββββββββββ¬ββββββββββββββββββββ βCommand-Line Format β --lock-all-tables β ββββββββββββββββββββββ΄ββββββββββββββββββββ Lock all tables across all databases. This is achieved by acquiring a global read lock for the duration of the whole dump. This option automatically turns off --single-transaction and --lock-tables. β’ --lock-tables, -l ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --lock-tables β ββββββββββββββββββββββ΄ββββββββββββββββ For each dumped database, lock all tables to be dumped before dumping them. The tables are locked with READ LOCAL to permit concurrent inserts in the case of MyISAM tables. For transactional tables such as InnoDB, --single-transaction is a much better option than --lock-tables because it does not need to lock the tables at all. Because --lock-tables locks tables for each database separately, this option does not guarantee that the tables in the dump file are logically consistent between databases. Tables in different databases may be dumped in completely different states. Some options, such as --opt, automatically enable --lock-tables. If you want to override this, use --skip-lock-tables at the end of the option list. β’ --no-autocommit ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --no-autocommit β ββββββββββββββββββββββ΄ββββββββββββββββββ Enclose the INSERT statements for each dumped table within SET autocommit = 0 and COMMIT statements. β’ --order-by-primary ββββββββββββββββββββββ¬βββββββββββββββββββββ βCommand-Line Format β --order-by-primary β ββββββββββββββββββββββ΄βββββββββββββββββββββ Dump each table's rows sorted by its primary key, or by its first unique index, if such an index exists. This is useful when dumping a MyISAM table to be loaded into an InnoDB table, but makes the dump operation take considerably longer. β’ --shared-memory-base-name=name ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ βCommand-Line Format β --shared-memory-base-name=name β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββ€ βPlatform Specific β Windows β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββ On Windows, the shared-memory name to use for connections made using shared memory to a local server. The default value is MYSQL. The shared-memory name is case-sensitive. This option applies only if the server was started with the shared_memory system variable enabled to support shared-memory connections. β’ --single-transaction ββββββββββββββββββββββ¬βββββββββββββββββββββββ βCommand-Line Format β --single-transaction β ββββββββββββββββββββββ΄βββββββββββββββββββββββ This option sets the transaction isolation mode to REPEATABLE READ and sends a START TRANSACTION SQL statement to the server before dumping data. It is useful only with transactional tables such as InnoDB, because then it dumps the consistent state of the database at the time when START TRANSACTION was issued without blocking any applications. The RELOAD or FLUSH_TABLES privilege is required with --single-transaction if both gtid_mode=ON and --set-gtid=purged=ON|AUTO. When using this option, you should keep in mind that only InnoDB tables are dumped in a consistent state. For example, any MyISAM or MEMORY tables dumped while using this option may still change state. While a --single-transaction dump is in process, to ensure a valid dump file (correct table contents and binary log coordinates), no other connection should use the following statements: ALTER TABLE, CREATE TABLE, DROP TABLE, RENAME TABLE, TRUNCATE TABLE. A consistent read is not isolated from those statements, so use of them on a table to be dumped can cause the SELECT that is performed by mysqldump to retrieve the table contents to obtain incorrect contents or fail. The --single-transaction option and the --lock-tables option are mutually exclusive because LOCK TABLES causes any pending transactions to be committed implicitly. To dump large tables, combine the --single-transaction option with the --quick option. Option Groups β’ The --opt option turns on several settings that work together to perform a fast dump operation. All of these settings are on by default, because --opt is on by default. Thus you rarely if ever specify --opt. Instead, you can turn these settings off as a group by specifying --skip-opt, then optionally re-enable certain settings by specifying the associated options later on the command line. β’ The --compact option turns off several settings that control whether optional statements and comments appear in the output. Again, you can follow this option with other options that re-enable certain settings, or turn all the settings on by using the --skip-compact form. When you selectively enable or disable the effect of a group option, order is important because options are processed first to last. For example, --disable-keys --lock-tables --skip-opt would not have the intended effect; it is the same as --skip-opt by itself. Examples To make a backup of an entire database: mysqldump db_name > backup-file.sql To load the dump file back into the server: mysql db_name < backup-file.sql Another way to reload the dump file: mysql -e "source /path-to-backup/backup-file.sql" db_name mysqldump is also very useful for populating databases by copying data from one MySQL server to another: mysqldump --opt db_name | mysql --host=remote_host -C db_name You can dump several databases with one command: mysqldump --databases db_name1 [db_name2 ...] > my_databases.sql To dump all databases, use the --all-databases option: mysqldump --all-databases > all_databases.sql For InnoDB tables, mysqldump provides a way of making an online backup: mysqldump --all-databases --source-data --single-transaction > all_databases.sql This backup acquires a global read lock on all tables (using FLUSH TABLES WITH READ LOCK) at the beginning of the dump. As soon as this lock has been acquired, the binary log coordinates are read and the lock is released. If long updating statements are running when the FLUSH statement is issued, the MySQL server may get stalled until those statements finish. After that, the dump becomes lock free and does not disturb reads and writes on the tables. If the update statements that the MySQL server receives are short (in terms of execution time), the initial lock period should not be noticeable, even with many updates. For point-in-time recovery (also known as βroll-forward,β when you need to restore an old backup and replay the changes that happened since that backup), it is often useful to rotate the binary log (see Section 5.4.4, βThe Binary Logβ) or at least know the binary log coordinates to which the dump corresponds: mysqldump --all-databases --source-data=2 > all_databases.sql Or: mysqldump --all-databases --flush-logs --source-data=2 > all_databases.sql The --source-data option can be used simultaneously with the --single-transaction option, which provides a convenient way to make an online backup suitable for use prior to point-in-time recovery if tables are stored using the InnoDB storage engine. For more information on making backups, see Section 7.2, βDatabase Backup Methodsβ, and Section 7.3, βExample Backup and Recovery Strategyβ. β’ To select the effect of --opt except for some features, use the --skip option for each feature. To disable extended inserts and memory buffering, use --opt --skip-extended-insert --skip-quick. (Actually, --skip-extended-insert --skip-quick is sufficient because --opt is on by default.) β’ To reverse --opt for all features except disabling of indexes and table locking, use --skip-opt --disable-keys --lock-tables. Restrictions mysqldump does not dump the performance_schema or sys schema by default. To dump any of these, name them explicitly on the command line. You can also name them with the --databases option. For performance_schema, also use the --skip-lock-tables option. mysqldump does not dump the INFORMATION_SCHEMA schema. mysqldump does not dump InnoDB CREATE TABLESPACE statements. mysqldump does not dump the NDB Cluster ndbinfo information database. mysqldump includes statements to recreate the general_log and slow_query_log tables for dumps of the mysql database. Log table contents are not dumped. If you encounter problems backing up views due to insufficient privileges, see Section 25.9, βRestrictions on Viewsβ for a workaround. COPYRIGHT Copyright Β© 1997, 2023, Oracle and/or its affiliates. This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/. NOTES 1. MySQL Shell dump utilities https://dev.mysql.com/doc/mysql-shell/8.1/en/mysql-shell-utilities- dump-instance-schema.html 2. MySQL Shell load dump utilities https://dev.mysql.com/doc/mysql-shell/8.1/en/mysql-shell-utilities- load-dump.html 3. here https://dev.mysql.com/doc/mysql-shell/8.1/en/mysql-shell- install.html 4. Downgrade Notes https://dev.mysql.com/doc/refman/5.7/en/downgrading-to-previous- series.html SEE ALSO For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/. AUTHOR Oracle Corporation (http://dev.mysql.com/). MySQL 8.3 11/23/2023 MYSQLDUMP(1)
|
mysqldump - a database backup program
|
mysqldump [options] [db_name [tbl_name ...]]
| null | null |
watchmedo
| null | null | null | null | null |
texify_benchmark
| null | null | null | null | null |
surya_gui
| null | null | null | null | null |
sip-wheel
| null | null | null | null | null |
xzgrep
|
xzgrep invokes grep(1) on uncompressed contents of files. The formats of the files are determined from the filename suffixes. Any file with a suffix supported by xz(1), gzip(1), bzip2(1), lzop(1), zstd(1), or lz4(1) will be decompressed; all other files are assumed to be uncompressed. If no files are specified or file is - then standard input is read. When reading from standard input, only files supported by xz(1) are decompressed. Other files are assumed to be in uncompressed form already. Most options of grep(1) are supported. However, the following options are not supported: -r, --recursive -R, --dereference-recursive -d, --directories=action -Z, --null -z, --null-data --include=glob --exclude=glob --exclude-from=file --exclude-dir=glob xzegrep is an alias for xzgrep -E. xzfgrep is an alias for xzgrep -F. The commands lzgrep, lzegrep, and lzfgrep are provided for backward compatibility with LZMA Utils. EXIT STATUS 0 At least one match was found from at least one of the input files. No errors occurred. 1 No matches were found from any of the input files. No errors occurred. >1 One or more errors occurred. It is unknown if matches were found. ENVIRONMENT GREP If GREP is set to a non-empty value, it is used instead of grep, grep -E, or grep -F. SEE ALSO grep(1), xz(1), gzip(1), bzip2(1), lzop(1), zstd(1), lz4(1), zgrep(1) Tukaani 2024-02-13 XZGREP(1)
|
xzgrep - search possibly-compressed files for patterns
|
xzgrep [option...] [pattern_list] [file...] xzegrep ... xzfgrep ... lzgrep ... lzegrep ... lzfgrep ...
| null | null |
rst2s5.py
| null | null | null | null | null |
pylsp
| null | null | null | null | null |
pydoc3
| null | null | null | null | null |
jupyter-kernelspec
| null | null | null | null | null |
mysql.server
|
MySQL distributions on Unix and Unix-like system include a script named mysql.server, which starts the MySQL server using mysqld_safe. It can be used on systems such as Linux and Solaris that use System V-style run directories to start and stop system services. It is also used by the macOS Startup Item for MySQL. mysql.server is the script name as used within the MySQL source tree. The installed name might be different (for example, mysqld or mysql). In the following discussion, adjust the name mysql.server as appropriate for your system. Note For some Linux platforms, MySQL installation from RPM or Debian packages includes systemd support for managing MySQL server startup and shutdown. On these platforms, mysql.server and mysqld_safe are not installed because they are unnecessary. For more information, see Section 2.5.9, βManaging MySQL Server with systemdβ. To start or stop the server manually using the mysql.server script, invoke it from the command line with start or stop arguments: mysql.server start mysql.server stop mysql.server changes location to the MySQL installation directory, then invokes mysqld_safe. To run the server as some specific user, add an appropriate user option to the [mysqld] group of the global /etc/my.cnf option file, as shown later in this section. (It is possible that you must edit mysql.server if you've installed a binary distribution of MySQL in a nonstandard location. Modify it to change location into the proper directory before it runs mysqld_safe. If you do this, your modified version of mysql.server may be overwritten if you upgrade MySQL in the future; make a copy of your edited version that you can reinstall.) mysql.server stop stops the server by sending a signal to it. You can also stop the server manually by executing mysqladmin shutdown. To start and stop MySQL automatically on your server, you must add start and stop commands to the appropriate places in your /etc/rc* files: β’ If you use the Linux server RPM package (MySQL-server-VERSION.rpm), or a native Linux package installation, the mysql.server script may be installed in the /etc/init.d directory with the name mysqld or mysql. See Section 2.5.4, βInstalling MySQL on Linux Using RPM Packages from Oracleβ, for more information on the Linux RPM packages. β’ If you install MySQL from a source distribution or using a binary distribution format that does not install mysql.server automatically, you can install the script manually. It can be found in the support-files directory under the MySQL installation directory or in a MySQL source tree. Copy the script to the /etc/init.d directory with the name mysql and make it executable: cp mysql.server /etc/init.d/mysql chmod +x /etc/init.d/mysql After installing the script, the commands needed to activate it to run at system startup depend on your operating system. On Linux, you can use chkconfig: chkconfig --add mysql On some Linux systems, the following command also seems to be necessary to fully enable the mysql script: chkconfig --level 345 mysql on β’ On FreeBSD, startup scripts generally should go in /usr/local/etc/rc.d/. Install the mysql.server script as /usr/local/etc/rc.d/mysql.server.sh to enable automatic startup. The rc(8) manual page states that scripts in this directory are executed only if their base name matches the *.sh shell file name pattern. Any other files or directories present within the directory are silently ignored. β’ As an alternative to the preceding setup, some operating systems also use /etc/rc.local or /etc/init.d/boot.local to start additional services on startup. To start up MySQL using this method, append a command like the one following to the appropriate startup file: /bin/sh -c 'cd /usr/local/mysql; ./bin/mysqld_safe --user=mysql &' β’ For other systems, consult your operating system documentation to see how to install startup scripts. mysql.server reads options from the [mysql.server] and [mysqld] sections of option files. For backward compatibility, it also reads [mysql_server] sections, but to be current you should rename such sections to [mysql.server]. You can add options for mysql.server in a global /etc/my.cnf file. A typical my.cnf file might look like this: [mysqld] datadir=/usr/local/mysql/var socket=/var/tmp/mysql.sock port=3306 user=mysql [mysql.server] basedir=/usr/local/mysql The mysql.server script supports the options shown in the following table. If specified, they must be placed in an option file, not on the command line. mysql.server supports only start and stop as command-line arguments. Table 4.3. mysql.server Option-File Options ββββββββββββββββββββββββββ¬ββββββββββββββββββββββ¬βββββββββββββββββ βOption Name β Description β Type β ββββββββββββββββββββββββββΌββββββββββββββββββββββΌβββββββββββββββββ€ βbasedir β Path to MySQL β Directory name β β β installation β β β β directory β β ββββββββββββββββββββββββββΌββββββββββββββββββββββΌβββββββββββββββββ€ βdatadir β Path to MySQL data β Directory name β β β directory β β ββββββββββββββββββββββββββΌββββββββββββββββββββββΌβββββββββββββββββ€ βpid-file β File in which β File name β β β server should write β β β β its process ID β β ββββββββββββββββββββββββββΌββββββββββββββββββββββΌβββββββββββββββββ€ βservice-startup-timeout β How long to wait β Integer β β β for server startup β β ββββββββββββββββββββββββββ΄ββββββββββββββββββββββ΄βββββββββββββββββ β’ basedir=dir_name The path to the MySQL installation directory. β’ datadir=dir_name The path to the MySQL data directory. β’ pid-file=file_name The path name of the file in which the server should write its process ID. The server creates the file in the data directory unless an absolute path name is given to specify a different directory. If this option is not given, mysql.server uses a default value of host_name.pid. The PID file value passed to mysqld_safe overrides any value specified in the [mysqld_safe] option file group. Because mysql.server reads the [mysqld] option file group but not the [mysqld_safe] group, you can ensure that mysqld_safe gets the same value when invoked from mysql.server as when invoked manually by putting the same pid-file setting in both the [mysqld_safe] and [mysqld] groups. β’ service-startup-timeout=seconds How long in seconds to wait for confirmation of server startup. If the server does not start within this time, mysql.server exits with an error. The default value is 900. A value of 0 means not to wait at all for startup. Negative values mean to wait forever (no timeout). COPYRIGHT Copyright Β© 1997, 2023, Oracle and/or its affiliates. This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/. SEE ALSO For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/. AUTHOR Oracle Corporation (http://dev.mysql.com/). MySQL 8.3 11/23/2023 MYSQL.SERVER(1)
|
mysql.server - MySQL server startup script
|
mysql {start|stop}
| null | null |
jupyter-kernel
| null | null | null | null | null |
jupyter
| null | null | null | null | null |
jupyter-bundlerextension
| null | null | null | null | null |
sim_client
| null | null | null | null | null |
rst2html.py
| null | null | null | null | null |
pyrsa-verify
| null | null | null | null | null |
mysqlxtest
| null | null | null | null | null |
lzma
|
xz is a general-purpose data compression tool with command line syntax similar to gzip(1) and bzip2(1). The native file format is the .xz format, but the legacy .lzma format used by LZMA Utils and raw compressed streams with no container format headers are also supported. In addition, decompression of the .lz format used by lzip is supported. xz compresses or decompresses each file according to the selected operation mode. If no files are given or file is -, xz reads from standard input and writes the processed data to standard output. xz will refuse (display an error and skip the file) to write compressed data to standard output if it is a terminal. Similarly, xz will refuse to read compressed data from standard input if it is a terminal. Unless --stdout is specified, files other than - are written to a new file whose name is derived from the source file name: β’ When compressing, the suffix of the target file format (.xz or .lzma) is appended to the source filename to get the target filename. β’ When decompressing, the .xz, .lzma, or .lz suffix is removed from the filename to get the target filename. xz also recognizes the suffixes .txz and .tlz, and replaces them with the .tar suffix. If the target file already exists, an error is displayed and the file is skipped. Unless writing to standard output, xz will display a warning and skip the file if any of the following applies: β’ File is not a regular file. Symbolic links are not followed, and thus they are not considered to be regular files. β’ File has more than one hard link. β’ File has setuid, setgid, or sticky bit set. β’ The operation mode is set to compress and the file already has a suffix of the target file format (.xz or .txz when compressing to the .xz format, and .lzma or .tlz when compressing to the .lzma format). β’ The operation mode is set to decompress and the file doesn't have a suffix of any of the supported file formats (.xz, .txz, .lzma, .tlz, or .lz). After successfully compressing or decompressing the file, xz copies the owner, group, permissions, access time, and modification time from the source file to the target file. If copying the group fails, the permissions are modified so that the target file doesn't become accessible to users who didn't have permission to access the source file. xz doesn't support copying other metadata like access control lists or extended attributes yet. Once the target file has been successfully closed, the source file is removed unless --keep was specified. The source file is never removed if the output is written to standard output or if an error occurs. Sending SIGINFO or SIGUSR1 to the xz process makes it print progress information to standard error. This has only limited use since when standard error is a terminal, using --verbose will display an automatically updating progress indicator. Memory usage The memory usage of xz varies from a few hundred kilobytes to several gigabytes depending on the compression settings. The settings used when compressing a file determine the memory requirements of the decompressor. Typically the decompressor needs 5 % to 20 % of the amount of memory that the compressor needed when creating the file. For example, decompressing a file created with xz -9 currently requires 65 MiB of memory. Still, it is possible to have .xz files that require several gigabytes of memory to decompress. Especially users of older systems may find the possibility of very large memory usage annoying. To prevent uncomfortable surprises, xz has a built-in memory usage limiter, which is disabled by default. While some operating systems provide ways to limit the memory usage of processes, relying on it wasn't deemed to be flexible enough (for example, using ulimit(1) to limit virtual memory tends to cripple mmap(2)). The memory usage limiter can be enabled with the command line option --memlimit=limit. Often it is more convenient to enable the limiter by default by setting the environment variable XZ_DEFAULTS, for example, XZ_DEFAULTS=--memlimit=150MiB. It is possible to set the limits separately for compression and decompression by using --memlimit-compress=limit and --memlimit-decompress=limit. Using these two options outside XZ_DEFAULTS is rarely useful because a single run of xz cannot do both compression and decompression and --memlimit=limit (or -M limit) is shorter to type on the command line. If the specified memory usage limit is exceeded when decompressing, xz will display an error and decompressing the file will fail. If the limit is exceeded when compressing, xz will try to scale the settings down so that the limit is no longer exceeded (except when using --format=raw or --no-adjust). This way the operation won't fail unless the limit is very small. The scaling of the settings is done in steps that don't match the compression level presets, for example, if the limit is only slightly less than the amount required for xz -9, the settings will be scaled down only a little, not all the way down to xz -8. Concatenation and padding with .xz files It is possible to concatenate .xz files as is. xz will decompress such files as if they were a single .xz file. It is possible to insert padding between the concatenated parts or after the last part. The padding must consist of null bytes and the size of the padding must be a multiple of four bytes. This can be useful, for example, if the .xz file is stored on a medium that measures file sizes in 512-byte blocks. Concatenation and padding are not allowed with .lzma files or raw streams.
|
xz, unxz, xzcat, lzma, unlzma, lzcat - Compress or decompress .xz and .lzma files
|
xz [option...] [file...] COMMAND ALIASES unxz is equivalent to xz --decompress. xzcat is equivalent to xz --decompress --stdout. lzma is equivalent to xz --format=lzma. unlzma is equivalent to xz --format=lzma --decompress. lzcat is equivalent to xz --format=lzma --decompress --stdout. When writing scripts that need to decompress files, it is recommended to always use the name xz with appropriate arguments (xz -d or xz -dc) instead of the names unxz and xzcat.
|
Integer suffixes and special values In most places where an integer argument is expected, an optional suffix is supported to easily indicate large integers. There must be no space between the integer and the suffix. KiB Multiply the integer by 1,024 (2^10). Ki, k, kB, K, and KB are accepted as synonyms for KiB. MiB Multiply the integer by 1,048,576 (2^20). Mi, m, M, and MB are accepted as synonyms for MiB. GiB Multiply the integer by 1,073,741,824 (2^30). Gi, g, G, and GB are accepted as synonyms for GiB. The special value max can be used to indicate the maximum integer value supported by the option. Operation mode If multiple operation mode options are given, the last one takes effect. -z, --compress Compress. This is the default operation mode when no operation mode option is specified and no other operation mode is implied from the command name (for example, unxz implies --decompress). -d, --decompress, --uncompress Decompress. -t, --test Test the integrity of compressed files. This option is equivalent to --decompress --stdout except that the decompressed data is discarded instead of being written to standard output. No files are created or removed. -l, --list Print information about compressed files. No uncompressed output is produced, and no files are created or removed. In list mode, the program cannot read the compressed data from standard input or from other unseekable sources. The default listing shows basic information about files, one file per line. To get more detailed information, use also the --verbose option. For even more information, use --verbose twice, but note that this may be slow, because getting all the extra information requires many seeks. The width of verbose output exceeds 80 characters, so piping the output to, for example, less -S may be convenient if the terminal isn't wide enough. The exact output may vary between xz versions and different locales. For machine-readable output, --robot --list should be used. Operation modifiers -k, --keep Don't delete the input files. Since xz 5.2.6, this option also makes xz compress or decompress even if the input is a symbolic link to a regular file, has more than one hard link, or has the setuid, setgid, or sticky bit set. The setuid, setgid, and sticky bits are not copied to the target file. In earlier versions this was only done with --force. -f, --force This option has several effects: β’ If the target file already exists, delete it before compressing or decompressing. β’ Compress or decompress even if the input is a symbolic link to a regular file, has more than one hard link, or has the setuid, setgid, or sticky bit set. The setuid, setgid, and sticky bits are not copied to the target file. β’ When used with --decompress --stdout and xz cannot recognize the type of the source file, copy the source file as is to standard output. This allows xzcat --force to be used like cat(1) for files that have not been compressed with xz. Note that in future, xz might support new compressed file formats, which may make xz decompress more types of files instead of copying them as is to standard output. --format=format can be used to restrict xz to decompress only a single file format. -c, --stdout, --to-stdout Write the compressed or decompressed data to standard output instead of a file. This implies --keep. --single-stream Decompress only the first .xz stream, and silently ignore possible remaining input data following the stream. Normally such trailing garbage makes xz display an error. xz never decompresses more than one stream from .lzma files or raw streams, but this option still makes xz ignore the possible trailing data after the .lzma file or raw stream. This option has no effect if the operation mode is not --decompress or --test. --no-sparse Disable creation of sparse files. By default, if decompressing into a regular file, xz tries to make the file sparse if the decompressed data contains long sequences of binary zeros. It also works when writing to standard output as long as standard output is connected to a regular file and certain additional conditions are met to make it safe. Creating sparse files may save disk space and speed up the decompression by reducing the amount of disk I/O. -S .suf, --suffix=.suf When compressing, use .suf as the suffix for the target file instead of .xz or .lzma. If not writing to standard output and the source file already has the suffix .suf, a warning is displayed and the file is skipped. When decompressing, recognize files with the suffix .suf in addition to files with the .xz, .txz, .lzma, .tlz, or .lz suffix. If the source file has the suffix .suf, the suffix is removed to get the target filename. When compressing or decompressing raw streams (--format=raw), the suffix must always be specified unless writing to standard output, because there is no default suffix for raw streams. --files[=file] Read the filenames to process from file; if file is omitted, filenames are read from standard input. Filenames must be terminated with the newline character. A dash (-) is taken as a regular filename; it doesn't mean standard input. If filenames are given also as command line arguments, they are processed before the filenames read from file. --files0[=file] This is identical to --files[=file] except that each filename must be terminated with the null character. Basic file format and compression options -F format, --format=format Specify the file format to compress or decompress: auto This is the default. When compressing, auto is equivalent to xz. When decompressing, the format of the input file is automatically detected. Note that raw streams (created with --format=raw) cannot be auto- detected. xz Compress to the .xz file format, or accept only .xz files when decompressing. lzma, alone Compress to the legacy .lzma file format, or accept only .lzma files when decompressing. The alternative name alone is provided for backwards compatibility with LZMA Utils. lzip Accept only .lz files when decompressing. Compression is not supported. The .lz format version 0 and the unextended version 1 are supported. Version 0 files were produced by lzip 1.3 and older. Such files aren't common but may be found from file archives as a few source packages were released in this format. People might have old personal files in this format too. Decompression support for the format version 0 was removed in lzip 1.18. lzip 1.4 and later create files in the format version 1. The sync flush marker extension to the format version 1 was added in lzip 1.6. This extension is rarely used and isn't supported by xz (diagnosed as corrupt input). raw Compress or uncompress a raw stream (no headers). This is meant for advanced users only. To decode raw streams, you need use --format=raw and explicitly specify the filter chain, which normally would have been stored in the container headers. -C check, --check=check Specify the type of the integrity check. The check is calculated from the uncompressed data and stored in the .xz file. This option has an effect only when compressing into the .xz format; the .lzma format doesn't support integrity checks. The integrity check (if any) is verified when the .xz file is decompressed. Supported check types: none Don't calculate an integrity check at all. This is usually a bad idea. This can be useful when integrity of the data is verified by other means anyway. crc32 Calculate CRC32 using the polynomial from IEEE-802.3 (Ethernet). crc64 Calculate CRC64 using the polynomial from ECMA-182. This is the default, since it is slightly better than CRC32 at detecting damaged files and the speed difference is negligible. sha256 Calculate SHA-256. This is somewhat slower than CRC32 and CRC64. Integrity of the .xz headers is always verified with CRC32. It is not possible to change or disable it. --ignore-check Don't verify the integrity check of the compressed data when decompressing. The CRC32 values in the .xz headers will still be verified normally. Do not use this option unless you know what you are doing. Possible reasons to use this option: β’ Trying to recover data from a corrupt .xz file. β’ Speeding up decompression. This matters mostly with SHA-256 or with files that have compressed extremely well. It's recommended to not use this option for this purpose unless the file integrity is verified externally in some other way. -0 ... -9 Select a compression preset level. The default is -6. If multiple preset levels are specified, the last one takes effect. If a custom filter chain was already specified, setting a compression preset level clears the custom filter chain. The differences between the presets are more significant than with gzip(1) and bzip2(1). The selected compression settings determine the memory requirements of the decompressor, thus using a too high preset level might make it painful to decompress the file on an old system with little RAM. Specifically, it's not a good idea to blindly use -9 for everything like it often is with gzip(1) and bzip2(1). -0 ... -3 These are somewhat fast presets. -0 is sometimes faster than gzip -9 while compressing much better. The higher ones often have speed comparable to bzip2(1) with comparable or better compression ratio, although the results depend a lot on the type of data being compressed. -4 ... -6 Good to very good compression while keeping decompressor memory usage reasonable even for old systems. -6 is the default, which is usually a good choice for distributing files that need to be decompressible even on systems with only 16 MiB RAM. (-5e or -6e may be worth considering too. See --extreme.) -7 ... -9 These are like -6 but with higher compressor and decompressor memory requirements. These are useful only when compressing files bigger than 8 MiB, 16 MiB, and 32 MiB, respectively. On the same hardware, the decompression speed is approximately a constant number of bytes of compressed data per second. In other words, the better the compression, the faster the decompression will usually be. This also means that the amount of uncompressed output produced per second can vary a lot. The following table summarises the features of the presets: Preset DictSize CompCPU CompMem DecMem -0 256 KiB 0 3 MiB 1 MiB -1 1 MiB 1 9 MiB 2 MiB -2 2 MiB 2 17 MiB 3 MiB -3 4 MiB 3 32 MiB 5 MiB -4 4 MiB 4 48 MiB 5 MiB -5 8 MiB 5 94 MiB 9 MiB -6 8 MiB 6 94 MiB 9 MiB -7 16 MiB 6 186 MiB 17 MiB -8 32 MiB 6 370 MiB 33 MiB -9 64 MiB 6 674 MiB 65 MiB Column descriptions: β’ DictSize is the LZMA2 dictionary size. It is waste of memory to use a dictionary bigger than the size of the uncompressed file. This is why it is good to avoid using the presets -7 ... -9 when there's no real need for them. At -6 and lower, the amount of memory wasted is usually low enough to not matter. β’ CompCPU is a simplified representation of the LZMA2 settings that affect compression speed. The dictionary size affects speed too, so while CompCPU is the same for levels -6 ... -9, higher levels still tend to be a little slower. To get even slower and thus possibly better compression, see --extreme. β’ CompMem contains the compressor memory requirements in the single-threaded mode. It may vary slightly between xz versions. β’ DecMem contains the decompressor memory requirements. That is, the compression settings determine the memory requirements of the decompressor. The exact decompressor memory usage is slightly more than the LZMA2 dictionary size, but the values in the table have been rounded up to the next full MiB. Memory requirements of the multi-threaded mode are significantly higher than that of the single-threaded mode. With the default value of --block-size, each thread needs 3*3*DictSize plus CompMem or DecMem. For example, four threads with preset -6 needs 660β670 MiB of memory. -e, --extreme Use a slower variant of the selected compression preset level (-0 ... -9) to hopefully get a little bit better compression ratio, but with bad luck this can also make it worse. Decompressor memory usage is not affected, but compressor memory usage increases a little at preset levels -0 ... -3. Since there are two presets with dictionary sizes 4 MiB and 8 MiB, the presets -3e and -5e use slightly faster settings (lower CompCPU) than -4e and -6e, respectively. That way no two presets are identical. Preset DictSize CompCPU CompMem DecMem -0e 256 KiB 8 4 MiB 1 MiB -1e 1 MiB 8 13 MiB 2 MiB -2e 2 MiB 8 25 MiB 3 MiB -3e 4 MiB 7 48 MiB 5 MiB -4e 4 MiB 8 48 MiB 5 MiB -5e 8 MiB 7 94 MiB 9 MiB -6e 8 MiB 8 94 MiB 9 MiB -7e 16 MiB 8 186 MiB 17 MiB -8e 32 MiB 8 370 MiB 33 MiB -9e 64 MiB 8 674 MiB 65 MiB For example, there are a total of four presets that use 8 MiB dictionary, whose order from the fastest to the slowest is -5, -6, -5e, and -6e. --fast --best These are somewhat misleading aliases for -0 and -9, respectively. These are provided only for backwards compatibility with LZMA Utils. Avoid using these options. --block-size=size When compressing to the .xz format, split the input data into blocks of size bytes. The blocks are compressed independently from each other, which helps with multi-threading and makes limited random-access decompression possible. This option is typically used to override the default block size in multi- threaded mode, but this option can be used in single-threaded mode too. In multi-threaded mode about three times size bytes will be allocated in each thread for buffering input and output. The default size is three times the LZMA2 dictionary size or 1 MiB, whichever is more. Typically a good value is 2β4 times the size of the LZMA2 dictionary or at least 1 MiB. Using size less than the LZMA2 dictionary size is waste of RAM because then the LZMA2 dictionary buffer will never get fully used. In multi-threaded mode, the sizes of the blocks are stored in the block headers. This size information is required for multi-threaded decompression. In single-threaded mode no block splitting is done by default. Setting this option doesn't affect memory usage. No size information is stored in block headers, thus files created in single-threaded mode won't be identical to files created in multi-threaded mode. The lack of size information also means that xz won't be able decompress the files in multi-threaded mode. --block-list=items When compressing to the .xz format, start a new block with an optional custom filter chain after the given intervals of uncompressed data. The items are a comma-separated list. Each item consists of an optional filter chain number between 0 and 9 followed by a colon (:) and a required size of uncompressed data. Omitting an item (two or more consecutive commas) is a shorthand to use the size and filters of the previous item. If the input file is bigger than the sum of the sizes in items, the last item is repeated until the end of the file. A special value of 0 may be used as the last size to indicate that the rest of the file should be encoded as a single block. An alternative filter chain for each block can be specified in combination with the --filters1=filters ... --filters9=filters options. These options define filter chains with an identifier between 1β9. Filter chain 0 can be used to refer to the default filter chain, which is the same as not specifying a filter chain. The filter chain identifier can be used before the uncompressed size, followed by a colon (:). For example, if one specifies --block-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB then blocks will be created using: β’ The filter chain specified by --filters1 and 2 MiB input β’ The filter chain specified by --filters3 and 2 MiB input β’ The filter chain specified by --filters2 and 4 MiB input β’ The filter chain specified by --filters2 and 4 MiB input β’ The default filter chain and 2 MiB input β’ The default filter chain and 4 MiB input for every block until end of input. If one specifies a size that exceeds the encoder's block size (either the default value in threaded mode or the value specified with --block-size=size), the encoder will create additional blocks while keeping the boundaries specified in items. For example, if one specifies --block-size=10MiB --block-list=5MiB,10MiB,8MiB,12MiB,24MiB and the input file is 80 MiB, one will get 11 blocks: 5, 10, 8, 10, 2, 10, 10, 4, 10, 10, and 1 MiB. In multi-threaded mode the sizes of the blocks are stored in the block headers. This isn't done in single-threaded mode, so the encoded output won't be identical to that of the multi-threaded mode. --flush-timeout=timeout When compressing, if more than timeout milliseconds (a positive integer) has passed since the previous flush and reading more input would block, all the pending input data is flushed from the encoder and made available in the output stream. This can be useful if xz is used to compress data that is streamed over a network. Small timeout values make the data available at the receiving end with a small delay, but large timeout values give better compression ratio. This feature is disabled by default. If this option is specified more than once, the last one takes effect. The special timeout value of 0 can be used to explicitly disable this feature. This feature is not available on non-POSIX systems. This feature is still experimental. Currently xz is unsuitable for decompressing the stream in real time due to how xz does buffering. --memlimit-compress=limit Set a memory usage limit for compression. If this option is specified multiple times, the last one takes effect. If the compression settings exceed the limit, xz will attempt to adjust the settings downwards so that the limit is no longer exceeded and display a notice that automatic adjustment was done. The adjustments are done in this order: reducing the number of threads, switching to single-threaded mode if even one thread in multi-threaded mode exceeds the limit, and finally reducing the LZMA2 dictionary size. When compressing with --format=raw or if --no-adjust has been specified, only the number of threads may be reduced since it can be done without affecting the compressed output. If the limit cannot be met even with the adjustments described above, an error is displayed and xz will exit with exit status 1. The limit can be specified in multiple ways: β’ The limit can be an absolute value in bytes. Using an integer suffix like MiB can be useful. Example: --memlimit-compress=80MiB β’ The limit can be specified as a percentage of total physical memory (RAM). This can be useful especially when setting the XZ_DEFAULTS environment variable in a shell initialization script that is shared between different computers. That way the limit is automatically bigger on systems with more memory. Example: --memlimit-compress=70% β’ The limit can be reset back to its default value by setting it to 0. This is currently equivalent to setting the limit to max (no memory usage limit). For 32-bit xz there is a special case: if the limit would be over 4020 MiB, the limit is set to 4020 MiB. On MIPS32 2000 MiB is used instead. (The values 0 and max aren't affected by this. A similar feature doesn't exist for decompression.) This can be helpful when a 32-bit executable has access to 4 GiB address space (2 GiB on MIPS32) while hopefully doing no harm in other situations. See also the section Memory usage. --memlimit-decompress=limit Set a memory usage limit for decompression. This also affects the --list mode. If the operation is not possible without exceeding the limit, xz will display an error and decompressing the file will fail. See --memlimit-compress=limit for possible ways to specify the limit. --memlimit-mt-decompress=limit Set a memory usage limit for multi-threaded decompression. This can only affect the number of threads; this will never make xz refuse to decompress a file. If limit is too low to allow any multi-threading, the limit is ignored and xz will continue in single-threaded mode. Note that if also --memlimit-decompress is used, it will always apply to both single-threaded and multi- threaded modes, and so the effective limit for multi-threading will never be higher than the limit set with --memlimit-decompress. In contrast to the other memory usage limit options, --memlimit-mt-decompress=limit has a system-specific default limit. xz --info-memory can be used to see the current value. This option and its default value exist because without any limit the threaded decompressor could end up allocating an insane amount of memory with some input files. If the default limit is too low on your system, feel free to increase the limit but never set it to a value larger than the amount of usable RAM as with appropriate input files xz will attempt to use that amount of memory even with a low number of threads. Running out of memory or swapping will not improve decompression performance. See --memlimit-compress=limit for possible ways to specify the limit. Setting limit to 0 resets the limit to the default system-specific value. -M limit, --memlimit=limit, --memory=limit This is equivalent to specifying --memlimit-compress=limit --memlimit-decompress=limit --memlimit-mt-decompress=limit. --no-adjust Display an error and exit if the memory usage limit cannot be met without adjusting settings that affect the compressed output. That is, this prevents xz from switching the encoder from multi-threaded mode to single-threaded mode and from reducing the LZMA2 dictionary size. Even when this option is used the number of threads may be reduced to meet the memory usage limit as that won't affect the compressed output. Automatic adjusting is always disabled when creating raw streams (--format=raw). -T threads, --threads=threads Specify the number of worker threads to use. Setting threads to a special value 0 makes xz use up to as many threads as the processor(s) on the system support. The actual number of threads can be fewer than threads if the input file is not big enough for threading with the given settings or if using more threads would exceed the memory usage limit. The single-threaded and multi-threaded compressors produce different output. Single-threaded compressor will give the smallest file size but only the output from the multi-threaded compressor can be decompressed using multiple threads. Setting threads to 1 will use the single-threaded mode. Setting threads to any other value, including 0, will use the multi-threaded compressor even if the system supports only one hardware thread. (xz 5.2.x used single-threaded mode in this situation.) To use multi-threaded mode with only one thread, set threads to +1. The + prefix has no effect with values other than 1. A memory usage limit can still make xz switch to single-threaded mode unless --no-adjust is used. Support for the + prefix was added in xz 5.4.0. If an automatic number of threads has been requested and no memory usage limit has been specified, then a system-specific default soft limit will be used to possibly limit the number of threads. It is a soft limit in sense that it is ignored if the number of threads becomes one, thus a soft limit will never stop xz from compressing or decompressing. This default soft limit will not make xz switch from multi-threaded mode to single- threaded mode. The active limits can be seen with xz --info-memory. Currently the only threading method is to split the input into blocks and compress them independently from each other. The default block size depends on the compression level and can be overridden with the --block-size=size option. Threaded decompression only works on files that contain multiple blocks with size information in block headers. All large enough files compressed in multi-threaded mode meet this condition, but files compressed in single-threaded mode don't even if --block-size=size has been used. The default value for threads is 0. In xz 5.4.x and older the default is 1. Custom compressor filter chains A custom filter chain allows specifying the compression settings in detail instead of relying on the settings associated to the presets. When a custom filter chain is specified, preset options (-0 ... -9 and --extreme) earlier on the command line are forgotten. If a preset option is specified after one or more custom filter chain options, the new preset takes effect and the custom filter chain options specified earlier are forgotten. A filter chain is comparable to piping on the command line. When compressing, the uncompressed input goes to the first filter, whose output goes to the next filter (if any). The output of the last filter gets written to the compressed file. The maximum number of filters in the chain is four, but typically a filter chain has only one or two filters. Many filters have limitations on where they can be in the filter chain: some filters can work only as the last filter in the chain, some only as a non-last filter, and some work in any position in the chain. Depending on the filter, this limitation is either inherent to the filter design or exists to prevent security issues. A custom filter chain can be specified in two different ways. The options --filters=filters and --filters1=filters ... --filters9=filters allow specifying an entire filter chain in one option using the liblzma filter string syntax. Alternatively, a filter chain can be specified by using one or more individual filter options in the order they are wanted in the filter chain. That is, the order of the individual filter options is significant! When decoding raw streams (--format=raw), the filter chain must be specified in the same order as it was specified when compressing. Any individual filter or preset options specified before the full chain option (--filters=filters) will be forgotten. Individual filters specified after the full chain option will reset the filter chain. Both the full and individual filter options take filter-specific options as a comma-separated list. Extra commas in options are ignored. Every option has a default value, so specify those you want to change. To see the whole filter chain and options, use xz -vv (that is, use --verbose twice). This works also for viewing the filter chain options used by presets. --filters=filters Specify the full filter chain or a preset in a single option. Each filter can be separated by spaces or two dashes (--). filters may need to be quoted on the shell command line so it is parsed as a single option. To denote options, use : or =. A preset can be prefixed with a - and followed with zero or more flags. The only supported flag is e to apply the same options as --extreme. --filters1=filters ... --filters9=filters Specify up to nine additional filter chains that can be used with --block-list. For example, when compressing an archive with executable files followed by text files, the executable part could use a filter chain with a BCJ filter and the text part only the LZMA2 filter. --filters-help Display a help message describing how to specify presets and custom filter chains in the --filters and --filters1=filters ... --filters9=filters options, and exit successfully. --lzma1[=options] --lzma2[=options] Add LZMA1 or LZMA2 filter to the filter chain. These filters can be used only as the last filter in the chain. LZMA1 is a legacy filter, which is supported almost solely due to the legacy .lzma file format, which supports only LZMA1. LZMA2 is an updated version of LZMA1 to fix some practical issues of LZMA1. The .xz format uses LZMA2 and doesn't support LZMA1 at all. Compression speed and ratios of LZMA1 and LZMA2 are practically the same. LZMA1 and LZMA2 share the same set of options: preset=preset Reset all LZMA1 or LZMA2 options to preset. Preset consist of an integer, which may be followed by single- letter preset modifiers. The integer can be from 0 to 9, matching the command line options -0 ... -9. The only supported modifier is currently e, which matches --extreme. If no preset is specified, the default values of LZMA1 or LZMA2 options are taken from the preset 6. dict=size Dictionary (history buffer) size indicates how many bytes of the recently processed uncompressed data is kept in memory. The algorithm tries to find repeating byte sequences (matches) in the uncompressed data, and replace them with references to the data currently in the dictionary. The bigger the dictionary, the higher is the chance to find a match. Thus, increasing dictionary size usually improves compression ratio, but a dictionary bigger than the uncompressed file is waste of memory. Typical dictionary size is from 64 KiB to 64 MiB. The minimum is 4 KiB. The maximum for compression is currently 1.5 GiB (1536 MiB). The decompressor already supports dictionaries up to one byte less than 4 GiB, which is the maximum for the LZMA1 and LZMA2 stream formats. Dictionary size and match finder (mf) together determine the memory usage of the LZMA1 or LZMA2 encoder. The same (or bigger) dictionary size is required for decompressing that was used when compressing, thus the memory usage of the decoder is determined by the dictionary size used when compressing. The .xz headers store the dictionary size either as 2^n or 2^n + 2^(n-1), so these sizes are somewhat preferred for compression. Other sizes will get rounded up when stored in the .xz headers. lc=lc Specify the number of literal context bits. The minimum is 0 and the maximum is 4; the default is 3. In addition, the sum of lc and lp must not exceed 4. All bytes that cannot be encoded as matches are encoded as literals. That is, literals are simply 8-bit bytes that are encoded one at a time. The literal coding makes an assumption that the highest lc bits of the previous uncompressed byte correlate with the next byte. For example, in typical English text, an upper-case letter is often followed by a lower-case letter, and a lower-case letter is usually followed by another lower-case letter. In the US-ASCII character set, the highest three bits are 010 for upper-case letters and 011 for lower-case letters. When lc is at least 3, the literal coding can take advantage of this property in the uncompressed data. The default value (3) is usually good. If you want maximum compression, test lc=4. Sometimes it helps a little, and sometimes it makes compression worse. If it makes it worse, test lc=2 too. lp=lp Specify the number of literal position bits. The minimum is 0 and the maximum is 4; the default is 0. Lp affects what kind of alignment in the uncompressed data is assumed when encoding literals. See pb below for more information about alignment. pb=pb Specify the number of position bits. The minimum is 0 and the maximum is 4; the default is 2. Pb affects what kind of alignment in the uncompressed data is assumed in general. The default means four-byte alignment (2^pb=2^2=4), which is often a good choice when there's no better guess. When the alignment is known, setting pb accordingly may reduce the file size a little. For example, with text files having one-byte alignment (US-ASCII, ISO-8859-*, UTF-8), setting pb=0 can improve compression slightly. For UTF-16 text, pb=1 is a good choice. If the alignment is an odd number like 3 bytes, pb=0 might be the best choice. Even though the assumed alignment can be adjusted with pb and lp, LZMA1 and LZMA2 still slightly favor 16-byte alignment. It might be worth taking into account when designing file formats that are likely to be often compressed with LZMA1 or LZMA2. mf=mf Match finder has a major effect on encoder speed, memory usage, and compression ratio. Usually Hash Chain match finders are faster than Binary Tree match finders. The default depends on the preset: 0 uses hc3, 1β3 use hc4, and the rest use bt4. The following match finders are supported. The memory usage formulas below are rough approximations, which are closest to the reality when dict is a power of two. hc3 Hash Chain with 2- and 3-byte hashing Minimum value for nice: 3 Memory usage: dict * 7.5 (if dict <= 16 MiB); dict * 5.5 + 64 MiB (if dict > 16 MiB) hc4 Hash Chain with 2-, 3-, and 4-byte hashing Minimum value for nice: 4 Memory usage: dict * 7.5 (if dict <= 32 MiB); dict * 6.5 (if dict > 32 MiB) bt2 Binary Tree with 2-byte hashing Minimum value for nice: 2 Memory usage: dict * 9.5 bt3 Binary Tree with 2- and 3-byte hashing Minimum value for nice: 3 Memory usage: dict * 11.5 (if dict <= 16 MiB); dict * 9.5 + 64 MiB (if dict > 16 MiB) bt4 Binary Tree with 2-, 3-, and 4-byte hashing Minimum value for nice: 4 Memory usage: dict * 11.5 (if dict <= 32 MiB); dict * 10.5 (if dict > 32 MiB) mode=mode Compression mode specifies the method to analyze the data produced by the match finder. Supported modes are fast and normal. The default is fast for presets 0β3 and normal for presets 4β9. Usually fast is used with Hash Chain match finders and normal with Binary Tree match finders. This is also what the presets do. nice=nice Specify what is considered to be a nice length for a match. Once a match of at least nice bytes is found, the algorithm stops looking for possibly better matches. Nice can be 2β273 bytes. Higher values tend to give better compression ratio at the expense of speed. The default depends on the preset. depth=depth Specify the maximum search depth in the match finder. The default is the special value of 0, which makes the compressor determine a reasonable depth from mf and nice. Reasonable depth for Hash Chains is 4β100 and 16β1000 for Binary Trees. Using very high values for depth can make the encoder extremely slow with some files. Avoid setting the depth over 1000 unless you are prepared to interrupt the compression in case it is taking far too long. When decoding raw streams (--format=raw), LZMA2 needs only the dictionary size. LZMA1 needs also lc, lp, and pb. --x86[=options] --arm[=options] --armthumb[=options] --arm64[=options] --powerpc[=options] --ia64[=options] --sparc[=options] --riscv[=options] Add a branch/call/jump (BCJ) filter to the filter chain. These filters can be used only as a non-last filter in the filter chain. A BCJ filter converts relative addresses in the machine code to their absolute counterparts. This doesn't change the size of the data but it increases redundancy, which can help LZMA2 to produce 0β15 % smaller .xz file. The BCJ filters are always reversible, so using a BCJ filter for wrong type of data doesn't cause any data loss, although it may make the compression ratio slightly worse. The BCJ filters are very fast and use an insignificant amount of memory. These BCJ filters have known problems related to the compression ratio: β’ Some types of files containing executable code (for example, object files, static libraries, and Linux kernel modules) have the addresses in the instructions filled with filler values. These BCJ filters will still do the address conversion, which will make the compression worse with these files. β’ If a BCJ filter is applied on an archive, it is possible that it makes the compression ratio worse than not using a BCJ filter. For example, if there are similar or even identical executables then filtering will likely make the files less similar and thus compression is worse. The contents of non- executable files in the same archive can matter too. In practice one has to try with and without a BCJ filter to see which is better in each situation. Different instruction sets have different alignment: the executable file must be aligned to a multiple of this value in the input data to make the filter work. Filter Alignment Notes x86 1 32-bit or 64-bit x86 ARM 4 ARM-Thumb 2 ARM64 4 4096-byte alignment is best PowerPC 4 Big endian only IA-64 16 Itanium SPARC 4 RISC-V 2 Since the BCJ-filtered data is usually compressed with LZMA2, the compression ratio may be improved slightly if the LZMA2 options are set to match the alignment of the selected BCJ filter. Examples: β’ IA-64 filter has 16-byte alignment so pb=4,lp=4,lc=0 is good with LZMA2 (2^4=16). β’ RISC-V code has 2-byte or 4-byte alignment depending on whether the file contains 16-bit compressed instructions (the C extension). When 16-bit instructions are used, pb=2,lp=1,lc=3 or pb=1,lp=1,lc=3 is good. When 16-bit instructions aren't present, pb=2,lp=2,lc=2 is the best. readelf -h can be used to check if "RVC" appears on the "Flags" line. β’ ARM64 is always 4-byte aligned so pb=2,lp=2,lc=2 is the best. β’ The x86 filter is an exception. It's usually good to stick to LZMA2's defaults (pb=2,lp=0,lc=3) when compressing x86 executables. All BCJ filters support the same options: start=offset Specify the start offset that is used when converting between relative and absolute addresses. The offset must be a multiple of the alignment of the filter (see the table above). The default is zero. In practice, the default is good; specifying a custom offset is almost never useful. --delta[=options] Add the Delta filter to the filter chain. The Delta filter can be only used as a non-last filter in the filter chain. Currently only simple byte-wise delta calculation is supported. It can be useful when compressing, for example, uncompressed bitmap images or uncompressed PCM audio. However, special purpose algorithms may give significantly better results than Delta + LZMA2. This is true especially with audio, which compresses faster and better, for example, with flac(1). Supported options: dist=distance Specify the distance of the delta calculation in bytes. distance must be 1β256. The default is 1. For example, with dist=2 and eight-byte input A1 B1 A2 B3 A3 B5 A4 B7, the output will be A1 B1 01 02 01 02 01 02. Other options -q, --quiet Suppress warnings and notices. Specify this twice to suppress errors too. This option has no effect on the exit status. That is, even if a warning was suppressed, the exit status to indicate a warning is still used. -v, --verbose Be verbose. If standard error is connected to a terminal, xz will display a progress indicator. Specifying --verbose twice will give even more verbose output. The progress indicator shows the following information: β’ Completion percentage is shown if the size of the input file is known. That is, the percentage cannot be shown in pipes. β’ Amount of compressed data produced (compressing) or consumed (decompressing). β’ Amount of uncompressed data consumed (compressing) or produced (decompressing). β’ Compression ratio, which is calculated by dividing the amount of compressed data processed so far by the amount of uncompressed data processed so far. β’ Compression or decompression speed. This is measured as the amount of uncompressed data consumed (compression) or produced (decompression) per second. It is shown after a few seconds have passed since xz started processing the file. β’ Elapsed time in the format M:SS or H:MM:SS. β’ Estimated remaining time is shown only when the size of the input file is known and a couple of seconds have already passed since xz started processing the file. The time is shown in a less precise format which never has any colons, for example, 2 min 30 s. When standard error is not a terminal, --verbose will make xz print the filename, compressed size, uncompressed size, compression ratio, and possibly also the speed and elapsed time on a single line to standard error after compressing or decompressing the file. The speed and elapsed time are included only when the operation took at least a few seconds. If the operation didn't finish, for example, due to user interruption, also the completion percentage is printed if the size of the input file is known. -Q, --no-warn Don't set the exit status to 2 even if a condition worth a warning was detected. This option doesn't affect the verbosity level, thus both --quiet and --no-warn have to be used to not display warnings and to not alter the exit status. --robot Print messages in a machine-parsable format. This is intended to ease writing frontends that want to use xz instead of liblzma, which may be the case with various scripts. The output with this option enabled is meant to be stable across xz releases. See the section ROBOT MODE for details. --info-memory Display, in human-readable format, how much physical memory (RAM) and how many processor threads xz thinks the system has and the memory usage limits for compression and decompression, and exit successfully. -h, --help Display a help message describing the most commonly used options, and exit successfully. -H, --long-help Display a help message describing all features of xz, and exit successfully -V, --version Display the version number of xz and liblzma in human readable format. To get machine-parsable output, specify --robot before --version. ROBOT MODE The robot mode is activated with the --robot option. It makes the output of xz easier to parse by other programs. Currently --robot is supported only together with --list, --filters-help, --info-memory, and --version. It will be supported for compression and decompression in the future. List mode xz --robot --list uses tab-separated output. The first column of every line has a string that indicates the type of the information found on that line: name This is always the first line when starting to list a file. The second column on the line is the filename. file This line contains overall information about the .xz file. This line is always printed after the name line. stream This line type is used only when --verbose was specified. There are as many stream lines as there are streams in the .xz file. block This line type is used only when --verbose was specified. There are as many block lines as there are blocks in the .xz file. The block lines are shown after all the stream lines; different line types are not interleaved. summary This line type is used only when --verbose was specified twice. This line is printed after all block lines. Like the file line, the summary line contains overall information about the .xz file. totals This line is always the very last line of the list output. It shows the total counts and sizes. The columns of the file lines: 2. Number of streams in the file 3. Total number of blocks in the stream(s) 4. Compressed size of the file 5. Uncompressed size of the file 6. Compression ratio, for example, 0.123. If ratio is over 9.999, three dashes (---) are displayed instead of the ratio. 7. Comma-separated list of integrity check names. The following strings are used for the known check types: None, CRC32, CRC64, and SHA-256. For unknown check types, Unknown-N is used, where N is the Check ID as a decimal number (one or two digits). 8. Total size of stream padding in the file The columns of the stream lines: 2. Stream number (the first stream is 1) 3. Number of blocks in the stream 4. Compressed start offset 5. Uncompressed start offset 6. Compressed size (does not include stream padding) 7. Uncompressed size 8. Compression ratio 9. Name of the integrity check 10. Size of stream padding The columns of the block lines: 2. Number of the stream containing this block 3. Block number relative to the beginning of the stream (the first block is 1) 4. Block number relative to the beginning of the file 5. Compressed start offset relative to the beginning of the file 6. Uncompressed start offset relative to the beginning of the file 7. Total compressed size of the block (includes headers) 8. Uncompressed size 9. Compression ratio 10. Name of the integrity check If --verbose was specified twice, additional columns are included on the block lines. These are not displayed with a single --verbose, because getting this information requires many seeks and can thus be slow: 11. Value of the integrity check in hexadecimal 12. Block header size 13. Block flags: c indicates that compressed size is present, and u indicates that uncompressed size is present. If the flag is not set, a dash (-) is shown instead to keep the string length fixed. New flags may be added to the end of the string in the future. 14. Size of the actual compressed data in the block (this excludes the block header, block padding, and check fields) 15. Amount of memory (in bytes) required to decompress this block with this xz version 16. Filter chain. Note that most of the options used at compression time cannot be known, because only the options that are needed for decompression are stored in the .xz headers. The columns of the summary lines: 2. Amount of memory (in bytes) required to decompress this file with this xz version 3. yes or no indicating if all block headers have both compressed size and uncompressed size stored in them Since xz 5.1.2alpha: 4. Minimum xz version required to decompress the file The columns of the totals line: 2. Number of streams 3. Number of blocks 4. Compressed size 5. Uncompressed size 6. Average compression ratio 7. Comma-separated list of integrity check names that were present in the files 8. Stream padding size 9. Number of files. This is here to keep the order of the earlier columns the same as on file lines. If --verbose was specified twice, additional columns are included on the totals line: 10. Maximum amount of memory (in bytes) required to decompress the files with this xz version 11. yes or no indicating if all block headers have both compressed size and uncompressed size stored in them Since xz 5.1.2alpha: 12. Minimum xz version required to decompress the file Future versions may add new line types and new columns can be added to the existing line types, but the existing columns won't be changed. Filters help xz --robot --filters-help prints the supported filters in the following format: filter:option=<value>,option=<value>... filter Name of the filter option Name of a filter specific option value Numeric value ranges appear as <min-max>. String value choices are shown within < > and separated by a | character. Each filter is printed on its own line. Memory limit information xz --robot --info-memory prints a single line with multiple tab- separated columns: 1. Total amount of physical memory (RAM) in bytes. 2. Memory usage limit for compression in bytes (--memlimit-compress). A special value of 0 indicates the default setting which for single-threaded mode is the same as no limit. 3. Memory usage limit for decompression in bytes (--memlimit-decompress). A special value of 0 indicates the default setting which for single-threaded mode is the same as no limit. 4. Since xz 5.3.4alpha: Memory usage for multi-threaded decompression in bytes (--memlimit-mt-decompress). This is never zero because a system-specific default value shown in the column 5 is used if no limit has been specified explicitly. This is also never greater than the value in the column 3 even if a larger value has been specified with --memlimit-mt-decompress. 5. Since xz 5.3.4alpha: A system-specific default memory usage limit that is used to limit the number of threads when compressing with an automatic number of threads (--threads=0) and no memory usage limit has been specified (--memlimit-compress). This is also used as the default value for --memlimit-mt-decompress. 6. Since xz 5.3.4alpha: Number of available processor threads. In the future, the output of xz --robot --info-memory may have more columns, but never more than a single line. Version xz --robot --version prints the version number of xz and liblzma in the following format: XZ_VERSION=XYYYZZZS LIBLZMA_VERSION=XYYYZZZS X Major version. YYY Minor version. Even numbers are stable. Odd numbers are alpha or beta versions. ZZZ Patch level for stable releases or just a counter for development releases. S Stability. 0 is alpha, 1 is beta, and 2 is stable. S should be always 2 when YYY is even. XYYYZZZS are the same on both lines if xz and liblzma are from the same XZ Utils release. Examples: 4.999.9beta is 49990091 and 5.0.0 is 50000002. EXIT STATUS 0 All is good. 1 An error occurred. 2 Something worth a warning occurred, but no actual errors occurred. Notices (not warnings or errors) printed on standard error don't affect the exit status. ENVIRONMENT xz parses space-separated lists of options from the environment variables XZ_DEFAULTS and XZ_OPT, in this order, before parsing the options from the command line. Note that only options are parsed from the environment variables; all non-options are silently ignored. Parsing is done with getopt_long(3) which is used also for the command line arguments. XZ_DEFAULTS User-specific or system-wide default options. Typically this is set in a shell initialization script to enable xz's memory usage limiter by default. Excluding shell initialization scripts and similar special cases, scripts must never set or unset XZ_DEFAULTS. XZ_OPT This is for passing options to xz when it is not possible to set the options directly on the xz command line. This is the case when xz is run by a script or tool, for example, GNU tar(1): XZ_OPT=-2v tar caf foo.tar.xz foo Scripts may use XZ_OPT, for example, to set script-specific default compression options. It is still recommended to allow users to override XZ_OPT if that is reasonable. For example, in sh(1) scripts one may use something like this: XZ_OPT=${XZ_OPT-"-7e"} export XZ_OPT LZMA UTILS COMPATIBILITY The command line syntax of xz is practically a superset of lzma, unlzma, and lzcat as found from LZMA Utils 4.32.x. In most cases, it is possible to replace LZMA Utils with XZ Utils without breaking existing scripts. There are some incompatibilities though, which may sometimes cause problems. Compression preset levels The numbering of the compression level presets is not identical in xz and LZMA Utils. The most important difference is how dictionary sizes are mapped to different presets. Dictionary size is roughly equal to the decompressor memory usage. Level xz LZMA Utils -0 256 KiB N/A -1 1 MiB 64 KiB -2 2 MiB 1 MiB -3 4 MiB 512 KiB -4 4 MiB 1 MiB -5 8 MiB 2 MiB -6 8 MiB 4 MiB -7 16 MiB 8 MiB -8 32 MiB 16 MiB -9 64 MiB 32 MiB The dictionary size differences affect the compressor memory usage too, but there are some other differences between LZMA Utils and XZ Utils, which make the difference even bigger: Level xz LZMA Utils 4.32.x -0 3 MiB N/A -1 9 MiB 2 MiB -2 17 MiB 12 MiB -3 32 MiB 12 MiB -4 48 MiB 16 MiB -5 94 MiB 26 MiB -6 94 MiB 45 MiB -7 186 MiB 83 MiB -8 370 MiB 159 MiB -9 674 MiB 311 MiB The default preset level in LZMA Utils is -7 while in XZ Utils it is -6, so both use an 8 MiB dictionary by default. Streamed vs. non-streamed .lzma files The uncompressed size of the file can be stored in the .lzma header. LZMA Utils does that when compressing regular files. The alternative is to mark that uncompressed size is unknown and use end-of-payload marker to indicate where the decompressor should stop. LZMA Utils uses this method when uncompressed size isn't known, which is the case, for example, in pipes. xz supports decompressing .lzma files with or without end-of-payload marker, but all .lzma files created by xz will use end-of-payload marker and have uncompressed size marked as unknown in the .lzma header. This may be a problem in some uncommon situations. For example, a .lzma decompressor in an embedded device might work only with files that have known uncompressed size. If you hit this problem, you need to use LZMA Utils or LZMA SDK to create .lzma files with known uncompressed size. Unsupported .lzma files The .lzma format allows lc values up to 8, and lp values up to 4. LZMA Utils can decompress files with any lc and lp, but always creates files with lc=3 and lp=0. Creating files with other lc and lp is possible with xz and with LZMA SDK. The implementation of the LZMA1 filter in liblzma requires that the sum of lc and lp must not exceed 4. Thus, .lzma files, which exceed this limitation, cannot be decompressed with xz. LZMA Utils creates only .lzma files which have a dictionary size of 2^n (a power of 2) but accepts files with any dictionary size. liblzma accepts only .lzma files which have a dictionary size of 2^n or 2^n + 2^(n-1). This is to decrease false positives when detecting .lzma files. These limitations shouldn't be a problem in practice, since practically all .lzma files have been compressed with settings that liblzma will accept. Trailing garbage When decompressing, LZMA Utils silently ignore everything after the first .lzma stream. In most situations, this is a bug. This also means that LZMA Utils don't support decompressing concatenated .lzma files. If there is data left after the first .lzma stream, xz considers the file to be corrupt unless --single-stream was used. This may break obscure scripts which have assumed that trailing garbage is ignored. NOTES Compressed output may vary The exact compressed output produced from the same uncompressed input file may vary between XZ Utils versions even if compression options are identical. This is because the encoder can be improved (faster or better compression) without affecting the file format. The output can vary even between different builds of the same XZ Utils version, if different build options are used. The above means that once --rsyncable has been implemented, the resulting files won't necessarily be rsyncable unless both old and new files have been compressed with the same xz version. This problem can be fixed if a part of the encoder implementation is frozen to keep rsyncable output stable across xz versions. Embedded .xz decompressors Embedded .xz decompressor implementations like XZ Embedded don't necessarily support files created with integrity check types other than none and crc32. Since the default is --check=crc64, you must use --check=none or --check=crc32 when creating files for embedded systems. Outside embedded systems, all .xz format decompressors support all the check types, or at least are able to decompress the file without verifying the integrity check if the particular check is not supported. XZ Embedded supports BCJ filters, but only with the default start offset.
|
Basics Compress the file foo into foo.xz using the default compression level (-6), and remove foo if compression is successful: xz foo Decompress bar.xz into bar and don't remove bar.xz even if decompression is successful: xz -dk bar.xz Create baz.tar.xz with the preset -4e (-4 --extreme), which is slower than the default -6, but needs less memory for compression and decompression (48 MiB and 5 MiB, respectively): tar cf - baz | xz -4e > baz.tar.xz A mix of compressed and uncompressed files can be decompressed to standard output with a single command: xz -dcf a.txt b.txt.xz c.txt d.txt.lzma > abcd.txt Parallel compression of many files On GNU and *BSD, find(1) and xargs(1) can be used to parallelize compression of many files: find . -type f \! -name '*.xz' -print0 \ | xargs -0r -P4 -n16 xz -T1 The -P option to xargs(1) sets the number of parallel xz processes. The best value for the -n option depends on how many files there are to be compressed. If there are only a couple of files, the value should probably be 1; with tens of thousands of files, 100 or even more may be appropriate to reduce the number of xz processes that xargs(1) will eventually create. The option -T1 for xz is there to force it to single-threaded mode, because xargs(1) is used to control the amount of parallelization. Robot mode Calculate how many bytes have been saved in total after compressing multiple files: xz --robot --list *.xz | awk '/^totals/{print $5-$4}' A script may want to know that it is using new enough xz. The following sh(1) script checks that the version number of the xz tool is at least 5.0.0. This method is compatible with old beta versions, which didn't support the --robot option: if ! eval "$(xz --robot --version 2> /dev/null)" || [ "$XZ_VERSION" -lt 50000002 ]; then echo "Your xz is too old." fi unset XZ_VERSION LIBLZMA_VERSION Set a memory usage limit for decompression using XZ_OPT, but if a limit has already been set, don't increase it: NEWLIM=$((123 << 20)) # 123 MiB OLDLIM=$(xz --robot --info-memory | cut -f3) if [ $OLDLIM -eq 0 -o $OLDLIM -gt $NEWLIM ]; then XZ_OPT="$XZ_OPT --memlimit-decompress=$NEWLIM" export XZ_OPT fi Custom compressor filter chains The simplest use for custom filter chains is customizing a LZMA2 preset. This can be useful, because the presets cover only a subset of the potentially useful combinations of compression settings. The CompCPU columns of the tables from the descriptions of the options -0 ... -9 and --extreme are useful when customizing LZMA2 presets. Here are the relevant parts collected from those two tables: Preset CompCPU -0 0 -1 1 -2 2 -3 3 -4 4 -5 5 -6 6 -5e 7 -6e 8 If you know that a file requires somewhat big dictionary (for example, 32 MiB) to compress well, but you want to compress it quicker than xz -8 would do, a preset with a low CompCPU value (for example, 1) can be modified to use a bigger dictionary: xz --lzma2=preset=1,dict=32MiB foo.tar With certain files, the above command may be faster than xz -6 while compressing significantly better. However, it must be emphasized that only some files benefit from a big dictionary while keeping the CompCPU value low. The most obvious situation, where a big dictionary can help a lot, is an archive containing very similar files of at least a few megabytes each. The dictionary size has to be significantly bigger than any individual file to allow LZMA2 to take full advantage of the similarities between consecutive files. If very high compressor and decompressor memory usage is fine, and the file being compressed is at least several hundred megabytes, it may be useful to use an even bigger dictionary than the 64 MiB that xz -9 would use: xz -vv --lzma2=dict=192MiB big_foo.tar Using -vv (--verbose --verbose) like in the above example can be useful to see the memory requirements of the compressor and decompressor. Remember that using a dictionary bigger than the size of the uncompressed file is waste of memory, so the above command isn't useful for small files. Sometimes the compression time doesn't matter, but the decompressor memory usage has to be kept low, for example, to make it possible to decompress the file on an embedded system. The following command uses -6e (-6 --extreme) as a base and sets the dictionary to only 64 KiB. The resulting file can be decompressed with XZ Embedded (that's why there is --check=crc32) using about 100 KiB of memory. xz --check=crc32 --lzma2=preset=6e,dict=64KiB foo If you want to squeeze out as many bytes as possible, adjusting the number of literal context bits (lc) and number of position bits (pb) can sometimes help. Adjusting the number of literal position bits (lp) might help too, but usually lc and pb are more important. For example, a source code archive contains mostly US-ASCII text, so something like the following might give slightly (like 0.1 %) smaller file than xz -6e (try also without lc=4): xz --lzma2=preset=6e,pb=0,lc=4 source_code.tar Using another filter together with LZMA2 can improve compression with certain file types. For example, to compress a x86-32 or x86-64 shared library using the x86 BCJ filter: xz --x86 --lzma2 libfoo.so Note that the order of the filter options is significant. If --x86 is specified after --lzma2, xz will give an error, because there cannot be any filter after LZMA2, and also because the x86 BCJ filter cannot be used as the last filter in the chain. The Delta filter together with LZMA2 can give good results with bitmap images. It should usually beat PNG, which has a few more advanced filters than simple delta but uses Deflate for the actual compression. The image has to be saved in uncompressed format, for example, as uncompressed TIFF. The distance parameter of the Delta filter is set to match the number of bytes per pixel in the image. For example, 24-bit RGB bitmap needs dist=3, and it is also good to pass pb=0 to LZMA2 to accommodate the three-byte alignment: xz --delta=dist=3 --lzma2=pb=0 foo.tiff If multiple images have been put into a single archive (for example, .tar), the Delta filter will work on that too as long as all images have the same number of bytes per pixel. SEE ALSO xzdec(1), xzdiff(1), xzgrep(1), xzless(1), xzmore(1), gzip(1), bzip2(1), 7z(1) XZ Utils: <https://tukaani.org/xz/> XZ Embedded: <https://tukaani.org/xz/embedded.html> LZMA SDK: <https://7-zip.org/sdk.html> Tukaani 2024-04-08 XZ(1)
|
qtplugininfo
| null | null | null | null | null |
rst2man.py
| null | null | null | null | null |
tiffcomment
| null | null | null | null | null |
qmlscene
| null | null | null | null | null |
nmedit
|
Nmedit changes the global symbols not listed in the list_file file of the -s list_file option to static symbols. Undefined symbols and common symbols are not affected and shouldn't be listed in list_file. For dynamic libraries symbols are turned into private extern symbols that are no longer external (rather than static symbols). This is done so that the references between modules of a dynamic library are resolved to the symbols in the dynamic library. Nmedit differs from strip(1) in that it also changes the symbolic debugging information (produce by the -g option to cc(1)) for the global symbols it changes to static symbols so that the resulting object can still be used with the debugger. Nmedit like strip(1) is useful to limit the symbols for use with later linking. This allows control of the interface that the executable wants to provide to the objects that it will dynamically load, and it will not have to publish symbols that are not part of its interface. For example an executable that wishes to allow only a subset of its global symbols but all of the shared libraries globals to be used would have its symbol table edited with: % nmedit -s interface_symbols -A executable where the file interface_symbols would contain only those symbols from the executable that it wishes the objects loaded at runtime to have access to. Another example is an object that is made up of a number of other objects that will be loaded into an executable would built and then have its symbol table edited with: % ld -o relocatable.o -r a.o b.o c.o % nmedit -s interface_symbols relocatable.o which would leave only the symbols listed in the file interface_symbols (and the undefined and common symbols) as global symbols in the object file. The one or more of the following options is required to nmedit(1) is: -s filename Leave the symbol table entries for the global symbols listed in filename global but turn all other global symbols (except undefined and common symbols) into static symbols. 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. -R filename Change the symbol table entries for the global symbols listed in filename into static symbols. This file has the same format as the -s filename option above. If the -R filename option is specified without the -s filename option, then all symbols not listed in the -R filename option's filename are left as globals. If both a -R filename and a -s filename are given the symbols listed in the -R filename are basically ignored and only those symbols listed in the -s filename are saved. -p Change symbols to private externs instead of static. This is allowed as the only option to change all defined global symbols to private externs. The options to nmedit(1) are: -A Leave all global absolute symbols except those with a value of zero, and save objective-C class symbols as globals. This is intended for use of programs that load code at runtime and want the loaded code to use symbols from the shared libraries. -D When editing a static library, set the archive's SYMDEF file's user id, group id, date, and file mode to reasonable defaults. See the libtool(1) documentation for -D for more information. - Treat all remaining arguments as file names and not options. -arch arch_type Specifies the architecture, arch_type, of the file for nmedit(1) to process when the file is a universal file (see arch(3) for the currently know arch_types). The arch_type can be all to process all architectures in the file. The default is to process all architectures that are contained in the file. -o output Write the result into the file output. SEE ALSO strip(1), ld(1), libtool(1), arch(3) BUGS The changing of the symbolic debugging information by nmedit is not known to be totally correct and could cause the debugger to crash, get confused or produce incorrect information. Apple Inc. May 29, 2007 NMEDIT(1)
|
nmedit - change global symbols to local symbols
|
nmedit -s list_file [-R list_file] [-p] [-A] [-] [[-arch arch_type] ...] object_file ... [-o output]
| null | null |
arm64-apple-darwin20.0.0-lipo
|
The lipo tool creates or operates on ``universal'' (multi-architecture) files. Generally, lipo reads a single input file and writes to a single output file, although some commands and options accept multiple input files. lipo will only ever write to a single output file, and input files are never modified in place. lipo supports a number of commands for creating universal files from single-architecture files, extracting single-architecture files from universal files, and displaying architecture information. lipo can only perform one such command at a time, although some command flags may appear more than once. Some commands support additional options that can be used with that command. In addition, there are global options that are supported by multiple commands. The arch_type arguments may be any of the supported architecture names listed in the man page arch(3). COMMANDS -archs Display only the architecture names present in a single input file. Each architecture name is a single word, making this option suitable for shell scripting. Unknown architectures will be represented by "unknown" along with the numeric CPU type and CPU subtype values as a single word. -create [-arch_blank arch_type ...] Create one universal output file from one or more input files. When input files specified on the command-line, all of the architectures in each file will be copied into the output file, whereas when input files are included using the global -arch option, only the specified architecture will be copied from that input file. The -arch_blank option specifies that the output for the specified arch_type will be an MH_DYLIB_STUB file. This command requires the -output option. -detailed_info Display a detailed list of the architecture types in the input universal file (all the the information in the universal header, for each architecture in the file). -extract arch_type [-extract arch_type...] Take one universal input file and copy the arch_type from that universal file into a universal output file containing only that architecture. This command requires the -output option. -extract_family arch_type [-extract_family arch_type...] Take one universal input file and copy all of the arch_types for the family that arch_type is in from that universal file into an output file containing only those architectures. The file will be thin if only one architecture is found or universal otherwise. This command requires the -output option. -info Display a brief description of each input file along with the names of each architecture type in that input file. -remove arch_type [-remove arch_type ...] Take one universal input file and remove the arch_type from that universal file, placing the result in the output file. This command requires the -output option. -replace arch_type file_name [-replace arch_type file_name...] Take one universal input file; in the output file, replace the arch_type contents of the input file with the contents of the specified file_name. This command requires the -output option. -thin arch_type Take one input file and create a thin output file with the specified arch_type. This command requires the -output option. -verify_arch arch_type ... Take one input file and verify the specified arch_types are present in the file. If so then exit with a status of 0 else exit with a status of 1. Because more than one arch_type can be verified at once, all of the input files must appear before the -verify_arch flag on the command-line.
|
lipo - create or operate on universal files
|
lipo input_file command [option...]
|
-arch arch_type input_file Tells lipo that input_file contains the specified architecture type. The -arch arch_type specification is unnecessary if input_file is an object file, a universal file, or some other file whose architecture(s) lipo can figure out. -hideARM64 When creating a universal binary including both 32-bit and 64-bit ARM files, this option will ask lipo to add the 64-bit files at the end and not include them in the count of architectures present in the file. The files must be executable files (Mach-O filetype MH_EXECUTE). This option has no effect if neither 32-bit ARM nor 64-bit ARM files are present, and no other files may be hidden in this way. This option only works with the -create, -remove, and -replace, commands, and is only intended for tools and workflows testing a workaround on older systems. -output output_file Commands that create new files write to the output file specified by the -output flag. This option is required for the -create, -extract, -extract_family, -remove, -replace, and -thin commands. -segalign arch_type value Set the segment alignment of the specified arch_type when creating a universal file containing that architecture. value is a hexadecimal number that must be an integral power of 2. This is only needed when lipo can't figure out the alignment of an input file (currently not an object file), or when it guesses at the alignment too conservatively. The default for files unknown to lipo is 0 (2^0, or an alignment of one byte), and the default alignment for archives is 4 (2^2, or 4-byte alignment). SEE ALSO arch(3) Apple Computer, Inc. August 31, 2018 LIPO(1)
| null |
arm64-apple-darwin20.0.0-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. -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 |
qmlpreview
| null | null | null | null | null |
qtpy
| null | null | null | null | null |
curve_keygen
| null | null | null | null | null |
py.test
| null | null | null | null | null |
sphinx-quickstart
| null | null | null | null | null |
pyftmerge
| null | null | null | null | null |
klist
|
klist lists the Kerberos principal and Kerberos tickets held in a credentials cache, or the keys held in a keytab file.
|
klist - list cached Kerberos tickets
|
klist [-e] [[-c] [-l] [-A] [-f] [-s] [-a [-n]]] [-C] [-k [-i] [-t] [-K]] [-V] [-d] [cache_name|keytab_name]
|
-e Displays the encryption types of the session key and the ticket for each credential in the credential cache, or each key in the keytab file. -l If a cache collection is available, displays a table summarizing the caches present in the collection. -A If a cache collection is available, displays the contents of all of the caches in the collection. -c List tickets held in a credentials cache. This is the default if neither -c nor -k is specified. -f Shows the flags present in the credentials, using the following abbreviations: F Forwardable f forwarded P Proxiable p proxy D postDateable d postdated R Renewable I Initial i invalid H Hardware authenticated A preAuthenticated T Transit policy checked O Okay as delegate a anonymous -s Causes klist to run silently (produce no output). klist will exit with status 1 if the credentials cache cannot be read or is expired, and with status 0 otherwise. -a Display list of addresses in credentials. -n Show numeric addresses instead of reverse-resolving addresses. -C List configuration data that has been stored in the credentials cache when klist encounters it. By default, configuration data is not listed. -k List keys held in a keytab file. -i In combination with -k, defaults to using the default client keytab instead of the default acceptor keytab, if no name is given. -t Display the time entry timestamps for each keytab entry in the keytab file. -K Display the value of the encryption key in each keytab entry in the keytab file. -d Display the authdata types (if any) for each entry. -V Display the Kerberos version number and exit. If cache_name or keytab_name is not specified, klist will display the credentials in the default credentials cache or keytab file as appropriate. If the KRB5CCNAME environment variable is set, its value is used to locate the default ticket cache. 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 file. SEE ALSO kinit(1), kdestroy(1), kerberos(7) AUTHOR MIT COPYRIGHT 1985-2022, MIT 1.20.1 KLIST(1)
| null |
mysql_upgrade
|
Note The MySQL server performs the upgrade tasks previously handled by mysql_upgrade (for details, see Section 2.10.3, βWhat the MySQL Upgrade Process Upgradesβ). Consequently, mysql_upgrade is unneeded and is deprecated; expect it to be removed in a future version of MySQL. Because mysql_upgrade no longer performs upgrade tasks, it exits with status 0 unconditionally. COPYRIGHT Copyright Β© 1997, 2023, Oracle and/or its affiliates. This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/. SEE ALSO For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/. AUTHOR Oracle Corporation (http://dev.mysql.com/). MySQL 8.3 11/23/2023 MYSQL_UPGRADE(1)
|
mysql_upgrade - Deprecated; performs no tasks and exists with status 0
|
mysql_upgrade
| null | null |
mysqltest
| null | null | null | null | null |
rdjpgcom
|
rdjpgcom reads the named JPEG/JFIF file, or the standard input if no file is named, and prints any text comments found in the file on the standard output. The JPEG standard allows "comment" (COM) blocks to occur within a JPEG file. Although the standard doesn't actually define what COM blocks are for, they are widely used to hold user-supplied text strings. This lets you add annotations, titles, index terms, etc to your JPEG files, and later retrieve them as text. COM blocks do not interfere with the image stored in the JPEG file. The maximum size of a COM block is 64K, but you can have as many of them as you like in one JPEG file.
|
rdjpgcom - display text comments from a JPEG file
|
rdjpgcom [ -raw ] [ -verbose ] [ filename ]
|
-raw Normally rdjpgcom escapes non-printable characters in comments, for security reasons. This option avoids that. -verbose Causes rdjpgcom to also display the JPEG image dimensions. Switch names may be abbreviated, and are not case sensitive. HINTS rdjpgcom does not depend on the IJG JPEG library. Its source code is intended as an illustration of the minimum amount of code required to parse a JPEG file header correctly. In -verbose mode, rdjpgcom will also attempt to print the contents of any "APP12" markers as text. Some digital cameras produce APP12 markers containing useful textual information. If you like, you can modify the source code to print other APPn marker types as well. SEE ALSO cjpeg(1), djpeg(1), jpegtran(1), wrjpgcom(1) AUTHOR Independent JPEG Group 02 April 2009 RDJPGCOM(1)
| null |
gst-launch-1.0
|
gst-launch-1.0 is a tool that builds and runs basic GStreamer pipelines. In simple form, a PIPELINE-DESCRIPTION is a list of elements separated by exclamation marks (!). Properties may be appended to elements, in the form property=value. For a complete description of possible PIPELINE-DESCRIPTIONS see the section pipeline description below or consult the GStreamer documentation. Please note that gst-launch-1.0 is primarily a debugging tool for developers and users. You should not build applications on top of it. For applications, use the gst_parse_launch() function of the GStreamer API as an easy way to construct pipelines from pipeline descriptions.
|
gst-launch-1.0 - build and run a GStreamer pipeline
|
gst-launch-1.0 [OPTION...] PIPELINE-DESCRIPTION
|
gst-launch-1.0 accepts the following options: --help Print help synopsis and available FLAGS -v, --verbose Output status information and property notifications -q, --quiet Do not print any progress information -m, --messages Output messages posted on the pipeline's bus -t, --tags Output tags (also known as metadata) -e, --eos-on-shutdown Force an EOS event on sources before shutting the pipeline down. This is useful to make sure muxers create readable files when a muxing pipeline is shut down forcefully via Control-C. -i, --index Gather and print index statistics. This is mostly useful for playback or recording pipelines. -f, --no-fault Do not install a fault handler -T, --trace Print memory allocation traces. The feature must be enabled at compile time to work. GSTREAMER OPTIONS gst-launch-1.0 also accepts the following options that are common to all GStreamer applications: --gst-version Prints the version string of the GStreamer core library. --gst-fatal-warnings Causes GStreamer to abort if a warning message occurs. This is equivalent to setting the environment variable G_DEBUG to 'fatal_warnings' (see the section environment variables below for further information). --gst-debug=STRING A comma separated list of category_name:level pairs to specify debugging levels for each category. Level is in the range 0-9 where 0 will show no messages, and 9 will show all messages. The wildcard * can be used to match category names. Note that the order of categories and levels is important, wildcards at the end may override levels set earlier. The log levels are: 1=ERROR, 2=WARNING, 3=FIXME, 4=INFO, 5=DEBUG, 6=LOG, 7=TRACE, 9=MEMDUMP. Since GStreamer 1.2 one can also use the debug level names, e.g. --gst-debug=*sink:LOG. A full description of the various debug levels can be found in the GStreamer core library API documentation, in the "Running GStreamer Applications" section. Use --gst-debug-help to show category names Example: GST_CAT:5,GST_ELEMENT_*:3,oggdemux:5 --gst-debug-level=LEVEL Sets the threshold for printing debugging messages. A higher level will print more messages. The useful range is 0-9, with the default being 0. Level 6 (LOG level) will show all information that is usually required for debugging purposes. Higher levels are only useful in very specific cases. See above for the full list of levels. --gst-debug-no-color GStreamer normally prints debugging messages so that the messages are color-coded when printed to a terminal that handles ANSI escape sequences. Using this option causes GStreamer to print messages without color. Setting the GST_DEBUG_NO_COLOR environment variable will achieve the same thing. --gst-debug-color-mode GStreamer normally prints debugging messages so that the messages are color-coded when printed to a terminal that handles ANSI escape sequences (on *nix), or uses W32 console API to color the messages printed into a console (on W32). Using this option causes GStreamer to print messages without color ('off' or 'disable'), print messages with default colors ('on' or 'auto'), or print messages using ANSI escape sequences for coloring ('unix'). Setting the GST_DEBUG_COLOR_MODE environment variable will achieve the same thing. --gst-debug-disable Disables debugging. --gst-debug-help Prints a list of available debug categories and their default debugging level. --gst-plugin-spew GStreamer info flags to set Enable printout of errors while loading GStreamer plugins --gst-plugin-path=PATH Add directories separated with ':' to the plugin search path --gst-plugin-load=PLUGINS Preload plugins specified in a comma-separated list. Another way to specify plugins to preload is to use the environment variable GST_PLUGIN_PATH PIPELINE DESCRIPTION A pipeline consists elements and links. Elements can be put into bins of different sorts. Elements, links and bins can be specified in a pipeline description in any order. Elements ELEMENTTYPE [PROPERTY1 ...] Creates an element of type ELEMENTTYPE and sets the PROPERTIES. Properties PROPERTY=VALUE ... Sets the property to the specified value. You can use gst-inspect-1.0(1) to find out about properties and allowed values of different elements. Enumeration properties can be set by name, nick or value. Bins [BINTYPE.] ( [PROPERTY1 ...] PIPELINE-DESCRIPTION ) Specifies that a bin of type BINTYPE is created and the given properties are set. Every element between the braces is put into the bin. Please note the dot that has to be used after the BINTYPE. You will almost never need this functionality, it is only really useful for applications using the gst_launch_parse() API with 'bin' as bintype. That way it is possible to build partial pipelines instead of a full- fledged top-level pipeline. Links [[SRCELEMENT].[PAD1,...]] ! [[SINKELEMENT].[PAD1,...]] [[SRCELEMENT].[PAD1,...]] ! CAPS ! [[SINKELEMENT].[PAD1,...]] [[SRCELEMENT].[PAD1,...]] : [[SINKELEMENT].[PAD1,...]] [[SRCELEMENT].[PAD1,...]] : CAPS : [[SINKELEMENT].[PAD1,...]] Links the element with name SRCELEMENT to the element with name SINKELEMENT, using the caps specified in CAPS as a filter. Names can be set on elements with the name property. If the name is omitted, the element that was specified directly in front of or after the link is used. This works across bins. If a padname is given, the link is done with these pads. If no pad names are given all possibilities are tried and a matching pad is used. If multiple padnames are given, both sides must have the same number of pads specified and multiple links are done in the given order. So the simplest link is a simple exclamation mark, that links the element to the left of it to the element right of it. Linking using the : operator attempts to link all possible pads between the elements Caps MEDIATYPE [, PROPERTY[, PROPERTY ...]]] [; CAPS[; CAPS ...]] Creates a capability with the given media type and optionally with given properties. The media type can be escaped using " or '. If you want to chain caps, you can add more caps in the same format afterwards. Properties NAME=[(TYPE)]VALUE in lists and ranges: [(TYPE)]VALUE Sets the requested property in capabilities. The name is an alphanumeric value and the type can have the following case-insensitive values: - i or int for integer values or ranges - f or float for float values or ranges - b, bool or boolean for boolean values - s, str or string for strings - fraction for fractions (framerate, pixel-aspect-ratio) - l or list for lists If no type was given, the following order is tried: integer, float, boolean, string. Integer values must be parsable by strtol(), floats by strtod(). FOURCC values may either be integers or strings. Boolean values are (case insensitive) yes, no, true or false and may like strings be escaped with " or '. Ranges are in this format: [ VALUE, VALUE ] Lists use this format: { VALUE [, VALUE ...] } PIPELINE EXAMPLES The examples below assume that you have the correct plug-ins available. In general, "pulsesink" can be substituted with another audio output plug-in such as "alsasink" or "osxaudiosink" Likewise, "xvimagesink" can be substituted with "ximagesink", "glimagesink", or "osxvideosink". Keep in mind though that different sinks might accept different formats and even the same sink might accept different formats on different machines, so you might need to add converter elements like audioconvert and audioresample (for audio) or videoconvert (for video) in front of the sink to make things work. Audio playback Play the mp3 music file "music.mp3" using a libmpg123-based plug-in and output to an Pulseaudio device gst-launch-1.0 filesrc location=music.mp3 ! mpegaudioparse ! mpg123audiodec ! audioconvert ! audioresample ! pulsesink Play an Ogg Vorbis format file gst-launch-1.0 filesrc location=music.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! pulsesink Play an mp3 file or an http stream using GIO gst-launch-1.0 giosrc location=music.mp3 ! mpegaudioparse ! mpg123audiodec ! audioconvert ! pulsesink gst-launch-1.0 giosrc location=http://domain.com/music.mp3 ! mpegaudioparse ! mpg123audiodec ! audioconvert ! audioresample ! pulsesink Use GIO to play an mp3 file located on an SMB server gst-launch-1.0 giosrc location=smb://computer/music.mp3 ! mpegaudioparse ! mpg123audiodec ! audioconvert ! audioresample ! pulsesink Format conversion Convert an mp3 music file to an Ogg Vorbis file gst-launch-1.0 filesrc location=music.mp3 ! mpegaudioparse ! mpg123audiodec ! audioconvert ! vorbisenc ! oggmux ! filesink location=music.ogg Convert to the FLAC format gst-launch-1.0 filesrc location=music.mp3 ! mpegaudioparse ! mpg123audiodec ! audioconvert ! flacenc ! filesink location=test.flac Other Plays a .WAV file that contains raw audio data (PCM). gst-launch-1.0 filesrc location=music.wav ! wavparse ! audioconvert ! audioresample ! pulsesink Convert a .WAV file containing raw audio data into an Ogg Vorbis or mp3 file gst-launch-1.0 filesrc location=music.wav ! wavparse ! audioconvert ! vorbisenc ! oggmux ! filesink location=music.ogg gst-launch-1.0 filesrc location=music.wav ! wavparse ! audioconvert ! lamemp3enc ! filesink location=music.mp3 Rips all tracks from compact disc and convert them into a single mp3 file gst-launch-1.0 cdparanoiasrc mode=continuous ! audioconvert ! lamemp3enc ! mpegaudioparse ! id3v2mux ! filesink location=cd.mp3 Rips track 5 from the CD and converts it into a single mp3 file gst-launch-1.0 cdparanoiasrc track=5 ! audioconvert ! lamemp3enc ! mpegaudioparse ! id3v2mux ! filesink location=track5.mp3 Using gst-inspect-1.0(1), it is possible to discover settings like the above for cdparanoiasrc that will tell it to rip the entire cd or only tracks of it. Alternatively, you can use an URI and gst-launch-1.0 will find an element (such as cdparanoia) that supports that protocol for you, e.g.: gst-launch-1.0 cdda://5 ! lamemp3enc vbr=new vbr-quality=6 ! filesink location=track5.mp3 Records sound from your audio input and encodes it into an ogg file gst-launch-1.0 pulsesrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=input.ogg Video Display only the video portion of an MPEG-1 video file, outputting to an X display window gst-launch-1.0 filesrc location=JB_FF9_TheGravityOfLove.mpg ! dvddemux ! mpegvideoparse ! mpeg2dec ! xvimagesink Display the video portion of a .vob file (used on DVDs), outputting to an SDL window gst-launch-1.0 filesrc location=/flflfj.vob ! dvddemux ! mpegvideoparse ! mpeg2dec ! sdlvideosink Play both video and audio portions of an MPEG movie gst-launch-1.0 filesrc location=movie.mpg ! dvddemux name=demuxer demuxer. ! queue ! mpegvideoparse ! mpeg2dec ! sdlvideosink demuxer. ! queue ! mpegaudioparse ! mpg123audiodec ! audioconvert ! audioresample ! pulsesink Play an AVI movie with an external text subtitle stream gst-launch-1.0 filesrc location=movie.mpg ! mpegdemux name=demuxer demuxer. ! queue ! mpegvideoparse ! mpeg2dec ! videoconvert ! sdlvideosink demuxer. ! queue ! mpegaudioparse ! mpg123audiodec ! audioconvert ! audioresample ! pulsesink This example also shows how to refer to specific pads by name if an element (here: textoverlay) has multiple sink or source pads. gst-launch-1.0 textoverlay name=overlay ! videoconvert ! videoscale ! autovideosink filesrc location=movie.avi ! decodebin ! videoconvert ! overlay.video_sink filesrc location=movie.srt ! subparse ! overlay.text_sink Play an AVI movie with an external text subtitle stream using playbin gst-launch-1.0 playbin uri=file:///path/to/movie.avi suburi=file:///path/to/movie.srt Network streaming Stream video using RTP and network elements. This command would be run on the transmitter gst-launch-1.0 v4l2src ! video/x-raw,width=128,height=96,format=UYVY ! videoconvert ! ffenc_h263 ! video/x-h263 ! rtph263ppay pt=96 ! udpsink host=192.168.1.1 port=5000 Use this command on the receiver gst-launch-1.0 udpsrc port=5000 ! application/x-rtp, clock-rate=90000,payload=96 ! rtph263pdepay queue-delay=0 ! ffdec_h263 ! xvimagesink Diagnostic Generate a null stream and ignore it (and print out details). gst-launch-1.0 -v fakesrc num-buffers=16 ! fakesink Generate a pure sine tone to test the audio output gst-launch-1.0 audiotestsrc ! audioconvert ! audioresample ! pulsesink Generate a familiar test pattern to test the video output gst-launch-1.0 videotestsrc ! xvimagesink gst-launch-1.0 videotestsrc ! ximagesink Automatic linking You can use the decodebin element to automatically select the right elements to get a working pipeline. Play any supported audio format gst-launch-1.0 filesrc location=musicfile ! decodebin ! audioconvert ! audioresample ! pulsesink Play any supported video format with video and audio output. Threads are used automatically. To make this even easier, you can use the playbin element: gst-launch-1.0 filesrc location=videofile ! decodebin name=decoder decoder. ! queue ! audioconvert ! audioresample ! pulsesink decoder. ! videoconvert ! xvimagesink gst-launch-1.0 playbin uri=file:///home/joe/foo.avi Filtered connections These examples show you how to use filtered caps. Show a test image and use the YUY2 or YV12 video format for this. gst-launch-1.0 videotestsrc ! 'video/x-raw,format=YUY2;video/x-raw,format=YV12' ! xvimagesink Record audio and write it to a .wav file. Force usage of signed 16 to 32 bit samples and a sample rate between 32kHz and 64KHz. gst-launch-1.0 pulsesrc ! 'audio/x-raw,rate=[32000,64000],format={S16LE,S24LE,S32LE}' ! wavenc ! filesink location=recording.wav ENVIRONMENT VARIABLES GST_DEBUG Comma-separated list of debug categories and levels (e.g. GST_DEBUG=totem:4,typefind:5). '*' is allowed as a wildcard as part of debug category names (e.g. GST_DEBUG=*sink:6,*audio*:6). Since 1.2.0 it is also possible to specify the log level by name (1=ERROR, 2=WARN, 3=FIXME, 4=INFO, 5=DEBUG, 6=LOG, 7=TRACE, 9=MEMDUMP) (e.g. GST_DEBUG=*audio*:LOG) GST_DEBUG_NO_COLOR When this environment variable is set, coloured debug output is disabled. GST_DEBUG_DUMP_DOT_DIR When set to a filesystem path, store 'dot' files of pipeline graphs there. These can then later be converted into an image using the 'dot' utility from the graphviz set of tools, like this: dot foo.dot -Tsvg -o foo.svg (png or jpg are also possible as output format). There is also a utility called 'xdot' which allows you to view the .dot file directly without converting it first. When the pipeline changes state through NULL to PLAYING and back to NULL, a dot file is generated on each state change. To write a snapshot of the pipeline state, send a SIGHUP to the process. GST_REGISTRY Path of the plugin registry file. Default is ~/.cache/gstreamer-1.0/registry-CPU.bin where CPU is the machine/cpu type GStreamer was compiled for, e.g. 'i486', 'i686', 'x86-64', 'ppc', etc. (check the output of "uname -i" and "uname -m" for details). GST_REGISTRY_UPDATE Set to "no" to force GStreamer to assume that no plugins have changed, been added or been removed. This will make GStreamer skip the initial check whether a rebuild of the registry cache is required or not. This may be useful in embedded environments where the installed plugins never change. Do not use this option in any other setup. GST_PLUGIN_PATH Specifies a list of directories to scan for additional plugins. These take precedence over the system plugins. GST_PLUGIN_SYSTEM_PATH Specifies a list of plugins that are always loaded by default. If not set, this defaults to the system-installed path, and the plugins installed in the user's home directory GST_DEBUG_FILE Set this variable to a file path to redirect all GStreamer debug messages to this file. If left unset, debug messages with be output unto the standard error. ORC_CODE Useful Orc environment variable. Set ORC_CODE=debug to enable debuggers such as gdb to create useful backtraces from Orc- generated code. Set ORC_CODE=backup or ORC_CODE=emulate if you suspect Orc's SIMD code generator is producing incorrect code. (Quite a few important GStreamer plugins like videotestsrc, audioconvert or audioresample use Orc). G_DEBUG Useful GLib environment variable. Set G_DEBUG=fatal_warnings to make GStreamer programs abort when a critical warning such as an assertion failure occurs. This is useful if you want to find out which part of the code caused that warning to be triggered and under what circumstances. Simply set G_DEBUG as mentioned above and run the program in gdb (or let it core dump). Then get a stack trace in the usual way. FILES ~/.cache/gstreamer-1.0/registry-*.bin The plugin cache; can be deleted at any time, will be re- created automatically when it does not exist yet or plugins change. Based on XDG_CACHE_DIR, so may be in a different location than the one suggested. SEE ALSO gst-inspect-1.0(1), gst-launch-1.0(1), AUTHOR The GStreamer team at http://gstreamer.freedesktop.org/ May 2007 GStreamer(1)
| null |
python3.11-config
| null | null | null | null | null |
mysqld_safe
|
mysqld_safe is the recommended way to start a mysqld server on Unix. mysqld_safe adds some safety features such as restarting the server when an error occurs and logging runtime information to an error log. A description of error logging is given later in this section. Note For some Linux platforms, MySQL installation from RPM or Debian packages includes systemd support for managing MySQL server startup and shutdown. On these platforms, mysqld_safe is not installed because it is unnecessary. For more information, see Section 2.5.9, βManaging MySQL Server with systemdβ. One implication of the non-use of mysqld_safe on platforms that use systemd for server management is that use of [mysqld_safe] or [safe_mysqld] sections in option files is not supported and might lead to unexpected behavior. mysqld_safe tries to start an executable named mysqld. To override the default behavior and specify explicitly the name of the server you want to run, specify a --mysqld or --mysqld-version option to mysqld_safe. You can also use --ledir to indicate the directory where mysqld_safe should look for the server. Many of the options to mysqld_safe are the same as the options to mysqld. See Section 5.1.7, βServer Command Optionsβ. Options unknown to mysqld_safe are passed to mysqld if they are specified on the command line, but ignored if they are specified in the [mysqld_safe] group of an option file. See Section 4.2.2.2, βUsing Option Filesβ. mysqld_safe reads all options from the [mysqld], [server], and [mysqld_safe] sections in option files. For example, if you specify a [mysqld] section like this, mysqld_safe finds and uses the --log-error option: [mysqld] log-error=error.log For backward compatibility, mysqld_safe also reads [safe_mysqld] sections, but to be current you should rename such sections to [mysqld_safe]. mysqld_safe accepts options on the command line and in option files, as described in the following table. For information about option files used by MySQL programs, see Section 4.2.2.2, βUsing Option Filesβ. β’ --help ββββββββββββββββββββββ¬βββββββββ βCommand-Line Format β --help β ββββββββββββββββββββββ΄βββββββββ Display a help message and exit. β’ --basedir=dir_name ββββββββββββββββββββββ¬βββββββββββββββββββββ βCommand-Line Format β --basedir=dir_name β ββββββββββββββββββββββΌβββββββββββββββββββββ€ βType β Directory name β ββββββββββββββββββββββ΄βββββββββββββββββββββ The path to the MySQL installation directory. β’ --core-file-size=size ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --core-file-size=size β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ The size of the core file that mysqld should be able to create. The option value is passed to ulimit -c. Note The innodb_buffer_pool_in_core_file variable can be used to reduce the size of core files on operating systems that support it. For more information, see Section 15.8.3.7, βExcluding Buffer Pool Pages from Core Filesβ. β’ --datadir=dir_name ββββββββββββββββββββββ¬βββββββββββββββββββββ βCommand-Line Format β --datadir=dir_name β ββββββββββββββββββββββΌβββββββββββββββββββββ€ βType β Directory name β ββββββββββββββββββββββ΄βββββββββββββββββββββ The path to the data directory. β’ --defaults-extra-file=file_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββ βCommand-Line Format β --defaults-extra-file=file_name β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββ Read this option file in addition to the usual option files. If the file does not exist or is otherwise inaccessible, the server exits with an error. If file_name is not an absolute path name, it is interpreted relative to the current directory. This must be the first option on the command line if it is used. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --defaults-file=file_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββ βCommand-Line Format β --defaults-file=file_name β ββββββββββββββββββββββΌββββββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββ Use only the given option file. If the file does not exist or is otherwise inaccessible, the server exits with an error. If file_name is not an absolute path name, it is interpreted relative to the current directory. This must be the first option on the command line if it is used. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --ledir=dir_name ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --ledir=dir_name β ββββββββββββββββββββββΌβββββββββββββββββββ€ βType β Directory name β ββββββββββββββββββββββ΄βββββββββββββββββββ If mysqld_safe cannot find the server, use this option to indicate the path name to the directory where the server is located. This option is accepted only on the command line, not in option files. On platforms that use systemd, the value can be specified in the value of MYSQLD_OPTS. See Section 2.5.9, βManaging MySQL Server with systemdβ. β’ --log-error=file_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --log-error=file_name β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ Write the error log to the given file. See Section 5.4.2, βThe Error Logβ. β’ --mysqld-safe-log-timestamps ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --mysqld-safe-log-timestamps=type β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββ€ βType β Enumeration β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββ€ βDefault Value β utc β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββ€ βValid Values β system hyphen legacy β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββ This option controls the format for timestamps in log output produced by mysqld_safe. The following list describes the permitted values. For any other value, mysqld_safe logs a warning and uses UTC format. β’ UTC, utc ISO 8601 UTC format (same as --log_timestamps=UTC for the server). This is the default. β’ SYSTEM, system ISO 8601 local time format (same as --log_timestamps=SYSTEM for the server). β’ HYPHEN, hyphen YY-MM-DD h:mm:ss format, as in mysqld_safe for MySQL 5.6. β’ LEGACY, legacy YYMMDD hh:mm:ss format, as in mysqld_safe prior to MySQL 5.6. β’ --malloc-lib=[lib_name] ββββββββββββββββββββββ¬ββββββββββββββββββββββββββ βCommand-Line Format β --malloc-lib=[lib-name] β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββ The name of the library to use for memory allocation instead of the system malloc() library. The option value must be one of the directories /usr/lib, /usr/lib64, /usr/lib/i386-linux-gnu, or /usr/lib/x86_64-linux-gnu. The --malloc-lib option works by modifying the LD_PRELOAD environment value to affect dynamic linking to enable the loader to find the memory-allocation library when mysqld runs: β’ If the option is not given, or is given without a value (--malloc-lib=), LD_PRELOAD is not modified and no attempt is made to use tcmalloc. β’ Prior to MySQL 8.0.21, if the option is given as --malloc-lib=tcmalloc, mysqld_safe looks for a tcmalloc library in /usr/lib. If tmalloc is found, its path name is added to the beginning of the LD_PRELOAD value for mysqld. If tcmalloc is not found, mysqld_safe aborts with an error. As of MySQL 8.0.21, tcmalloc is not a permitted value for the --malloc-lib option. β’ If the option is given as --malloc-lib=/path/to/some/library, that full path is added to the beginning of the LD_PRELOAD value. If the full path points to a nonexistent or unreadable file, mysqld_safe aborts with an error. β’ For cases where mysqld_safe adds a path name to LD_PRELOAD, it adds the path to the beginning of any existing value the variable already has. Note On systems that manage the server using systemd, mysqld_safe is not available. Instead, specify the allocation library by setting LD_PRELOAD in /etc/sysconfig/mysql. Linux users can use the libtcmalloc_minimal.so library on any platform for which a tcmalloc package is installed in /usr/lib by adding these lines to the my.cnf file: [mysqld_safe] malloc-lib=tcmalloc To use a specific tcmalloc library, specify its full path name. Example: [mysqld_safe] malloc-lib=/opt/lib/libtcmalloc_minimal.so β’ --mysqld=prog_name ββββββββββββββββββββββ¬βββββββββββββββββββββ βCommand-Line Format β --mysqld=file_name β ββββββββββββββββββββββΌβββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄βββββββββββββββββββββ The name of the server program (in the ledir directory) that you want to start. This option is needed if you use the MySQL binary distribution but have the data directory outside of the binary distribution. If mysqld_safe cannot find the server, use the --ledir option to indicate the path name to the directory where the server is located. This option is accepted only on the command line, not in option files. On platforms that use systemd, the value can be specified in the value of MYSQLD_OPTS. See Section 2.5.9, βManaging MySQL Server with systemdβ. β’ --mysqld-version=suffix ββββββββββββββββββββββ¬ββββββββββββββββββββββββββ βCommand-Line Format β --mysqld-version=suffix β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββ This option is similar to the --mysqld option, but you specify only the suffix for the server program name. The base name is assumed to be mysqld. For example, if you use --mysqld-version=debug, mysqld_safe starts the mysqld-debug program in the ledir directory. If the argument to --mysqld-version is empty, mysqld_safe uses mysqld in the ledir directory. This option is accepted only on the command line, not in option files. On platforms that use systemd, the value can be specified in the value of MYSQLD_OPTS. See Section 2.5.9, βManaging MySQL Server with systemdβ. β’ --nice=priority ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --nice=priority β ββββββββββββββββββββββΌββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββ΄ββββββββββββββββββ Use the nice program to set the server's scheduling priority to the given value. β’ --no-defaults ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --no-defaults β ββββββββββββββββββββββΌββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββ Do not read any option files. If program startup fails due to reading unknown options from an option file, --no-defaults can be used to prevent them from being read. This must be the first option on the command line if it is used. For additional information about this and other option-file options, see Section 4.2.2.3, βCommand-Line Options that Affect Option-File Handlingβ. β’ --open-files-limit=count ββββββββββββββββββββββ¬βββββββββββββββββββββββββββ βCommand-Line Format β --open-files-limit=count β ββββββββββββββββββββββΌβββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββ The number of files that mysqld should be able to open. The option value is passed to ulimit -n. Note You must start mysqld_safe as root for this to function properly. β’ --pid-file=file_name ββββββββββββββββββββββ¬βββββββββββββββββββββββ βCommand-Line Format β --pid-file=file_name β ββββββββββββββββββββββΌβββββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄βββββββββββββββββββββββ The path name that mysqld should use for its process ID file. β’ --plugin-dir=dir_name ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --plugin-dir=dir_name β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β Directory name β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ The path name of the plugin directory. β’ --port=port_num ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --port=number β ββββββββββββββββββββββΌββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββ΄ββββββββββββββββ The port number that the server should use when listening for TCP/IP connections. The port number must be 1024 or higher unless the server is started by the root operating system user. β’ --skip-kill-mysqld ββββββββββββββββββββββ¬βββββββββββββββββββββ βCommand-Line Format β --skip-kill-mysqld β ββββββββββββββββββββββ΄βββββββββββββββββββββ Do not try to kill stray mysqld processes at startup. This option works only on Linux. β’ --socket=path ββββββββββββββββββββββ¬βββββββββββββββββββββ βCommand-Line Format β --socket=file_name β ββββββββββββββββββββββΌβββββββββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄βββββββββββββββββββββ The Unix socket file that the server should use when listening for local connections. β’ --syslog, --skip-syslog ββββββββββββββββββββββ¬βββββββββββ βCommand-Line Format β --syslog β ββββββββββββββββββββββΌβββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββ΄βββββββββββ ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --skip-syslog β ββββββββββββββββββββββΌββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββ΄ββββββββββββββββ --syslog causes error messages to be sent to syslog on systems that support the logger program. --skip-syslog suppresses the use of syslog; messages are written to an error log file. When syslog is used for error logging, the daemon.err facility/severity is used for all log messages. Using these options to control mysqld logging is deprecated. To write error log output to the system log, use the instructions at Section 5.4.2.8, βError Logging to the System Logβ. To control the facility, use the server log_syslog_facility system variable. β’ --syslog-tag=tag ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --syslog-tag=tag β ββββββββββββββββββββββΌβββββββββββββββββββ€ βDeprecated β Yes β ββββββββββββββββββββββ΄βββββββββββββββββββ For logging to syslog, messages from mysqld_safe and mysqld are written with identifiers of mysqld_safe and mysqld, respectively. To specify a suffix for the identifiers, use --syslog-tag=tag, which modifies the identifiers to be mysqld_safe-tag and mysqld-tag. Using this option to control mysqld logging is deprecated. Use the server log_syslog_tag system variable instead. See Section 5.4.2.8, βError Logging to the System Logβ. β’ --timezone=timezone ββββββββββββββββββββββ¬ββββββββββββββββββββββ βCommand-Line Format β --timezone=timezone β ββββββββββββββββββββββΌββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββ Set the TZ time zone environment variable to the given option value. Consult your operating system documentation for legal time zone specification formats. β’ --user={user_name|user_id} ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββ βCommand-Line Format β --user={user_name|user_id} β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββ Run the mysqld server as the user having the name user_name or the numeric user ID user_id. (βUserβ in this context refers to a system login account, not a MySQL user listed in the grant tables.) If you execute mysqld_safe with the --defaults-file or --defaults-extra-file option to name an option file, the option must be the first one given on the command line or the option file is not used. For example, this command does not use the named option file: mysql> mysqld_safe --port=port_num --defaults-file=file_name Instead, use the following command: mysql> mysqld_safe --defaults-file=file_name --port=port_num The mysqld_safe script is written so that it normally can start a server that was installed from either a source or a binary distribution of MySQL, even though these types of distributions typically install the server in slightly different locations. (See Section 2.1.5, βInstallation Layoutsβ.) mysqld_safe expects one of the following conditions to be true: β’ The server and databases can be found relative to the working directory (the directory from which mysqld_safe is invoked). For binary distributions, mysqld_safe looks under its working directory for bin and data directories. For source distributions, it looks for libexec and var directories. This condition should be met if you execute mysqld_safe from your MySQL installation directory (for example, /usr/local/mysql for a binary distribution). β’ If the server and databases cannot be found relative to the working directory, mysqld_safe attempts to locate them by absolute path names. Typical locations are /usr/local/libexec and /usr/local/var. The actual locations are determined from the values configured into the distribution at the time it was built. They should be correct if MySQL is installed in the location specified at configuration time. Because mysqld_safe tries to find the server and databases relative to its own working directory, you can install a binary distribution of MySQL anywhere, as long as you run mysqld_safe from the MySQL installation directory: cd mysql_installation_directory bin/mysqld_safe & If mysqld_safe fails, even when invoked from the MySQL installation directory, specify the --ledir and --datadir options to indicate the directories in which the server and databases are located on your system. mysqld_safe tries to use the sleep and date system utilities to determine how many times per second it has attempted to start. If these utilities are present and the attempted starts per second is greater than 5, mysqld_safe waits 1 full second before starting again. This is intended to prevent excessive CPU usage in the event of repeated failures. (Bug #11761530, Bug #54035) When you use mysqld_safe to start mysqld, mysqld_safe arranges for error (and notice) messages from itself and from mysqld to go to the same destination. There are several mysqld_safe options for controlling the destination of these messages: β’ --log-error=file_name: Write error messages to the named error file. β’ --syslog: Write error messages to syslog on systems that support the logger program. β’ --skip-syslog: Do not write error messages to syslog. Messages are written to the default error log file (host_name.err in the data directory), or to a named file if the --log-error option is given. If none of these options is given, the default is --skip-syslog. When mysqld_safe writes a message, notices go to the logging destination (syslog or the error log file) and stdout. Errors go to the logging destination and stderr. Note Controlling mysqld logging from mysqld_safe is deprecated. Use the server's native syslog support instead. For more information, see Section 5.4.2.8, βError Logging to the System Logβ. COPYRIGHT Copyright Β© 1997, 2023, Oracle and/or its affiliates. This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/. SEE ALSO For more information, please refer to the MySQL Reference Manual, which may already be installed locally and which is also available online at http://dev.mysql.com/doc/. AUTHOR Oracle Corporation (http://dev.mysql.com/). MySQL 8.3 11/23/2023 MYSQLD_SAFE(1)
|
mysqld_safe - MySQL server startup script
|
mysqld_safe options
| null | null |
ObjectDump
| null | null | null | null | null |
jupyter-execute
| null | null | null | null | null |
lzegrep
|
xzgrep invokes grep(1) on uncompressed contents of files. The formats of the files are determined from the filename suffixes. Any file with a suffix supported by xz(1), gzip(1), bzip2(1), lzop(1), zstd(1), or lz4(1) will be decompressed; all other files are assumed to be uncompressed. If no files are specified or file is - then standard input is read. When reading from standard input, only files supported by xz(1) are decompressed. Other files are assumed to be in uncompressed form already. Most options of grep(1) are supported. However, the following options are not supported: -r, --recursive -R, --dereference-recursive -d, --directories=action -Z, --null -z, --null-data --include=glob --exclude=glob --exclude-from=file --exclude-dir=glob xzegrep is an alias for xzgrep -E. xzfgrep is an alias for xzgrep -F. The commands lzgrep, lzegrep, and lzfgrep are provided for backward compatibility with LZMA Utils. EXIT STATUS 0 At least one match was found from at least one of the input files. No errors occurred. 1 No matches were found from any of the input files. No errors occurred. >1 One or more errors occurred. It is unknown if matches were found. ENVIRONMENT GREP If GREP is set to a non-empty value, it is used instead of grep, grep -E, or grep -F. SEE ALSO grep(1), xz(1), gzip(1), bzip2(1), lzop(1), zstd(1), lz4(1), zgrep(1) Tukaani 2024-02-13 XZGREP(1)
|
xzgrep - search possibly-compressed files for patterns
|
xzgrep [option...] [pattern_list] [file...] xzegrep ... xzfgrep ... lzgrep ... lzegrep ... lzfgrep ...
| null | null |
moc
| null | null | null | null | null |
pttree
| null | null | null | null | null |
ckeygen
| null | null | null | null | null |
unwinddump
|
When a C++ (or x86_64 Objective-C) exception is thrown, the runtime must unwind the stack looking for some function to catch the exception. Traditionally, the unwind information is stored in the __TEXT/__eh_frame section of each executable as Dwarf CFI (call frame information). Beginning in Mac OS X 10.6, the unwind information is also encoded in the __TEXT/__unwind_info section using a two-level lookup table of compact unwind encodings. The unwinddump tool displays the content of the __TEXT/__unwind_info section. SEE ALSO ld(1) dwarfdump(1) Darwin November 7, 2008 Darwin
|
unwinddump β Displays compact unwind information in an executable
|
unwinddump [-arch arch-name] file(s)
| null | null |
bzip2
|
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 |
email_validator
| null | null | null | null | null |
raw2tiff
| null | null | null | null | null |
msgfmt
|
Generate binary message catalog from textual translation description. Mandatory arguments to long options are mandatory for short options too. Similarly for optional arguments. Input file location: filename.po ... input files -D, --directory=DIRECTORY add DIRECTORY to list for input files search If input file is -, standard input is read. Operation mode: -j, --java Java mode: generate a Java ResourceBundle class --java2 like --java, and assume Java2 (JDK 1.2 or higher) --csharp C# mode: generate a .NET .dll file --csharp-resources C# resources mode: generate a .NET .resources file --tcl Tcl mode: generate a tcl/msgcat .msg file --qt Qt mode: generate a Qt .qm file --desktop Desktop Entry mode: generate a .desktop file --xml XML mode: generate XML file Output file location: -o, --output-file=FILE write output to specified file --strict enable strict Uniforum mode If output file is -, output is written to standard output. Output file location in Java mode: -r, --resource=RESOURCE resource name -l, --locale=LOCALE locale name, either language or language_COUNTRY --source produce a .java file, instead of a .class file -d DIRECTORY base directory of classes directory hierarchy The class name is determined by appending the locale name to the resource name, separated with an underscore. The -d option is mandatory. The class is written under the specified directory. Output file location in C# mode: -r, --resource=RESOURCE resource name -l, --locale=LOCALE locale name, either language or language_COUNTRY -d DIRECTORY base directory for locale dependent .dll files The -l and -d options are mandatory. The .dll file is written in a subdirectory of the specified directory whose name depends on the locale. Output file location in Tcl mode: -l, --locale=LOCALE locale name, either language or language_COUNTRY -d DIRECTORY base directory of .msg message catalogs The -l and -d options are mandatory. The .msg file is written in the specified directory. Desktop Entry mode options: -l, --locale=LOCALE locale name, either language or language_COUNTRY -o, --output-file=FILE write output to specified file --template=TEMPLATE a .desktop file used as a template -d DIRECTORY base directory of .po files -kWORD, --keyword=WORD look for WORD as an additional keyword -k, --keyword do not to use default keywords The -l, -o, and --template options are mandatory. If -D is specified, input files are read from the directory instead of the command line arguments. XML mode options: -l, --locale=LOCALE locale name, either language or language_COUNTRY -L, --language=NAME recognise the specified XML language -o, --output-file=FILE write output to specified file --template=TEMPLATE an XML file used as a template -d DIRECTORY base directory of .po files The -l, -o, and --template options are mandatory. If -D is specified, input files are read from the directory instead of the command line arguments. Input file syntax: -P, --properties-input input files are in Java .properties syntax --stringtable-input input files are in NeXTstep/GNUstep .strings syntax Input file interpretation: -c, --check perform all the checks implied by --check-format, --check-header, --check-domain --check-format check language dependent format strings --check-header verify presence and contents of the header entry --check-domain check for conflicts between domain directives and the --output-file option -C, --check-compatibility check that GNU msgfmt behaves like X/Open msgfmt --check-accelerators[=CHAR] check presence of keyboard accelerators for menu items -f, --use-fuzzy use fuzzy entries in output Output details: --no-convert don't convert the messages to UTF-8 encoding --no-redundancy don't pre-expand ISO C 99 <inttypes.h> format string directive macros -a, --alignment=NUMBER align strings to NUMBER bytes (default: 1) --endianness=BYTEORDER write out 32-bit numbers in the given byte order (big or little, default depends on platform) --no-hash binary file will not include the hash table Informative output: -h, --help display this help and exit -V, --version output version information and exit --statistics print statistics about translations -v, --verbose increase verbosity level AUTHOR Written by Ulrich Drepper. REPORTING BUGS Report bugs in the bug tracker at <https://savannah.gnu.org/projects/gettext> or by email to <bug-gettext@gnu.org>. COPYRIGHT Copyright Β© 1995-2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html> This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO The full documentation for msgfmt is maintained as a Texinfo manual. If the info and msgfmt programs are properly installed at your site, the command info msgfmt should give you access to the complete manual. GNU gettext-tools 0.22.5 February 2024 MSGFMT(1)
|
msgfmt - compile message catalog to binary format
|
msgfmt [OPTION] filename.po ...
| null | null |
mirror_server_stop
| null | null | null | null | null |
install_name_tool
|
Install_name_tool changes the dynamic shared library install names and or adds, changes or deletes the rpaths recorded in a Mach-O binary. For this tool to work when the install names or rpaths are larger the binary should be built with the ld(1) -headerpad_max_install_names option. -change old new Changes the dependent shared library install name old to new in the specified Mach-O binary. More than one of these options can be specified. If the Mach-O binary does not contain the old install name in a specified -change option the option is ignored. -id name Changes the shared library identification name of a dynamic shared library to name. If the Mach-O binary is not a dynamic shared library and the -id option is specified it is ignored. -rpath old new Changes the rpath path name old to new in the specified Mach-O binary. More than one of these options can be specified. If the Mach-O binary does not contain the old rpath path name in a specified -rpath it is an error. -add_rpath new Adds the rpath path name new in the specified Mach-O binary. More than one of these options can be specified. If the Mach-O binary already contains the new rpath path name specified in -add_rpath it is an error. -delete_rpath old deletes the rpath path name old in the specified Mach-O binary. More than one of these options can be specified. If the Mach-O binary does not contains the old rpath path name specified in -delete_rpath it is an error. SEE ALSO ld(1) Apple, Inc. March 4, 2009 INSTALL_NAME_TOOL(1)
|
install_name_tool - change dynamic shared library install names
|
install_name_tool [-change old new ] ... [-rpath old new ] ... [-add_rpath new ] ... [-delete_rpath new ] ... [-id name] file
| null | null |
cmpdylib
|
cmpdylib compares two versions of a dynamic shared library to see if they are compatible with each other. If the two versions are incompatible, the reason is printed to stdout, and the exit status is nonzero. If they are compatible, nothing is printed, and the exit status is zero. To see if the two versions are compatible, cmpdylib first verifies that newLibrary was built for all of the architectures that oldLibrary was built for. If so, for each architecture, it checks to see if the global symbols defined in oldLibrary are still defined in newLibrary. It then looks for new symbols, symbols defined in newLibrary that are not defined in oldLibrary. If it finds new symbols, it compares the compatibility version numbers of the two libraries. If the compatibility version number of newLibrary is greater than oldLibrary, the libraries are still compatible. If the compatibility version number is the same or less, the libraries are incompatible.
|
cmpdylib - compare two dynamic shared libraries for compatibility
|
cmpdylib oldLibrary newLibrary
|
oldLibrary The older version of the library. newLibrary The newer version of the library.
|
This example shows the result of performing cmpdylib on two incompatible versions of the Foundation library. As stated, the versions are incompatible because the newer version was not built for the ppc architecture. cmpdylib /System/Library/Frameworks/Foundation.framework/Foundation Foundation_proj/Foundation cmpdylib: file: Foundation_proj/Foundation does not contain architecture: ppc cmpdylib: new dynamic shared library: Foundation_proj/Foundation does not contain architecture ppc DIAGNOSTICS The exit status is zero if the library versions are compatible and nonzero if they are incompatible. BUGS There are lots of other things that could be checked for that are not (such as the Objective C API). Apple Computer, Inc. November 3, 1997 CMPDYLIB(1)
|
ppm2tiff
| null | null | null | null | null |
rstpep2html.py
| null | null | null | null | null |
openai
| null | null | null | null | null |
xzdiff
|
xzcmp and xzdiff compare uncompressed contents of two files. Uncompressed data and options are passed to cmp(1) or diff(1) unless --help or --version is specified. If both file1 and file2 are specified, they can be uncompressed files or files in formats that xz(1), gzip(1), bzip2(1), lzop(1), zstd(1), or lz4(1) can decompress. The required decompression commands are determined from the filename suffixes of file1 and file2. A file with an unknown suffix is assumed to be either uncompressed or in a format that xz(1) can decompress. If only one filename is provided, file1 must have a suffix of a supported compression format and the name for file2 is assumed to be file1 with the compression format suffix removed. The commands lzcmp and lzdiff are provided for backward compatibility with LZMA Utils. EXIT STATUS If a decompression error occurs, the exit status is 2. Otherwise the exit status of cmp(1) or diff(1) is used. SEE ALSO cmp(1), diff(1), xz(1), gzip(1), bzip2(1), lzop(1), zstd(1), lz4(1) Tukaani 2024-02-13 XZDIFF(1)
|
xzcmp, xzdiff, lzcmp, lzdiff - compare compressed files
|
xzcmp [option...] file1 [file2] xzdiff ... lzcmp ... lzdiff ...
| null | null |
msgattrib
|
Filters the messages of a translation catalog according to their attributes, and manipulates the attributes. Mandatory arguments to long options are mandatory for short options too. Input file location: INPUTFILE input PO file -D, --directory=DIRECTORY add DIRECTORY to list for input files search If no input file is given or if it is -, standard input is read. Output file location: -o, --output-file=FILE write output to specified file The results are written to standard output if no output file is specified or if it is -. Message selection: --translated keep translated, remove untranslated messages --untranslated keep untranslated, remove translated messages --no-fuzzy remove 'fuzzy' marked messages --only-fuzzy keep 'fuzzy' marked messages --no-obsolete remove obsolete #~ messages --only-obsolete keep obsolete #~ messages Attribute manipulation: --set-fuzzy set all messages 'fuzzy' --clear-fuzzy set all messages non-'fuzzy' --set-obsolete set all messages obsolete --clear-obsolete set all messages non-obsolete --previous when setting 'fuzzy', keep previous msgids of translated messages. --clear-previous remove the "previous msgid" from all messages --empty when removing 'fuzzy', also set msgstr empty --only-file=FILE.po manipulate only entries listed in FILE.po --ignore-file=FILE.po manipulate only entries not listed in FILE.po --fuzzy synonym for --only-fuzzy --clear-fuzzy --obsolete synonym for --only-obsolete --clear-obsolete Input file syntax: -P, --properties-input input file is in Java .properties syntax --stringtable-input input file is in NeXTstep/GNUstep .strings syntax Output details: --color use colors and other text attributes always --color=WHEN use colors and other text attributes if WHEN. WHEN may be 'always', 'never', 'auto', or 'html'. --style=STYLEFILE specify CSS style rule file for --color -e, --no-escape do not use C escapes in output (default) -E, --escape use C escapes in output, no extended chars --force-po write PO file even if empty -i, --indent write the .po file using indented style --no-location do not write '#: filename:line' lines -n, --add-location generate '#: filename:line' lines (default) --strict write out strict Uniforum conforming .po file -p, --properties-output write out a Java .properties file --stringtable-output write out a NeXTstep/GNUstep .strings file -w, --width=NUMBER set output page width --no-wrap do not break long message lines, longer than the output page width, into several lines -s, --sort-output generate sorted output -F, --sort-by-file sort output by file location Informative output: -h, --help display this help and exit -V, --version output version information and exit AUTHOR Written by Bruno Haible. REPORTING BUGS Report bugs in the bug tracker at <https://savannah.gnu.org/projects/gettext> or by email to <bug-gettext@gnu.org>. COPYRIGHT Copyright Β© 2001-2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html> This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO The full documentation for msgattrib is maintained as a Texinfo manual. If the info and msgattrib programs are properly installed at your site, the command info msgattrib should give you access to the complete manual. GNU gettext-tools 0.22.5 February 2024 MSGATTRIB(1)
|
msgattrib - attribute matching and manipulation on message catalog
|
msgattrib [OPTION] [INPUTFILE]
| null | null |
symilar
| null | null | null | null | null |
get_objgraph
| null | null | null | null | null |
pcregrep
| null | null | null | null | null |
sphinx-autogen
| null | null | null | null | null |
tiff2rgba
| null | null | null | null | null |
anaconda-navigator
| null | null | null | null | null |
pkginfo
| null | null | null | null | null |
makerelocs
| null | null | null | null | null |
xgettext
|
Extract translatable strings from given input files. Mandatory arguments to long options are mandatory for short options too. Similarly for optional arguments. Input file location: INPUTFILE ... input files -f, --files-from=FILE get list of input files from FILE -D, --directory=DIRECTORY add DIRECTORY to list for input files search If input file is -, standard input is read. Output file location: -d, --default-domain=NAME use NAME.po for output (instead of messages.po) -o, --output=FILE write output to specified file -p, --output-dir=DIR output files will be placed in directory DIR If output file is -, output is written to standard output. Choice of input file language: -L, --language=NAME recognise the specified language (C, C++, ObjectiveC, PO, Shell, Python, Lisp, EmacsLisp, librep, Scheme, Smalltalk, Java, JavaProperties, C#, awk, YCP, Tcl, Perl, PHP, Ruby, GCC-source, NXStringTable, RST, RSJ, Glade, Lua, JavaScript, Vala, Desktop) -C, --c++ shorthand for --language=C++ By default the language is guessed depending on the input file name extension. Input file interpretation: --from-code=NAME encoding of input files (except for Python, Tcl, Glade) By default the input files are assumed to be in ASCII. Operation mode: -j, --join-existing join messages with existing file -x, --exclude-file=FILE.po entries from FILE.po are not extracted -cTAG, --add-comments=TAG place comment blocks starting with TAG and preceding keyword lines in output file -c, --add-comments place all comment blocks preceding keyword lines in output file --check=NAME perform syntax check on messages (ellipsis-unicode, space-ellipsis, quote-unicode, bullet-unicode) --sentence-end=TYPE type describing the end of sentence (single-space, which is the default, or double-space) Language specific options: -a, --extract-all extract all strings (only languages C, C++, ObjectiveC, Shell, Python, Lisp, EmacsLisp, librep, Scheme, Java, C#, awk, Tcl, Perl, PHP, GCC-source, Glade, Lua, JavaScript, Vala) -kWORD, --keyword=WORD look for WORD as an additional keyword -k, --keyword do not to use default keywords (only languages C, C++, ObjectiveC, Shell, Python, Lisp, EmacsLisp, librep, Scheme, Java, C#, awk, Tcl, Perl, PHP, GCC-source, Glade, Lua, JavaScript, Vala, Desktop) --flag=WORD:ARG:FLAG additional flag for strings inside the argument number ARG of keyword WORD (only languages C, C++, ObjectiveC, Shell, Python, Lisp, EmacsLisp, librep, Scheme, Java, C#, awk, YCP, Tcl, Perl, PHP, GCC-source, Lua, JavaScript, Vala) -T, --trigraphs understand ANSI C trigraphs for input (only languages C, C++, ObjectiveC) --its=FILE apply ITS rules from FILE (only XML based languages) --qt recognize Qt format strings (only language C++) --kde recognize KDE 4 format strings (only language C++) --boost recognize Boost format strings (only language C++) --debug more detailed formatstring recognition result Output details: --color use colors and other text attributes always --color=WHEN use colors and other text attributes if WHEN. WHEN may be 'always', 'never', 'auto', or 'html'. --style=STYLEFILE specify CSS style rule file for --color -e, --no-escape do not use C escapes in output (default) -E, --escape use C escapes in output, no extended chars --force-po write PO file even if empty -i, --indent write the .po file using indented style --no-location do not write '#: filename:line' lines -n, --add-location generate '#: filename:line' lines (default) --strict write out strict Uniforum conforming .po file --properties-output write out a Java .properties file --stringtable-output write out a NeXTstep/GNUstep .strings file --itstool write out itstool comments -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 (deprecated) -F, --sort-by-file sort output by file location --omit-header don't write header with 'msgid ""' entry --copyright-holder=STRING set copyright holder in output --foreign-user omit FSF copyright in output for foreign user --package-name=PACKAGE set package name in output --package-version=VERSION set package version in output --msgid-bugs-address=EMAIL@ADDRESS set report address for msgid bugs -m[STRING], --msgstr-prefix[=STRING] use STRING or "" as prefix for msgstr values -M[STRING], --msgstr-suffix[=STRING] use STRING or "" as suffix for msgstr values Informative output: -h, --help display this help and exit -V, --version output version information and exit -v, --verbose increase verbosity level AUTHOR Written by Ulrich Drepper. REPORTING BUGS Report bugs in the bug tracker at <https://savannah.gnu.org/projects/gettext> or by email to <bug-gettext@gnu.org>. COPYRIGHT Copyright Β© 1995-2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html> This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO The full documentation for xgettext is maintained as a Texinfo manual. If the info and xgettext programs are properly installed at your site, the command info xgettext should give you access to the complete manual. GNU gettext-tools 0.22.5 February 2024 XGETTEXT(1)
|
xgettext - extract gettext strings from source
|
xgettext [OPTION] [INPUTFILE]...
| null | null |
watchfiles
| null | null | null | null | null |
gio
| null | null | null | null | null |
cftp
| null | null | null | null | null |
automat-visualize
| null | null | null | null | null |
mysqlslap
|
mysqlslap is a diagnostic program designed to emulate client load for a MySQL server and to report the timing of each stage. It works as if multiple clients are accessing the server. Invoke mysqlslap like this: mysqlslap [options] Some options such as --create or --query enable you to specify a string containing an SQL statement or a file containing statements. If you specify a file, by default it must contain one statement per line. (That is, the implicit statement delimiter is the newline character.) Use the --delimiter option to specify a different delimiter, which enables you to specify statements that span multiple lines or place multiple statements on a single line. You cannot include comments in a file; mysqlslap does not understand them. mysqlslap runs in three stages: 1. Create schema, table, and optionally any stored programs or data to use for the test. This stage uses a single client connection. 2. Run the load test. This stage can use many client connections. 3. Clean up (disconnect, drop table if specified). This stage uses a single client connection. Examples: Supply your own create and query SQL statements, with 50 clients querying and 200 selects for each (enter the command on a single line): mysqlslap --delimiter=";" --create="CREATE TABLE a (b int);INSERT INTO a VALUES (23)" --query="SELECT * FROM a" --concurrency=50 --iterations=200 Let mysqlslap build the query SQL statement with a table of two INT columns and three VARCHAR columns. Use five clients querying 20 times each. Do not create the table or insert the data (that is, use the previous test's schema and data): mysqlslap --concurrency=5 --iterations=20 --number-int-cols=2 --number-char-cols=3 --auto-generate-sql Tell the program to load the create, insert, and query SQL statements from the specified files, where the create.sql file has multiple table creation statements delimited by ';' and multiple insert statements delimited by ';'. The --query file should contain multiple queries delimited by ';'. Run all the load statements, then run all the queries in the query file with five clients (five times each): mysqlslap --concurrency=5 --iterations=5 --query=query.sql --create=create.sql --delimiter=";" mysqlslap supports the following options, which can be specified on the command line or in the [mysqlslap] 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. β’ --auto-generate-sql, -a ββββββββββββββββββββββ¬ββββββββββββββββββββββ βCommand-Line Format β --auto-generate-sql β ββββββββββββββββββββββΌββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄ββββββββββββββββββββββ Generate SQL statements automatically when they are not supplied in files or using command options. β’ --auto-generate-sql-add-autoincrement ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --auto-generate-sql-add-autoincrement β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββββ Add an AUTO_INCREMENT column to automatically generated tables. β’ --auto-generate-sql-execute-number=N ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --auto-generate-sql-execute-number=# β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββ Specify how many queries to generate automatically. β’ --auto-generate-sql-guid-primary ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββ βCommand-Line Format β --auto-generate-sql-guid-primary β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββ Add a GUID-based primary key to automatically generated tables. β’ --auto-generate-sql-load-type=type ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --auto-generate-sql-load-type=type β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββ€ βType β Enumeration β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββ€ βDefault Value β mixed β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββ€ βValid Values β read write key update mixed β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββ Specify the test load type. The permissible values are read (scan tables), write (insert into tables), key (read primary keys), update (update primary keys), or mixed (half inserts, half scanning selects). The default is mixed. β’ --auto-generate-sql-secondary-indexes=N ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --auto-generate-sql-secondary-indexes=# β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββββββ€ βDefault Value β 0 β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββββββ Specify how many secondary indexes to add to automatically generated tables. By default, none are added. β’ --auto-generate-sql-unique-query-number=N ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --auto-generate-sql-unique-query-number=# β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββββββββ€ βDefault Value β 10 β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββββββββ How many different queries to generate for automatic tests. For example, if you run a key test that performs 1000 selects, you can use this option with a value of 1000 to run 1000 unique queries, or with a value of 50 to perform 50 different selects. The default is 10. β’ --auto-generate-sql-unique-write-number=N ββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --auto-generate-sql-unique-write-number=# β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌββββββββββββββββββββββββββββββββββββββββββββ€ βDefault Value β 10 β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββββββββββββ How many different queries to generate for --auto-generate-sql-write-number. The default is 10. β’ --auto-generate-sql-write-number=N ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββββββ βCommand-Line Format β --auto-generate-sql-write-number=# β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββββ€ βDefault Value β 100 β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββ How many row inserts to perform. The default is 100. β’ --commit=N ββββββββββββββββββββββ¬βββββββββββββ βCommand-Line Format β --commit=# β ββββββββββββββββββββββΌβββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌβββββββββββββ€ βDefault Value β 0 β ββββββββββββββββββββββ΄βββββββββββββ How many statements to execute before committing. The default is 0 (no commits are done). β’ --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β. β’ --concurrency=N, -c N ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --concurrency=# β ββββββββββββββββββββββΌββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββ΄ββββββββββββββββββ The number of parallel clients to simulate. β’ --create=value ββββββββββββββββββββββ¬βββββββββββββββββ βCommand-Line Format β --create=value β ββββββββββββββββββββββΌβββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββ The file or string containing the statement to use for creating the table. β’ --create-schema=value ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --create-schema=value β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ The schema in which to run the tests. Note If the --auto-generate-sql option is also given, mysqlslap drops the schema at the end of the test run. To avoid this, use the --no-drop option as well. β’ --csv[=file_name] ββββββββββββββββββββββ¬βββββββββββββββ βCommand-Line Format β --csv=[file] β ββββββββββββββββββββββΌβββββββββββββββ€ βType β File name β ββββββββββββββββββββββ΄βββββββββββββββ Generate output in comma-separated values format. The output goes to the named file, or to the standard output if no file is given. β’ --debug[=debug_options], -# [debug_options] ββββββββββββββββββββββ¬βββββββββββββββββββββββββββββ βCommand-Line Format β --debug[=debug_options] β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββΌβββββββββββββββββββββββββββββ€ βDefault Value β d:t:o,/tmp/mysqlslap.trace β ββββββββββββββββββββββ΄βββββββββββββββββββββββββββββ Write a debugging log. A typical debug_options string is d:t:o,file_name. The default is d:t:o,/tmp/mysqlslap.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β. β’ --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, mysqlslap normally reads the [client] and [mysqlslap] groups. If this option is given as --defaults-group-suffix=_other, mysqlslap also reads the [client_other] and [mysqlslap_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β. β’ --delimiter=str, -F str ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --delimiter=str β ββββββββββββββββββββββΌββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββ The delimiter to use in SQL statements supplied in files or using command options. β’ --detach=N ββββββββββββββββββββββ¬βββββββββββββ βCommand-Line Format β --detach=# β ββββββββββββββββββββββΌβββββββββββββ€ βType β Numeric β ββββββββββββββββββββββΌβββββββββββββ€ βDefault Value β 0 β ββββββββββββββββββββββ΄βββββββββββββ Detach (close and reopen) each connection after each N statements. The default is 0 (connections are not detached). β’ --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β.) β’ --engine=engine_name, -e engine_name ββββββββββββββββββββββ¬βββββββββββββββββββββββ βCommand-Line Format β --engine=engine_name β ββββββββββββββββββββββΌβββββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββββ The storage engine to use for creating tables. β’ --get-server-public-key ββββββββββββββββββββββ¬ββββββββββββββββββββββββββ βCommand-Line Format β --get-server-public-key β ββββββββββββββββββββββΌββββββββββββββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββ΄ββββββββββββββββββββββββββ Request from the server the RSA public key that it uses for key pair-based password exchange. This option applies to clients that connect to the server using an account that authenticates with the caching_sha2_password authentication plugin. For connections by such accounts, the server does not send the public key to the client unless requested. The option is ignored for accounts that do not authenticate with that plugin. It is also ignored if RSA-based password exchange is not needed, 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. β’ --iterations=N, -i N ββββββββββββββββββββββ¬βββββββββββββββββ βCommand-Line Format β --iterations=# β ββββββββββββββββββββββΌβββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββ΄βββββββββββββββββ The number of times to run the tests. β’ --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β. β’ --no-drop ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --no-drop β ββββββββββββββββββββββΌββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄ββββββββββββ Prevent mysqlslap from dropping any schema it creates during the test run. β’ --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β. β’ --number-char-cols=N, -x N ββββββββββββββββββββββ¬βββββββββββββββββββββββ βCommand-Line Format β --number-char-cols=# β ββββββββββββββββββββββΌβββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββ΄βββββββββββββββββββββββ The number of VARCHAR columns to use if --auto-generate-sql is specified. β’ --number-int-cols=N, -y N ββββββββββββββββββββββ¬ββββββββββββββββββββββ βCommand-Line Format β --number-int-cols=# β ββββββββββββββββββββββΌββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββ΄ββββββββββββββββββββββ The number of INT columns to use if --auto-generate-sql is specified. β’ --number-of-queries=N ββββββββββββββββββββββ¬ββββββββββββββββββββββββ βCommand-Line Format β --number-of-queries=# β ββββββββββββββββββββββΌββββββββββββββββββββββββ€ βType β Numeric β ββββββββββββββββββββββ΄ββββββββββββββββββββββββ Limit each client to approximately this many queries. Query counting takes into account the statement delimiter. For example, if you invoke mysqlslap as follows, the ; delimiter is recognized so that each instance of the query string counts as two queries. As a result, 5 rows (not 10) are inserted. mysqlslap --delimiter=";" --number-of-queries=10 --query="use test;insert into t values(null)" β’ --only-print ββββββββββββββββββββββ¬βββββββββββββββ βCommand-Line Format β --only-print β ββββββββββββββββββββββΌβββββββββββββββ€ βType β Boolean β ββββββββββββββββββββββΌβββββββββββββββ€ βDefault Value β FALSE β ββββββββββββββββββββββ΄βββββββββββββββ Do not connect to databases. mysqlslap only prints what it would have done. β’ --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, mysqlslap 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 mysqlslap 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, mysqlslap 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 mysqlslap 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 mysqlslap 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. β’ --post-query=value ββββββββββββββββββββββ¬βββββββββββββββββββββ βCommand-Line Format β --post-query=value β ββββββββββββββββββββββΌβββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββββ The file or string containing the statement to execute after the tests have completed. This execution is not counted for timing purposes. β’ --post-system=str ββββββββββββββββββββββ¬ββββββββββββββββββββ βCommand-Line Format β --post-system=str β ββββββββββββββββββββββΌββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββ The string to execute using system() after the tests have completed. This execution is not counted for timing purposes. β’ --pre-query=value ββββββββββββββββββββββ¬ββββββββββββββββββββ βCommand-Line Format β --pre-query=value β ββββββββββββββββββββββΌββββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββββ The file or string containing the statement to execute before running the tests. This execution is not counted for timing purposes. β’ --pre-system=str ββββββββββββββββββββββ¬βββββββββββββββββββ βCommand-Line Format β --pre-system=str β ββββββββββββββββββββββΌβββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄βββββββββββββββββββ The string to execute using system() before running the tests. This execution is not counted for timing purposes. β’ --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β. β’ --query=value, -q value ββββββββββββββββββββββ¬ββββββββββββββββ βCommand-Line Format β --query=value β ββββββββββββββββββββββΌββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββ The file or string containing the SELECT statement to use for retrieving data. β’ --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. No output. β’ --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. β’ --sql-mode=mode ββββββββββββββββββββββ¬ββββββββββββββββββ βCommand-Line Format β --sql-mode=mode β ββββββββββββββββββββββΌββββββββββββββββββ€ βType β String β ββββββββββββββββββββββ΄ββββββββββββββββββ Set the SQL mode for the client session. β’ --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. β’ --verbose, -v ββββββββββββββββββββββ¬ββββββββββββ βCommand-Line Format β --verbose β ββββββββββββββββββββββ΄ββββββββββββ Verbose mode. Print more information about what the program does. This option can be used multiple times to increase the amount of information. β’ --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β. 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 MYSQLSLAP(1)
|
mysqlslap - a load emulation client
|
mysqlslap [options]
| null | null |
pyflakes
| null | null | null | null | null |
mirror_server
| null | null | null | null | null |
fitscopy
| null | null | null | null | null |
plasma-store-server
| null | null | null | null | null |
jupyter_mac.command
| null | null | null | null | null |
h5dump
| null | null | null | null | null |
gettextize
|
Prepares a source package to use gettext.
|
gettextize - install or upgrade gettext infrastructure
|
gettextize [OPTION]... [package-dir]
|
--help print this help and exit --version print version information and exit -f, --force force writing of new files even if old exist --po-dir=DIR specify directory with PO files --no-changelog don't update or create ChangeLog files --symlink make symbolic links instead of copying files -n, --dry-run print modifications but don't perform them AUTHOR Written by Ulrich Drepper REPORTING BUGS Report bugs in the bug tracker at <https://savannah.gnu.org/projects/gettext> or by email to <bug-gettext@gnu.org>. COPYRIGHT Copyright Β© 1995-2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html> This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. SEE ALSO The full documentation for gettextize is maintained as a Texinfo manual. If the info and gettextize programs are properly installed at your site, the command info gettextize should give you access to the complete manual. GNU gettext-tools 0.22.5 February 2024 GETTEXTIZE(1)
| null |
lsm2bin
| null | null | null | null | null |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.