diff options
| -rw-r--r-- | debian/manpages/mycli.1 | 109 |
1 files changed, 63 insertions, 46 deletions
diff --git a/debian/manpages/mycli.1 b/debian/manpages/mycli.1 index e7d5b53..fcf0bb5 100644 --- a/debian/manpages/mycli.1 +++ b/debian/manpages/mycli.1 @@ -1,56 +1,73 @@ -.TH MYCLI 1 "May 05, 2016" -.\" Please adjust this date whenever revising the manpage. +.TH "MYCLI" "1" "2.23.2" "mycli" "DBCLI" + .SH NAME -mycli \- Command line client for MySQL/MariaDB and Percona +mycli \- CLI for MySQL/MariaDB with auto-completion and syntax highlighting + .SH SYNOPSIS -\fBmycli\fP [\fIOPTIONS\fP] \fI[DATABASE\fP] +\fBmycli\fR [\fIOPTIONS\fR] [\fIDATABASE\fR] + .SH DESCRIPTION -mycli is a command line interface for MySQL, MariaDB, and Percona with -auto-completion and syntax highlighting. The CLI is also capable of pretty -printing tabular data. +mycli is a command line interface for MySQL/MariaDB with auto-completion and +syntax highlighting. It is also capable of pretty printing tabular data. + .SH OPTIONS -.TP -.BI -h|--host\ \fITEXT\fP -Host address of the database -.TP -.BI -P|--port\ \fIINTEGER\fP -Port number to use for connection. Honors $MYSQL_TCP_PORT -.TP -.BI -u|--user\ \fITEXT\fP -User name to connect to the database -.TP -.BI -S|--socket\ \fITEXT\fP +.IP "\-h|\-\-host \fITEXT\fR" 4 +Host address of the database. + +.IP "\-P|\-\-port \fIINTEGER\fR" 4 +Port number to use for connection. Honors $MYSQL_TCP_PORT. + +.IP "\-u|\-\-user \fITEXT\fR" 4 +User name to connect to the database. + +.IP "\-S|\-\-socket \fITEXT\fR" 4 The socket file to use for connection. + +.IP "\-p|\-\-password|\-\-pass \fITEXT\fR" 4 +Password to connect to the database. + +.IP "\-v|\-\-version" 4 +Version of mycli. + +.IP "\-D|\-\-database \fITEXT\fR" 4 +Database to use. + +.IP "\-R|\-\-prompt \fITEXT\fR" 4 +Prompt format (Default: "\\t \\u@\\h:\\d> "). + +.IP "\-l|\-\-logfile \fIFILENAME\fR" 4 +Log every query and its results to a file. + +.IP "\-\-defaults\-group\-suffix \fITEXT\fR" 4 +Read config group with the specified suffix. + +.IP "\-\-defaults\-file \fIPATH\fR" 4 +Only read default options from the given file. + +.IP "\-\-login-path \fITEXT\fR" 4 +Read this path from the login file. + +.IP "\-\-help" 4 +Shows the help message and exit. + +.SH EXAMPLES +$ mycli my_database .TP -.BI -p|--password|--pass\ \fITEXT\fP -Password to connect to the database -.TP -.BI -v|--version -Version of mycli -.TP -.BI -D|--database\ \fITEXT\fP -Database to use -.TP -.BI -R|--prompt\ \fITEXT\fP -Prompt format \fI(Default: "\\t \\u@\\h:\\d> "\fP) -.TP -.BI -l|--logfile\ \fIFILENAME\fP -Log every query and its results to a file +$ mycli -u my_user -h my_host.com my_database .TP -.BI --defaults-group-suffix\ \fITEXT\fP -Read config group with the specified suffix +$ mycli mysql://my_user@my_host.com:3306/my_database + +.SH SEE ALSO +litecli(1) .TP -.BI --defaults-file\ \fIPATH\fP -Only read default options from the given file +pgcli(1) .TP -.BI --login-path\ \fITEXT\fP -Read this path from the login file +iredis(1) + +.SH HOMEPAGE +More information about mycli and the DBCLI project can be found on the homepage at https://www.mycli.net and https://www.dbcli.com. + +.SH AUTHORS +mycli was written by Amjith Ramanujam <amjith.r@gmail.com>. .TP -.BI --help -Shows the help message and exit -.RE -.SH AUTHOR -mycli is written by Amjith Ramanujam (http://mycli.net) -.PP -This manual page was written by Lennart Weller <lhw@ring0.de>, -for the Debian project (but may be used by others). +This manual page was written by Lennart Weller <lhw@ring0.de>, for the Debian project (but may be used by others). |