[Pkg-dspam-commits] [pkg-dspam-commits] r146 - in trunk/debian: . manpages patches

Sun Feb 24 20:48:02 UTC 2008

Author: kbk-guest
Date: Sun Feb 24 20:48:02 2008
New Revision: 146

Log:
Cleanup man pages: fix 'n3' typos; fix unescaped minus signs.


Added:
   trunk/debian/patches/cleanup-manpages.dpatch   (contents, props changed)
Modified:
   trunk/debian/changelog
   trunk/debian/manpages/dspamc.1
   trunk/debian/patches/00list

Modified: trunk/debian/changelog
==============================================================================

--- trunk/debian/changelog	(original)
+++ trunk/debian/changelog	Sun Feb 24 20:48:02 2008
@@ -2,6 +2,7 @@
 
   [Kurt B. Kaiser]
   * Add policy-compliant copyright notice in debian/copyright
+  * Cleanup manpages: remove 'n3' typos; fix unescaped minus signs.
 
  -- Debian DSPAM Maintainers <pkg-dspam-misc at lists.alioth.debian.org>  Sun, 24 Feb 2008 12:34:44 -0500
 

Modified: trunk/debian/manpages/dspamc.1
==============================================================================
--- trunk/debian/manpages/dspamc.1	(original)
+++ trunk/debian/manpages/dspamc.1	Sun Feb 24 20:48:02 2008
@@ -102,7 +102,7 @@
 delivered, the $u (or %u) parameters of the argument string will be interpolated
 for the current user being processed.
  
-.n3 3
+.ne 3
 .TP 
 .BI \-\-mode= [toe|tum|teft|notrain]\c
 Configures the training mode to be used for this process, overriding any

Modified: trunk/debian/patches/00list
==============================================================================
--- trunk/debian/patches/00list	(original)
+++ trunk/debian/patches/00list	Sun Feb 24 20:48:02 2008
@@ -20,3 +20,4 @@
 clean-warnings.dpatch
 fix-tag-class.dpatch
 fix-manpage-libdspam.dpatch
+cleanup-manpages.dpatch

