[Python-apps-commits] r10952 - in packages/spambayes/trunk/debian/docs (11 files)

hugo6390-guest at users.alioth.debian.org hugo6390-guest at users.alioth.debian.org
Fri Jun 13 13:49:41 UTC 2014 

    Date: Friday, June 13, 2014 @ 13:49:40
  Author: hugo6390-guest
Revision: 10952

Fixed bad manpages

Modified:
  packages/spambayes/trunk/debian/docs/core_server.1
  packages/spambayes/trunk/debian/docs/sb_bnfilter.1
  packages/spambayes/trunk/debian/docs/sb_bnserver.1
  packages/spambayes/trunk/debian/docs/sb_dbexpimp.1
  packages/spambayes/trunk/debian/docs/sb_filter.1
  packages/spambayes/trunk/debian/docs/sb_imapfilter.1
  packages/spambayes/trunk/debian/docs/sb_mailsort.1
  packages/spambayes/trunk/debian/docs/sb_mboxtrain.1
  packages/spambayes/trunk/debian/docs/sb_server.1
  packages/spambayes/trunk/debian/docs/sb_unheader.1
  packages/spambayes/trunk/debian/docs/sb_xmlrpcserver.1

Modified: packages/spambayes/trunk/debian/docs/core_server.1
===================================================================
--- packages/spambayes/trunk/debian/docs/core_server.1	2014-06-13 13:26:10 UTC (rev 10951)
+++ packages/spambayes/trunk/debian/docs/core_server.1	2014-06-13 13:49:40 UTC (rev 10952)
@@ -1,5 +1,4 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.10.
-.TH OPTION "1" "June 2014" "core_server" "User Commands"
+.TH CORE_SERVER "1" "June 2014" "core_server" "User Commands"
 .SH NAME
 core_server - The primary server for SpamBayes.
 .SH DESCRIPTION

Modified: packages/spambayes/trunk/debian/docs/sb_bnfilter.1
===================================================================
--- packages/spambayes/trunk/debian/docs/sb_bnfilter.1	2014-06-13 13:26:10 UTC (rev 10951)
+++ packages/spambayes/trunk/debian/docs/sb_bnfilter.1	2014-06-13 13:49:40 UTC (rev 10952)
@@ -1,75 +1,10 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.10.
-.TH OPTION "1" "June 2014" "option --version not recognized" "User Commands"
+.TH SB_BNFILTER "1" "June 2014" "sb_bnfilter" "User Commands"
 .SH NAME
-option \- manual page for option --version not recognized
+sb_bnfilter - a similar interface and purpose to sb_filter
 .SH SYNOPSIS
 .B %(program)s
 [\fIoptions\fR]
 .SH DESCRIPTION
-option \fB\-\-help\fR not recognized
-.SS "Where:"
-.HP
-\fB\-h\fR
-.IP
-show usage and exit
-.PP
-*   \fB\-f\fR
-.IP
-filter (default if no processing options are given)
-.PP
-*   \fB\-g\fR
-.IP
-[EXPERIMENTAL] (re)train as a good (ham) message
-.PP
-*   \fB\-s\fR
-.IP
-[EXPERIMENTAL] (re)train as a bad (spam) message
-.PP
-*   \fB\-t\fR
-.IP
-[EXPERIMENTAL] filter and train based on the result \fB\-\-\fR you must
-make sure to untrain all mistakes later.  Not recommended.
-.PP
-*   \fB\-G\fR
-.IP
-[EXPERIMENTAL] untrain ham (only use if you've already trained
-this message)
-.PP
-*   \fB\-S\fR
-.IP
-[EXPERIMENTAL] untrain spam (only use if you've already trained
-this message)
-.HP
-\fB\-k\fR FILE
-.IP
-Unix domain socket used to communicate with a short\-lived server
-process. Default is ~/.sbbnsock\-<hostname>
-.IP
-These options will not take effect when connecting to a preloaded server:
-.HP
-\fB\-p\fR FILE
-.TP
-use pickle FILE as the persistent store.
-loads data from this file
-.IP
-if it exists, and saves data to this file at the end.
-.HP
-\fB\-d\fR FILE
-.IP
-use DBM store FILE as the persistent store.
-.HP
-\fB\-o\fR section:option:value
-.IP
-set [section, option] in the options database to value
-.HP
-\fB\-a\fR seconds
-.IP
-timeout in seconds between requests before this server terminates
-.HP
-\fB\-A\fR number
-.IP
-terminate this server after this many requests
-.PP
 Usage: %(program)s [options]
 .SS "Where:"
 .HP

