From b0f3d83be918bbcd229b21d0aad80729f55eac85 Mon Sep 17 00:00:00 2001 From: Marco van Wieringen Date: Wed, 5 Sep 2012 09:45:59 +0200 Subject: [PATCH] Fix manpage errors, fixes bug #1907 Applied patches supplied in bug 1907. Patch originally provided by Jan Hauke Rahm --- bacula/manpages/bacula-tray-monitor.1 | 4 +- bacula/manpages/bat.1 | 2 +- bacula/manpages/bsmtp.1 | 26 ++++---- bacula/manpages/bwild.8 | 8 +-- bacula/manpages/dbcheck.8 | 87 +++++++++++++++------------ 5 files changed, 69 insertions(+), 58 deletions(-) diff --git a/bacula/manpages/bacula-tray-monitor.1 b/bacula/manpages/bacula-tray-monitor.1 index 23f431d831..811a4e4c6d 100644 --- a/bacula/manpages/bacula-tray-monitor.1 +++ b/bacula/manpages/bacula-tray-monitor.1 @@ -17,7 +17,7 @@ This manual page documents briefly the command, a simple monitor for the 'system tray' in KDE/GNOME .PP .SH OPTIONS -bacula-tray-monitor [\-c config_file] [\-d debug_level] [-t] +bacula-tray-monitor [\-c config_file] [\-d debug_level] [\-t] .TP .B \-c Specify configuration file. @@ -38,5 +38,5 @@ Show version and usage of program. .br .SH AUTHOR This manual page was written by Jose Luis Tallon -.nh +.nh . diff --git a/bacula/manpages/bat.1 b/bacula/manpages/bat.1 index e678eb2670..f94d0324dc 100644 --- a/bacula/manpages/bat.1 +++ b/bacula/manpages/bat.1 @@ -19,7 +19,7 @@ This is a GUI full featured program similar the bconsole program, but it is graphical oriented and more features. .PP .SH OPTIONS -bat [\-s] [\-c config_file] [\-d debug_level] [-t] +bat [\-s] [\-c config_file] [\-d debug_level] [\-t] .TP .B \-c Specify configuration file. Default is bat.conf. diff --git a/bacula/manpages/bsmtp.1 b/bacula/manpages/bsmtp.1 index 854e58c4a9..c1cc83dc04 100644 --- a/bacula/manpages/bsmtp.1 +++ b/bacula/manpages/bsmtp.1 @@ -9,8 +9,8 @@ bsmtp \- Bacula's SMTP client (mail submission program) .SH SYNOPSIS -.B bsmtp -.RI [ options ] +.B bsmtp +.RI [ options ] .I <...> .SH DESCRIPTION @@ -65,14 +65,14 @@ Set the maximum number of lines to be sent. (default: unlimited) Show version and usage of program. .SH USAGE -\fIrecipients\fR is a space separated list of email addresses. +\fIrecipients\fR is a space separated list of email addresses. The body of the email message is read from standard input. Message is -ended by sending the EOF character (Ctrl-D on many systems) on the +ended by sending the EOF character (Ctrl-D on many systems) on the start of a new line, much like many 'mail' commands. The actual, automated behavior of \fBbsmtp\fR will depend on the -mail-related configuration of the Director in the \fIMessages\fR ressource +mail-related configuration of the Director in the \fIMessages\fR resource of \fIbacula-dir.conf\fR. Interactive use of \fBbsmtp\fR is pertinent to manually test and ensure these @@ -84,10 +84,10 @@ file. Messages { Name = Standard - mailcommand = "/home/bacula/bin/bsmtp -h mail.domain.com -f \"\(Bacula\) %r\" - -s \"Bacula: %t %e of %c %l\" %r" - operatorcommand = "/home/bacula/bin/bsmtp -h mail.domain.com -f \"\(Bacula\) %r\" - -s \"Bacula: Intervention needed for %j\" %r" + mailcommand = "/home/bacula/bin/bsmtp \-h mail.domain.com \-f \\"\\(Bacula\\) \\<%r\\>\\" + \-s \\"Bacula: %t %e of %c %l\\" %r" + operatorcommand = "/home/bacula/bin/bsmtp \-h mail.domain.com \-f \\"\\(Bacula\\) \\<%r\\>\\" + \-s \\"Bacula: Intervention needed for %j\\" %r" mail = sysadmin@site.domain.com = all, !skipped operator = sysop@site.domain.com = mount console = all, !skipped, !saved @@ -101,7 +101,7 @@ qualified name of an SMTP server, which usually listen on port 25. If the \fB-h\fR option is not specified, \fBbsmtp\fR will use environment variable \fBSMTPSERVER\fR, or 'localhost' if not set. .SH NOTES -Since \fBbsmtp\fR always uses a TCP connection rather than writing to a +Since \fBbsmtp\fR always uses a TCP connection rather than writing to a spool file, you may find that your \fBFrom:\fR address is being rejected because it does not contain a valid domain, or because your message has gotten caught in spam filtering rules. Generally, you @@ -109,17 +109,17 @@ should specify a fully qualified domain name in the from field, and depending on whether your SMTP gateway is Exim or Sendmail, you may need to modify the syntax of the from part of the message. -If \fBbsmtp\fR cannot connect to the specified mail host, it will retry +If \fBbsmtp\fR cannot connect to the specified mail host, it will retry to connect to \fBlocalhost\fR. .SH BUGS If you are getting incorrect dates (e.g. 1970) and you are -running with a non-English locale, you might try setting the +running with a non-English locale, you might try setting the \fBLANG="en_US"\fR environment variable. .SH AUTHOR This manual page was written by Jose Luis Tallon -.nh +.nh , revised and edited by Lucas B. Cohen .nh . diff --git a/bacula/manpages/bwild.8 b/bacula/manpages/bwild.8 index 51fe09f927..e43a15b702 100644 --- a/bacula/manpages/bwild.8 +++ b/bacula/manpages/bwild.8 @@ -30,7 +30,7 @@ command. This is a simple program that will allow you to test wild-card expressions against a file of data. .PP .\" TeX users may be more comfortable with the \fB\fP and -.\" \fI\fP escape sequences to invode bold face and italics, +.\" \fI\fP escape sequences to invode bold face and italics, .\" respectively. .SH OPTIONS A summary of options is included below. @@ -47,9 +47,9 @@ Print timestamp in debug output .BI \-f\ The data-file is a filename that contains lines of data to be matched (or not) against one or more patterns. When the program is run, it will prompt you for a wild-card pattern, then apply it one line at a time against the data in the file. Each line that matches will be printed preceded by its line number. You will then be prompted again for another pattern. .br -Enter an empty line for a pattern to terminate the program. You can print only lines that do not match by using the -n option, and you can suppress printing of line numbers with the -l option. +Enter an empty line for a pattern to terminate the program. You can print only lines that do not match by using the \-n option, and you can suppress printing of line numbers with the \-l option. .TP -.BI \-n +.BI \-n Print lines that do not match .TP .BI \-l @@ -62,5 +62,5 @@ use case insensitive match. .br .SH AUTHOR This manual page was written by Bruno Friedmann -.nh +.nh . diff --git a/bacula/manpages/dbcheck.8 b/bacula/manpages/dbcheck.8 index 9e3a6f1bef..a92ab86662 100644 --- a/bacula/manpages/dbcheck.8 +++ b/bacula/manpages/dbcheck.8 @@ -8,7 +8,7 @@ .SH NAME dbcheck \- Bacula's Catalog Database Check/Clean program .SH SYNOPSIS -.B bcopy +.B dbcheck .RI [ options ] .I working-directory .I bacula-database @@ -19,46 +19,57 @@ .br .SH DESCRIPTION This manual page documents briefly the -.B dbcheck +.B dbcheck command. .PP dbcheck will not repair your database if it is broken. Please see your vendor's instructions for fixing broken database. dbcheck is a simple program that will search for logical -inconsistencies in the Bacula tables in your database, and optionally fix them. +inconsistencies in the Bacula tables in your database, and optionally fix them. It is a database maintenance routine, in the sense that it can detect and remove unused rows, but it is not a database repair routine. To repair a database, see the tools furnished by the database vendor. Normally dbcheck should never need to be run, but if Bacula has crashed or you have a lot of Clients, Pools, or -Jobs that you have removed, it could be useful. - -It is called: - -Usage: dbcheck [-c config] [-C catalog name] [-d debug_level] [] - -b batch mode - -C catalog name in the director conf file - -c director conf filename - -B print catalog configuration and exit - -dnn set debug level to nn - -dt print timestamp in debug output - -f fix inconsistencies - -v verbose - -? print this message - -If the -c option is given with the Director's conf file, there is no -need to enter any of the command line arguments, in particular the working -directory as dbcheck will read them from the file. - -If the -f option is specified, dbcheck will repair (fix) the -inconsistencies it finds. Otherwise, it will report only. - -If the -b option is specified, dbcheck will run in batch mode, and it will -proceed to examine and fix (if -f is set) all programmed inconsistency -checks. If the -b option is not specified, dbcheck will enter interactive -mode and prompt with the following: - +Jobs that you have removed, it could be useful. +.SH OPTIONS +A summary of options is included below. +.TP +.B \-? +Show version and usage of program. +.TP +.BI \-b +If specified, dbcheck will run in batch mode, and it will proceed to examine +and fix (if \-f is set) all programmed inconsistency checks. By default, +dbcheck will enter interactive mode (see below). +.TP +.BI \-C\ catalog +catalog name in the director conf file. +.TP +.BI \-c\ config +If the \-c option is given with the Director's conf file, there is no need to +enter any of the command line arguments, in particular the working directory +as dbcheck will read them from the file. +.TP +.BI \-B +print catalog configuration and exit. +.TP +.BI -d\ nn +set debug level to \fInn\fP. +.TP +.BI \-dt +print timestamp in debug output. +.TP +.BI \-f +If specified, dbcheck will repair (fix) the inconsistencies it finds. +Otherwise, it will report only. +.TP +.BI \-v +Set verbose mode. +.SH INTERACTIVE MODE +In interactive mode dbcheck will prompt with the following: +.PP Hello, this is the database check/correct program. Please select the function you want to perform. 1) Toggle modify database flag @@ -80,13 +91,13 @@ Please select the function you want to perform. 17) Quit Select function number: -By entering 1 or 2, you can toggle the modify database flag (-f option) and -the verbose flag (-v). It can be helpful and reassuring to turn off the +By entering 1 or 2, you can toggle the modify database flag (\-f option) and +the verbose flag (\-v). It can be helpful and reassuring to turn off the modify database flag, then select one or more of the consistency checks (items 3 through 9) to see what will be done, then toggle the modify flag on and re-run the check. -The inconsistencies examined are the following: +The inconsistencies examined are the following: .BR Duplicate filename records. This can happen if you accidentally run two @@ -168,12 +179,12 @@ Orphaned Job records. If no client is defined for a job or you do not run useless). .BR -All Admin records. This command will remove all Admin records, - regardless of their age. +All Admin records. This command will remove all Admin records, + regardless of their age. .BR -All Restore records. This command will remove all Restore records, - regardless of their age. +All Restore records. This command will remove all Restore records, + regardless of their age. By the way, I personally run dbcheck only where I have messed up my database due to a bug in developing Bacula code, so normally @@ -187,5 +198,5 @@ waste their time running dbcheck too often. .br .SH AUTHOR This manual page was written by Jose Luis Tallon -.nh +.nh . -- 2.39.5