[pan2] Add man page



commit aa59d3f180f6e703e45c16c13e3947fc6d26a7be
Author: Petr Kovar <pknbe volny cz>
Date:   Tue Dec 19 22:25:51 2017 +0100

    Add man page
    
    Edit option descriptions.

 Makefile.am    |    3 +++
 pan.1          |   55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 pan/gui/pan.cc |   19 +++++++++++--------
 3 files changed, 69 insertions(+), 8 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 13911e6..c8ee388 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -16,6 +16,8 @@ pan.appdata.xml: pan.appdata.xml.in
 appdatadir = $(datadir)/appdata
 appdata_DATA = pan.appdata.xml
 
+man_MANS = pan.1
+
 CLEANFILES = \
  pan.appdata.xml \
  pan.desktop \
@@ -45,5 +47,6 @@ EXTRA_DIST = \
  pan.appdata.xml.in \
  pan.desktop.in \
  pan-git.version \
+ $(man_MANS) \
  $(NULL)
 
diff --git a/pan.1 b/pan.1
new file mode 100644
index 0000000..076eb4e
--- /dev/null
+++ b/pan.1
@@ -0,0 +1,55 @@
+.TH PAN 1
+.SH NAME
+Pan \- read and post Usenet articles
+.SH SYNOPSIS
+.B pan
+[\fIOPTIONS...\fR]
+[\fBheaders\fR:\fIGROUP-NAME\fR | \fBnews\fR:\fIMESSAGE-ID\fR]
+.SH DESCRIPTION
+\fBPan\fR is a Usenet newsreader that is good at both text and binaries.
+It supports offline reading, scoring and killfiles, yEnc, NZB, PGP
+handling, multiple servers, and secure connections.
+.SH USAGE
+\fBpan\fR is a program that can be run headless in non-GUI mode, allowing
+for batch processing of NZB files, downloading headers, and more.
+.SH OPTIONS
+.SS "General Options"
+.TP
+.B \-h, \-\-help
+Print usage information and exit.
+.TP
+.B \-v, \-\-version
+Print release version and exit.
+.TP
+.B \-\-verbose
+Be verbose (in non-GUI mode).
+.TP
+.B \-\-debug
+Run in debug mode.
+.SS "URL Options"
+.TP
+.BR headers:\fIGROUP-NAME\fR
+Download new headers for the \fIGROUP-NAME\fR newsgroup.
+.TP
+.B news:\fIMESSAGE-ID\fR
+When specified together with \fB\-\-no-gui\fR, dump the \fIMESSAGE-ID\fR
+article to standard output.
+.SS "NZB Batch Options"
+.TP
+.B \-\-nzb \fIFILE-1 FILE-2 ...\fR
+Process NZB files in non-GUI mode.
+.TP
+.B \-o, \-\-output=\fIPATH\fR
+Path to save attachments listed in the NZB file(s).
+.TP
+.B \-\-no-gui
+Only show console output, not the download queue.
+.SH ENVIRONMENT
+.TP
+.B PAN_HOME
+User data directory to use. Defaults to \fI$HOME/.pan2\fR.
+.TP
+.B SSL_CERT_DIR, SSL_DIR
+Directories to search for SSL certificates.
+.SH BUGS
+To report a bug, visit: \fIhttp://pan.rebelbase.com/bugs/\fR
\ No newline at end of file
diff --git a/pan/gui/pan.cc b/pan/gui/pan.cc
index dae4848..f9207f5 100644
--- a/pan/gui/pan.cc
+++ b/pan/gui/pan.cc
@@ -631,20 +631,23 @@ namespace
     console();
     std::cerr << "Pan " << VERSION << "\n\n" <<
 _("General Options\n"
-"  -h, --help               Show this usage page.\n"
+"  -h, --help               Show this usage information and exit.\n"
+"  -v, --version            Print release version and exit.\n"
 "  --verbose                Be verbose (in non-GUI mode).\n"
+"  --debug                  Run in debug mode.\n"
 "\n"
 "URL Options\n"
-
-// NOT IMPLEMENTED
-//"  news:message-id          Show the specified article.\n"
-//"  news:group.name          Show the specified newsgroup.\n"
+/** NOT IMPLEMENTED
+"  news:message-id          Show the specified article.\n"
+"  news:group.name          Show the specified newsgroup.\n"
+*/
 "  headers:group.name       Download new headers for the specified newsgroup.\n"
-"  --no-gui                 On news:message-id, dump the article to stdout.\n"
+"  news:message-id          When specified together with --no-gui, dump\n"
+"                           the message-id article to standard output.\n"
 "\n"
 "NZB Batch Options\n"
-"  --nzb file1 file2 …      Process nzb files without launching all of Pan.\n"
-"  -o path, --output=path   Path to save attachments listed in the nzb files.\n"
+"  --nzb file1 file2 …      Process NZB files in non-GUI mode.\n"
+"  -o path, --output=path   Path to save attachments listed in the NZB file(s).\n"
 "  --no-gui                 Only show console output, not the download queue.\n") << std::endl;
   }
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]