Modified: packages/spambayes/trunk/debian/docs/sb_bnserver.1
===================================================================
--- packages/spambayes/trunk/debian/docs/sb_bnserver.1	2014-06-13 13:26:10 UTC (rev 10951)
+++ packages/spambayes/trunk/debian/docs/sb_bnserver.1	2014-06-13 13:49:40 UTC (rev 10952)
@@ -1,7 +1,6 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.10.
-.TH OPTION "1" "June 2014" "sb_bnserver" "User Commands"
+.TH SB_BNSERVER "1" "June 2014" "sb_bnserver" "User Commands"
 .SH NAME
-sb_bnserver - The secondary server
+sb_bnserver - Another server version of hammie.py
 .SH SYNOPSIS
 .B %(program)s
 [\fIoptions\fR] \fIFILE\fR

Modified: packages/spambayes/trunk/debian/docs/sb_dbexpimp.1
===================================================================
--- packages/spambayes/trunk/debian/docs/sb_dbexpimp.1	2014-06-13 13:26:10 UTC (rev 10951)
+++ packages/spambayes/trunk/debian/docs/sb_dbexpimp.1	2014-06-13 13:49:40 UTC (rev 10952)
@@ -1,12 +1,8 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.10.
-.TH OPTION "1" "June 2014" "option --version not recognized" "User Commands"
+.TH SB_DBEXPIMP "1" "June 2014" "sb_dbexpimp" "User Commands"
 .SH NAME
-option \- manual page for option --version not recognized
-.SH DESCRIPTION
-option \fB\-\-help\fR not recognized
-.PP
 sb_dbexpimp.py \- Bayes database export/import
-.IP
+.SH DESCRIPTION
 This utility has the primary function of exporting and importing
 a spambayes database into/from a CSV file.  This is useful in a number
 of scenarios.
@@ -62,88 +58,7 @@
 If neither \fB\-p\fR nor \fB\-d\fR is specified, then the values in your configuration
 file (or failing that, the defaults) will be used.  In this way, you may
 convert to and from storage formats other than pickle and dbm.
-.SH EXAMPLES
-
-.IP
-Export pickled mybayes.db into mybayes.db.export as a CSV file
-.IP
-sb_dbexpimp \fB\-e\fR \fB\-p\fR mybayes.db \fB\-f\fR mybayes.db.export
-.IP
-Import mybayes.db.export into a new DBM mybayes.db
-.IP
-sb_dbexpimp \fB\-i\fR \fB\-d\fR mybayes.db \fB\-f\fR mybayes.db.export
-.IP
-Convert a bayes database from pickle to DBM
-.IP
-sb_dbexpimp \fB\-e\fR \fB\-p\fR abayes.db \fB\-f\fR abayes.export
-sb_dbexpimp \fB\-i\fR \fB\-d\fR abayes.db \fB\-f\fR abayes.export
-.IP
-Create a new DBM database (newbayes.db) from two
-.IP
-DBM databases (abayes.db, bbayes.db)
-sb_dbexpimp \fB\-e\fR \fB\-d\fR abayes.db \fB\-f\fR abayes.export
-sb_dbexpimp \fB\-e\fR \fB\-d\fR bbayes.db \fB\-f\fR bbayes.export
-sb_dbexpimp \fB\-i\fR \fB\-d\fR newbayes.db \fB\-f\fR abayes.export
-sb_dbexpimp \fB\-i\fR \fB\-m\fR \fB\-d\fR newbayes.db \fB\-f\fR bbayes.export
 .PP
