From 232ee3c0ac959d30934072c7469156e85fde855d Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Mon, 10 May 2021 12:36:45 -0500 Subject: [PATCH] Man page for pgwui command --- pgwui.1 | 106 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 106 insertions(+) create mode 100644 pgwui.1 diff --git a/pgwui.1 b/pgwui.1 new file mode 100644 index 0000000..2c1f346 --- /dev/null +++ b/pgwui.1 @@ -0,0 +1,106 @@ +.\" Copyright (C) 2021 The Meme Factory, Inc. http://www.karlpinc.com/ +.\" +.\" This file is part of PGWUI_Develop. +.\" +.\" This program is free software: you can redistribute it and/or +.\" modify it under the terms of the GNU Affero General Public License +.\" as published by the Free Software Foundation, either version 3 of +.\" the License, or (at your option) any later version. +.\" +.\" This program 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 +.\" Affero General Public License for more details. +.\" +.\" You should have received a copy of the GNU Affero General Public +.\" License along with this program. If not, see +.\" . +.\" +.\" Karl O. Pinc +.\" +.TH PGWUI "1" "May 2021" +.SH NAME +pgwui \- PostgreSQL Web User Interface utilities +.SH SYNOPSIS +.B pgwui +[\fI\,OPTION\/\fR]... [ [\fI\,ARGS\/\fR]...] +.SH DESCRIPTION +.\" Add any additional description here +.PP +Utility commands for PGWUI, the PostgreSQL Web User Interface. +.TP +\fB\-\-help\fR +Prints a synopsis of the available options and commands. +.SH PGWUI COMMANDS +.SS cookiecutter +.PP +Produce, in the PATH directory, a directory of code containing the basic +elements of a PGWUI component. +PGWUI components are packaged as +independent Python distributions (packages). +.SH SYNOPSIS +.B pgwui cookiecutter +[\fI\,OPTION\/\fR]... [\fI\,PATH\/\fR\] +.SS OPTIONS +.TP +\fB\-\-component\fR \fBTEXT\fR +Name of the component, in mixed case. +.TP +\fB\-\-short\-name\fR \fBTEXT\fR +Lower case component name with PGWUI_ prefix removed. +.TP +\fB\-\-summary\fR \fBTEXT\fR +Short description of component +.TP +\fB\-\-author\-name\fR \fBTEXT\fR +Name of Author. +.TP +\fB\-\-author\-email\fR \fBTEXT\fR +Email of Author. +.TP +\fB\-\-help\fR +Show help message and exit. +.PP +When +.B PATH +is omitted it defaults to the current directory. +.PP +When an option is not supplied its value is prompted for. +.TP +.B +component +The name of the component, usually starting with 'PGWUI_'. +Case is significant. +Generally, the first letter of each word is capitalized. +.TP +.B +short-name +The name of the component without the "PGWUI_" prefix, in lower case. +Used as the default route (with a "/" prepended) and in variable +names, etc. +.TP +.B +summary +Short description to go into setup.py. +Should conform to the Python Packaging Authority Specifications. +For a summary see: +https://packaging.python.org/specifications/core-metadata/#summary +.TP +.B +author-name +The name of the author. +https://packaging.python.org/specifications/core-metadata/#author +.TP +.B +author-email +The email of the author. +https://packaging.python.org/specifications/core-metadata/#author-email +.SH AUTHOR +Written by Karl O. Pinc. +.SH COPYRIGHT +Copyright \(co 2021 The Meme Factory, Inc. +License AGPLv3+: GNU Affero General Public License version 3 or later +. +.br +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. -- 2.34.1