diff options
| -rw-r--r-- | debian/manpages/pgcli.1 | 95 |
1 files changed, 53 insertions, 42 deletions
diff --git a/debian/manpages/pgcli.1 b/debian/manpages/pgcli.1 index 55827dd..3a0dbeb 100644 --- a/debian/manpages/pgcli.1 +++ b/debian/manpages/pgcli.1 @@ -1,51 +1,62 @@ -.TH PGCLI 1 "Jul 01, 2016" -.\" Please adjust this date whenever revising the manpage. +.TH "PGCLI" "1" "3.1.0" "pgcli" "DBCLI" + .SH NAME -pgcli \- Command line client for PostgreSQL +pgcli \- CLI for PostgreSQL with auto-completion and syntax highlighting + .SH SYNOPSIS -\fBpgcli\fP [\fIOPTIONS\fP] \fI[DATABASE\fP] \fI[USERNAME\fP] +\fBpgcli\fR [\fIOPTIONS\fR] [\fIDATABASE\fR] [\fIUSERNAME\fR] + .SH DESCRIPTION -pgcli is a command line interface for PostgreSQL with -auto-completion and syntax highlighting. The CLI is also capable of pretty -printing tabular data. +pgcli is a command line interface for Postgres 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 postgres database -.TP -.BI -p|--port\ \fIINTEGER\fP -Port number at which the postgres instance is listening -.TP -.BI -U|--user\ \fITEXT\fP -User name to connect to the postgres database -.TP -.BI -W|--password -Force password prompt -.TP -.BI -w|--no-password -Never prompt for password -.TP -.BI -v|--version -Version of pgcli -.TP -.BI -d|--dbname \ \fITEXT\fP -Database name to connect to -.TP -.BI --pgclirc \ \fITEXT\fP -Location of pgclirc file -.TP -.BI --help -Show this message and exit -.RE -.SH EXAMPLE USAGE + +.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 -.RE -.SH AUTHOR -pgcli is written by Amjith Ramanujam (http://pgcli.com) -.PP -This manual page was written by Lennart Weller <lhw@ring0.de>, -for the Debian project (but may be used by others). + +.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). |