-sb_dbexpimp.py \- Bayes database export/import
-.IP
-This utility has the primary function of exporting and importing
-a spambayes database into/from a CSV file.  This is useful in a number
-of scenarios.
-.IP
-Platform portability of database \- CSV files can be exported and
-imported across platforms (Windows and Linux, for example).
-.IP
-Database implementation changes \- databases can survive database
-implementation upgrades or new database implementations.  For example,
-if a dbm implementation changes between python x.y and python x.y+1...
-.IP
-Database reorganization \- an export followed by an import reorgs an
-existing database, <theoretically> improving performance, at least in
-some database implementations.
-.IP
-Database sharing \- it is possible to distribute particular databases
-for research purposes, database sharing purposes, or for new users to
-have a 'seed' database to start with.
-.IP
-Database merging \- multiple databases can be merged into one quite
-easily by specifying \fB\-m\fR on an import.  This will add the two database
-nham and nspams together and for wordinfo conflicts, will add spamcount
-and hamcount together.
-.SS "Usage:"
-.IP
-sb_dbexpimp [options]
-.IP
-options:
-.TP
-\fB\-e\fR
-: export
-.TP
-\fB\-i\fR
-: import
-.IP
-\fB\-f\fR: FN : flat file to export to or import from
-\fB\-p\fR: FN : name of pickled database file to use
-\fB\-d\fR: FN : name of dbm database file to use
-\fB\-m\fR     : merge import into an existing database file.  This is
-.IP
-meaningful only for import. If omitted, a new database
-file will be created.  If specified, the imported
-wordinfo will be merged into an existing database.
-Run dbExpImp \fB\-h\fR for more information.
-.IP
-\fB\-o\fR: section:option:value :
-.IP
-set [section, option] in the options database to value
-.TP
-\fB\-h\fR
-: help
-.PP
-If neither \fB\-p\fR nor \fB\-d\fR is specified, then the values in your configuration
-file (or failing that, the defaults) will be used.  In this way, you may
-convert to and from storage formats other than pickle and dbm.
-.PP
 
 .IP
 Export pickled mybayes.db into mybayes.db.export as a CSV file

Modified: packages/spambayes/trunk/debian/docs/sb_filter.1
===================================================================
--- packages/spambayes/trunk/debian/docs/sb_filter.1	2014-06-13 13:26:10 UTC (rev 10951)
+++ packages/spambayes/trunk/debian/docs/sb_filter.1	2014-06-13 13:49:40 UTC (rev 10952)
@@ -1,4 +1,3 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.10.
 .TH SPAMBAYES "1" "June 2014" "SpamBayes Command Line Filter Version 1.1b1 (February, 25, 2011)" "User Commands"
 .SH NAME
 SpamBayes \- manual page for SpamBayes Command Line Filter Version 1.1b1 (February, 25, 2011)

Modified: packages/spambayes/trunk/debian/docs/sb_imapfilter.1
===================================================================
--- packages/spambayes/trunk/debian/docs/sb_imapfilter.1	2014-06-13 13:26:10 UTC (rev 10951)
+++ packages/spambayes/trunk/debian/docs/sb_imapfilter.1	2014-06-13 13:49:40 UTC (rev 10952)
@@ -1,11 +1,8 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.10.
-.TH OPTION "1" "June 2014" "option --version not recognized" "User Commands"
+.TH SB_IMAPFILTER "1" "June 2014" "sb_imapfilter" "User Commands"
 .SH NAME
-option \- manual page for option --version not recognized
+sb_imapfilter - An IMAP filter 
 .SH DESCRIPTION
-option \fB\-\-help\fR not recognized
-.PP
-An IMAP filter.  An IMAP message box is scanned and all non\-scored
+An IMAP message box is scanned and all non\-scored
 messages are scored and (where necessary) filtered.
 .SS "Usage:"
 .IP
@@ -57,83 +54,7 @@
 .IP
 set [section, option] in the options database
 to value