Added: trunk/debian/patches/cleanup-manpages.dpatch
==============================================================================
--- (empty file)
+++ trunk/debian/patches/cleanup-manpages.dpatch	Sun Feb 24 20:48:02 2008
@@ -0,0 +1,171 @@
+#! /bin/sh /usr/share/dpatch/dpatch-run
+## cleanup-manpages.dpatch by Debian DSPAM Maintainers <pkg-dspam-misc at lists.alioth.debian.org>
+##
+## All lines beginning with `## DP:' are a description of the patch.
+## DP: No description.
+
+ at DPATCH@
+diff -urNad dspam~/man/dspam.1 dspam/man/dspam.1
+--- dspam~/man/dspam.1	2006-05-14 11:37:30.000000000 -0400
++++ dspam/man/dspam.1	2008-02-24 15:43:36.000000000 -0500
+@@ -102,7 +102,7 @@
+ delivered, the $u (or %u) parameters of the argument string will be interpolated
+ for the current user being processed.
+  
+-.n3 3
++.ne 3
+ .TP
+ .BI \--mode= [toe|tum|teft|notrain]\c
+ Configures the training mode to be used for this process, overriding any
+@@ -121,7 +121,7 @@
+ : No training.  Do not train the user's data, and do not keep totals.  This should only be used in cases where you want to process mail for a particular user (based on a group, for example), but don't want the user to accumulate any learning data.
+ 
+ .B unlearn
+-: Unlearn original training. Use this if you wish to unlearn a previously learned message. Be sure to specify --source=error and --class to whatever the original classification the message was learned under. If not using TrainPristine, this will require the original signature from training.
++: Unlearn original training. Use this if you wish to unlearn a previously learned message. Be sure to specify \-\-source=error and \-\-class to whatever the original classification the message was learned under. If not using TrainPristine, this will require the original signature from training.
+ 
+ .ne 3
+ .TP
+@@ -150,7 +150,7 @@
+ should be used when a misclassification has occured, when the user is
+ corpus-feeding a message, or when an inoculation is being presented. This
+ flag should not be used for standard processing. This flag must be used in
+-conjunction with the --source flag. Omitting this flag causes DSPAM to
++conjunction with the \-\-source flag. Omitting this flag causes DSPAM to
+ determine the disposition of the message on its own (the standard operating
+ mode).
+  
+@@ -186,7 +186,7 @@
+ .BI \--deliver= [innocent,spam]\c
+ Tells
+ .B DSPAM
+-to deliver the message if its result falls within the criteria specified. For example, --deliver=innocent will cause DSPAM to only deliver the message if its classification has been determined as innocent. Providing --deliver=innocent,spam will cause DSPAM to deliver the message regardless of its classification. This flag provides a significant amount of flexibility for nonstandard implementations.
++to deliver the message if its result falls within the criteria specified. For example, \-\-deliver=innocent will cause DSPAM to only deliver the message if its classification has been determined as innocent. Providing \-\-deliver=innocent,spam will cause DSPAM to deliver the message regardless of its classification. This flag provides a significant amount of flexibility for nonstandard implementations.
+ 
+ .ne 3
+ .TP
+@@ -228,7 +228,7 @@
+ .TP
+ .BI \--signature =[signature]
+ If only the signature is available for training, and not the entire message,
+-the --signature flag may be used to feed the signature into DSPAM and forego
++the \-\-signature flag may be used to feed the signature into DSPAM and forego
+ the reading of stdin. DSPAM will process the signature with whatever
+ commandline classification was specified. NOTE: This should only be used
+ with
+@@ -241,7 +241,7 @@
+ .B DSPAM
+ was compiled with
+ .B --enable-debug
+-then using --debug will turn on debugging messages to /tmp/dspam.debug.
++then using \-\-debug will turn on debugging messages to /tmp/dspam.debug.
+ 
+ .ne 3
+ .TP
+@@ -250,8 +250,8 @@
+ .B DSPAM
+ was compiled with
+ .B --enable-daemon
+-then using --daemon will cause DSPAM to enter daemon mode, where it will listen
+-for DSPAM clients to connect and actively service requests.
++then using \-\-daemon will cause DSPAM to enter daemon mode, where it will
++listen for DSPAM clients to connect and actively service requests.
+ 
+ .ne 3
+ .TP
+@@ -260,7 +260,7 @@
+ .B DSPAM
+ was compiled with
+ .B --enable-daemon
+-then using --client will cause DSPAM to act as a client and attempt to connect to the DSPAM server specified in the client's configuration within dspam.conf. If client behavior is desired, this option
++then using \-\-client will cause DSPAM to act as a client and attempt to connect to the DSPAM server specified in the client's configuration within dspam.conf. If client behavior is desired, this option
+ .B must
+ be specified, otherwise the agent simply operate as self-contained and processes the message on its own, eliminating any benefit of using the daemon.
+ 
+@@ -269,7 +269,7 @@
+ .BI \--rcpt-to\c
+ If
+ .B DSPAM
+-will be configured to deliver via LMTP or SMTP, this flag may be used to define the RCPT TOs which will be used for the delivery of each user specified with --user. If no recipients are provided, the RCPT TOs will match the username.
++will be configured to deliver via LMTP or SMTP, this flag may be used to define the RCPT TOs which will be used for the delivery of each user specified with \--user. If no recipients are provided, the RCPT TOs will match the username.
+ NOTE: The recipient list should always be balanced with the user list, or empty. Specifying an unbalanced number of recipients to users will result in undefined behavior.
+ 
+ .ne 3
+diff -urNad dspam~/man/dspam_clean.1 dspam/man/dspam_clean.1
+--- dspam~/man/dspam_clean.1	2006-05-14 11:37:30.000000000 -0400
++++ dspam/man/dspam_clean.1	2008-02-24 15:43:36.000000000 -0500
+@@ -45,7 +45,7 @@
+ 14 days will be overridden. Specifying an age of 0 will delete all signatures
+ from the user(s) processed.
+ 
+-.n 3
++.ne 3
+ .TP
+ .BI \-p\fR\c
+ Deletes all tokens from the target user(s) database whose probability is
+@@ -73,7 +73,7 @@
+ .B ihl
+ Tokens with a single innocent hit
+ 
+-Ages may be overridden by specifying a format string, such as -u30,15,10,10
++Ages may be overridden by specifying a format string, such as \-u30,15,10,10
+ where each number represents the respective life. Specifying a life of zero
+ will delete all unused tokens in the category.
+ 
+diff -urNad dspam~/man/dspam_dump.1 dspam/man/dspam_dump.1
+--- dspam~/man/dspam_dump.1	2006-05-14 11:37:30.000000000 -0400
++++ dspam/man/dspam_dump.1	2008-02-24 15:44:23.000000000 -0500
+@@ -40,7 +40,7 @@
+ .BI \ username \fR\c
+ The username of the user to dump
+  
+-.n3
++.ne 3
+ .TP
+ .BI \ token \fR\c
+ The text string of the token to search for and dump. If no token is specified,
+diff -urNad dspam~/man/dspam_merge.1 dspam/man/dspam_merge.1
+--- dspam~/man/dspam_merge.1	2006-05-14 11:37:30.000000000 -0400
++++ dspam/man/dspam_merge.1	2008-02-24 15:43:36.000000000 -0500
+@@ -32,7 +32,7 @@
+ token and per-user totals are added together to produce a single composite
+ dataset. After creating a composite user,
+ .B dspam_clean
+-should be run with the -p option to clean up extraneous data.
++should be run with the \-p option to clean up extraneous data.
+ 
+ .B NOTE
+ : Merges may take a considerable amount of time. This could potentially increase
+@@ -46,7 +46,7 @@
+ .BI \ user1\ user2\ ...\ userN \fR\c
+ A list of users to merge together.
+  
+-.n3
++.ne 3
+ .TP
+ .BI \ -o \ username \fR\c
+ The target user which will be created (if necessary). This user will contain
+diff -urNad dspam~/man/dspam_stats.1 dspam/man/dspam_stats.1
+--- dspam~/man/dspam_stats.1	2008-02-24 15:43:35.000000000 -0500
++++ dspam/man/dspam_stats.1	2008-02-24 15:43:36.000000000 -0500
+@@ -62,7 +62,7 @@
+ .BI \-t\fR\c
+ Displays a total of all statistics displayed
+ 
+-.n3 3
++.ne 3
+ .TP
+ .BI [username]\c
+ Specifies the username to query. If no username is provided, all users will be
+diff -urNad dspam~/man/dspam_train.1 dspam/man/dspam_train.1
+--- dspam~/man/dspam_train.1	2006-05-14 11:37:30.000000000 -0400
++++ dspam/man/dspam_train.1	2008-02-24 15:43:36.000000000 -0500
+@@ -44,7 +44,7 @@
+ .ne 3
+ .TP
+ 
+-.n3 3
++.ne 3
+ .TP
+ .BI [username]\c
+ Specifies the user to train.

