diff options
Diffstat (limited to 'debian/manpages/pgcli.1')
| -rw-r--r-- | debian/manpages/pgcli.1 | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/debian/manpages/pgcli.1 b/debian/manpages/pgcli.1 new file mode 100644 index 0000000..0628377 --- /dev/null +++ b/debian/manpages/pgcli.1 @@ -0,0 +1,62 @@ +.TH "PGCLI" "1" "3.1.0" "pgcli" "DBCLI" + +.SH NAME +pgcli \- CLI for PostgreSQL with auto-completion and syntax highlighting + +.SH SYNOPSIS +\fBpgcli\fR [\fIOPTIONS\fR] [\fIDATABASE\fR] [\fIUSERNAME\fR] + +.SH DESCRIPTION +pgcli is a command line interface for PostgreSQL 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 postgres database. + +.IP "\-p|\-\-port \fIINTEGER\fR" 4 +Port number at which the postgres instance is listening. + +.IP "\-U|\-\-user \fITEXT\fR" 4 +User name to connect to the postgres database. + +.IP "\-W|\-\-password" 4 +Force password prompt. + +.IP "\-w|\-\-no-password" 4 +Never prompt for password. + +.IP "\-v|\-\-version" 4 +Version of pgcli. + +.IP "\-d|\-\-dbname \fITEXT\fR" 4 +Database name to connect to. + +.IP "\-\-pgclirc \fITEXT\fR" 4 +Location of pgclirc file. + +.IP "\-\-help" 4 +Show this message and exit. + +.SH EXAMPLES +$ pgcli local_database +.TP +$ pgcli postgres://amjith:passw0rd@example.com:5432/app_db +.TP +$ pgcli -h localhost -p 5432 -U amjith app_db + +.SH SEE ALSO +litecli(1) +.TP +mycli(1) +.TP +iredis(1) + +.SH HOMEPAGE +More information about pgcli and the DBCLI project can be found on the homepage at https://www.pgcli.com and https://www.dbcli.com. + +.SH AUTHORS +pgcli 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). |