-.SH EXAMPLES
-
-.IP
-Classify inbox, with dbm database
-.IP
-sb_imapfilter \fB\-c\fR \fB\-d\fR bayes.db
-.IP
-Train Spam and Ham, then classify inbox, with dbm database
-.IP
-sb_imapfilter \fB\-t\fR \fB\-c\fR \fB\-d\fR bayes.db
-.IP
-Train Spam and Ham only, with pickled database
-.IP
-sb_imapfilter \fB\-t\fR \fB\-p\fR bayes.db
-.SS "Warnings:"
-.IP
-o We never delete mail, unless you use the \fB\-e\fR/purge option, but we do
-.IP
-mark a lot as deleted, and your mail client might remove that for
-you.  We try to only mark as deleted once the moved/altered message
-is correctly saved, but things might go wrong.  We *strongly*
-recommend that you try this script out on mail that you can recover
-from somewhere else, at least at first.
 .PP
-An IMAP filter.  An IMAP message box is scanned and all non\-scored
-messages are scored and (where necessary) filtered.
-.SS "Usage:"
-.IP
-sb_imapfilter [options]
-.IP
-note: option values with spaces in them must be enclosed
-.IP
-in double quotes
-.IP
-options:
-.TP
-\fB\-p\fR
-dbname  : pickled training database filename
-.TP
-\fB\-d\fR
-dbname  : dbm training database filename
-.TP
-\fB\-t\fR
-: train contents of spam folder and ham folder
-.TP
-\fB\-c\fR
-: classify inbox
-.TP
-\fB\-h\fR
-: display this message
-.TP
-\fB\-v\fR
-: verbose mode
-.TP
-\fB\-P\fR
-: security option to prompt for imap password,
-.IP
-rather than look in options["imap", "password"]
-.TP
-\fB\-e\fR y/n
-: expunge/purge messages on exit (y) or not (n)
-.IP
-\fB\-i\fR debuglvl : a somewhat mysterious imaplib debugging level
-.IP
-(4 is a good level, and suitable for bug reports)
-.TP
-\fB\-l\fR minutes
-: period of time between filtering operations
-.TP
-\fB\-b\fR
-: Launch a web browser showing the user interface.
-.IP
-\fB\-o\fR section:option:value :
-.IP
-set [section, option] in the options database
-to value
-.PP
 
 .IP
 Classify inbox, with dbm database

Modified: packages/spambayes/trunk/debian/docs/sb_mailsort.1
===================================================================
--- packages/spambayes/trunk/debian/docs/sb_mailsort.1	2014-06-13 13:26:10 UTC (rev 10951)
+++ packages/spambayes/trunk/debian/docs/sb_mailsort.1	2014-06-13 13:49:40 UTC (rev 10952)
@@ -1,9 +1,7 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.10.
-.TH OPTION "1" "June 2014" "option --version not recognized" "User Commands"
+.TH SB_MAILSORT "1" "June 2014" "sb_mailsort" "User Commands"
 .SH NAME
-option \- manual page for option --version not recognized
+sb_mailsort - an email sorter 
 .SH DESCRIPTION
-option \fB\-\-help\fR not recognized
 .SS "To train:"
 .IP
 /usr/bin/sb_mailsort \fB\-t\fR ham.mbox spam.mbox
@@ -13,15 +11,6 @@
 .SS "To print the score and top evidence for a message or messages:"
 .IP
 /usr/bin/sb_mailsort \fB\-s\fR message [message ...]
-.SS "To train:"
-.IP
-/usr/bin/sb_mailsort \fB\-t\fR ham.mbox spam.mbox
-.SS "To filter mail (using .forward or .qmail):"
-.IP
-|/usr/bin/sb_mailsort Maildir/ Mail/Spam/
-.SS "To print the score and top evidence for a message or messages:"
-.IP
-/usr/bin/sb_mailsort \fB\-s\fR message [message ...]
 .SH "SEE ALSO"
 The full documentation for
 .B option

