summaryrefslogtreecommitdiffstats
path: root/debian/manpages/mycli.1
diff options
context:
space:
mode:
Diffstat (limited to 'debian/manpages/mycli.1')
-rw-r--r--debian/manpages/mycli.173
1 files changed, 73 insertions, 0 deletions
diff --git a/debian/manpages/mycli.1 b/debian/manpages/mycli.1
new file mode 100644
index 0000000..fcf0bb5
--- /dev/null
+++ b/debian/manpages/mycli.1
@@ -0,0 +1,73 @@
+.TH "MYCLI" "1" "2.23.2" "mycli" "DBCLI"
+
+.SH NAME
+mycli \- CLI for MySQL/MariaDB with auto-completion and syntax highlighting
+
+.SH SYNOPSIS
+\fBmycli\fR [\fIOPTIONS\fR] [\fIDATABASE\fR]
+
+.SH DESCRIPTION
+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
+.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
+$ mycli -u my_user -h my_host.com my_database
+.TP
+$ mycli mysql://my_user@my_host.com:3306/my_database
+
+.SH SEE ALSO
+litecli(1)
+.TP
+pgcli(1)
+.TP
+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
+This manual page was written by Lennart Weller <lhw@ring0.de>, for the Debian project (but may be used by others).