Modified: packages/spambayes/trunk/debian/docs/sb_mboxtrain.1
===================================================================
--- packages/spambayes/trunk/debian/docs/sb_mboxtrain.1	2014-06-13 13:26:10 UTC (rev 10951)
+++ packages/spambayes/trunk/debian/docs/sb_mboxtrain.1	2014-06-13 13:49:40 UTC (rev 10952)
@@ -1,69 +1,10 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.10.
-.TH OPTION "1" "June 2014" "option --version not recognized" "User Commands"
+.TH SB_MBOXTRAIN "1" "June 2014" "sb_mboxtrain" "User Commands"
 .SH NAME
-option \- manual page for option --version not recognized
+sb_mboxtrain - Train spambayes on all previously-untrained messages in a mailbox. 
 .SH SYNOPSIS
 .B sb_mboxtrain
 [\fIOPTIONS\fR] ...
 .SH DESCRIPTION
-option \fB\-\-help\fR not recognized
-.SS "Where OPTIONS is one or more of:"
-.HP
-\fB\-h\fR
-.IP
-show usage and exit
-.HP
-\fB\-d\fR DBNAME
-.TP
-use the DBM store.
-A DBM file is larger than the pickle and
-.IP
-creating it is slower, but loading it is much faster,
-especially for large word databases.  Recommended for use with
-sb_filter or any procmail\-based filter.
-.HP
-\fB\-p\fR DBNAME
-.TP
-use the pickle store.
-A pickle is smaller and faster to create,
-.TP
-but much slower to load.
-Recommended for use with sb_server and
-.IP
-sb_xmlrpcserver.
-.HP
-\fB\-g\fR PATH
-.IP
-mbox or directory of known good messages (non\-spam) to train on.
-Can be specified more than once.
-.HP
-\fB\-s\fR PATH
-.IP
-mbox or directory of known spam messages to train on.
-Can be specified more than once.
-.HP
-\fB\-f\fR
-.TP
-force training, ignoring the trained header.
-Use this if you
-.IP
-need to rebuild your database from scratch.
-.HP
-\fB\-q\fR
-.IP
-quiet mode; no output
-.TP
-\fB\-n\fR
-train mail residing in "new" directory, in addition to "cur"
-directory, which is always trained (Maildir only)
-.TP
-\fB\-r\fR
-remove mail which was trained on (Maildir only)
-.HP
-\fB\-o\fR section:option:value
-.IP
-set [section, option] in the options database to value
-.PP
 Usage: /usr/bin/sb_mboxtrain [OPTIONS] ...
 .SS "Where OPTIONS is one or more of:"
 .HP

Modified: packages/spambayes/trunk/debian/docs/sb_server.1
===================================================================
--- packages/spambayes/trunk/debian/docs/sb_server.1	2014-06-13 13:26:10 UTC (rev 10951)
+++ packages/spambayes/trunk/debian/docs/sb_server.1	2014-06-13 13:49:40 UTC (rev 10952)
@@ -1,12 +1,8 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.10.
-.TH OPTION "1" "June 2014" "option --version not recognized" "User Commands"
+.TH SB_SERVER "1" "June 2014" "sb_server" "User Commands"
 .SH NAME
-option \- manual page for option --version not recognized
+sb_server - The primary server for SpamBayes.
 .SH DESCRIPTION
-option \fB\-\-help\fR not recognized
 .PP
-The primary server for SpamBayes.
-.PP
 Currently serves the web interface, and any configured POP3 and SMTP
 proxies.
 .PP
@@ -53,55 +49,6 @@
 .PP
 To make rebuilding the database easier, uploaded messages are appended
 to _pop3proxyham.mbox and _pop3proxyspam.mbox.
-.PP
-The primary server for SpamBayes.
-.PP
-Currently serves the web interface, and any configured POP3 and SMTP
-proxies.
-.PP
-The POP3 proxy works with classifier.py, and adds a simple
-X\-Spambayes\-Classification header (ham/spam/unsure) to each incoming
-email.  You point the proxy at your POP3 server, and configure your
-email client to collect mail from the proxy then filter on the added
-header.  Usage:
-.IP
-sb_server.py [options] [<server> [<server port>]]
-.IP
-<server> is the name of your real POP3 server
-<port>   is the port number of your real POP3 server, which
-.IP
-defaults to 110.
-.IP
-options:
-.TP
-\fB\-h\fR
-: Displays this help message.
-.IP
-\fB\-d\fR FILE : use the named DBM database file
-\fB\-p\fR FILE : the the named Pickle database file
-\fB\-l\fR port : proxy listens on this port number (default 110)
-\fB\-u\fR port : User interface listens on this port number
-.IP
-(default 8880; Browse http://localhost:8880/)
-.TP
-\fB\-b\fR
-: Launch a web browser showing the user interface.
-.IP
-\fB\-o\fR section:option:value :
-.IP
-set [section, option] in the options database
-to value
-.IP
-All command line arguments and switches take their default
-values from the [pop3proxy] and [html_ui] sections of
-bayescustomize.ini.
-.PP
-For safety, and to help debugging, the whole POP3 conversation is
-written out to _pop3proxy.log for each run, if
-options["globals", "verbose"] is True.
-.PP
-To make rebuilding the database easier, uploaded messages are appended
-to _pop3proxyham.mbox and _pop3proxyspam.mbox.
 .SH "SEE ALSO"
 The full documentation for
 .B option

Modified: packages/spambayes/trunk/debian/docs/sb_unheader.1
===================================================================
--- packages/spambayes/trunk/debian/docs/sb_unheader.1	2014-06-13 13:26:10 UTC (rev 10951)
+++ packages/spambayes/trunk/debian/docs/sb_unheader.1	2014-06-13 13:49:40 UTC (rev 10952)
@@ -1,7 +1,6 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.10.
-.TH USAGE: "1" "June 2014" "usage: unheader.py [ -p pat ... ] [ -s ] folder" "User Commands"
+.TH SB_UNHEADER "1" "June 2014" "sb_unheader" "User Commands"
 .SH NAME
-usage: \- manual page for usage: unheader.py [ -p pat ... ] [ -s ] folder
+sb_unheader - cleans headers from email messages.
 .SH DESCRIPTION
 usage: unheader.py [ \fB\-p\fR pat ... ] [ \fB\-s\fR ] folder
 \fB\-p\fR pat gives a regex pattern used to eliminate unwanted headers

Modified: packages/spambayes/trunk/debian/docs/sb_xmlrpcserver.1
===================================================================
--- packages/spambayes/trunk/debian/docs/sb_xmlrpcserver.1	2014-06-13 13:26:10 UTC (rev 10951)
+++ packages/spambayes/trunk/debian/docs/sb_xmlrpcserver.1	2014-06-13 13:49:40 UTC (rev 10952)
@@ -1,41 +1,10 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.10.
-.TH OPTION "1" "June 2014" "option --version not recognized" "User Commands"
+.TH SB_XMLRPCSERVER "1" "June 2014" "sb_xmlrpcserver" "User Commands"
 .SH NAME
-option \- manual page for option --version not recognized
+sb_xmlrpcserver - A server version of hammie.py. 
 .SH SYNOPSIS
 .B %(program)s
 [\fIoptions\fR] \fIIP:PORT\fR
 .SH DESCRIPTION
-option \fB\-\-help\fR not recognized
-.SS "Where:"
-.HP
-\fB\-h\fR
-.IP
-show usage and exit
-.HP
-\fB\-p\fR FILE
-.TP
-use pickle FILE as the persistent store.
-loads data from this file
-.IP
-if it exists, and saves data to this file at the end.
-.HP
-\fB\-d\fR FILE
-.IP
-use DBM store FILE as the persistent store.
-.HP
-\fB\-o\fR section:option:value
-.IP
-set [section, option] in the options database to value
-.IP
-IP
-.IP
-IP address to bind (use 0.0.0.0 to listen on all IPs of this machine)
-.IP
-PORT
-.IP
-Port number to listen to.
-.PP
 Usage: %(program)s [options] IP:PORT
 .SS "Where:"
 .HP

More information about the Python-apps-commits mailing list