update: better man pages

git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@12181 594d385d-05f5-0310-b6e9-bd551577e9d8

diff --git a/gosa-si/gosa-si-client.1 b/gosa-si/gosa-si-client.1
index d4064aca295a22cb0afc20d77c7167e52cb27090..38308db951d0c48a283c12014933055307c8ec52 100644 (file)
--- a/gosa-si/gosa-si-client.1
+++ b/gosa-si/gosa-si-client.1
@@ -1,52 +1,181 @@
-.TH GOSA-SI-CLIENT 1 "JULY 2008" Linux "User Manuals"
-.SH NAME
-gosa-si-client \- client for GOsa support infrastructure
-.SH SYNOPSIS
-.B gosa-si-client [-hvf] [-c 
-.I config-file 
-.B ] 
-
-
-.SH DESCRIPTION
-.B gosa-si-client 
-belongs to the support infrastructure of GOsa. 
-The client registrates at a GOsa-SI-server and accepts messages from it. Each message is related to a working instruction which will be executed at the client. Depending on the message an answer can be send back to the server. 
-
-
-.SH OPTIONS
-.IP -h
-print out this help message
-.IP "-c config-file"
-Use a specific configuration file instead of 
-.IR /etc/gosa-si/client.conf .
-.IP -f
-run program in foreground modus, process will not be forked into background
-.IP -v
-be verbose (multiple v's give more and more informations)
-
-
-.SH FILES
-.I /etc/gosa-si/client.conf
-.RS
-The system wide configuration file. See
-.BR gosa-si-client(5)
-for further details.
-
-.SH ENVIRONMENT
-.IP ?????
-TODO...
-.IR foo.conf .
-Overridden by the
-.B -c
-option.
-
-
-.SH BUGS
-The command name should have been chosen more carefully
-to reflect its purpose.
-.SH AUTHOR
-Andreas Rettenberger <rettenberger at gonicus dot de>
-.SH "SEE ALSO"
-.BR gosa-si-server (1),
-.BR server.conf (5),
-.BR client.conf (5)
+.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.07)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.ie \nF \{\
+.    de IX
+.    tm Index:\\$1\t\\n%\t"\\$2"
+..
+.    nr % 0
+.    rr F
+.\}
+.el \{\
+.    de IX
+..
+.\}
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "GOSA-SI-CLIENT 1"
+.TH GOSA-SI-CLIENT 1 "2008-08-08" " " " "
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+gosa\-si\-client \- Client for GOsa support infrastructure
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+gosa-si-client [\-hvf] [\-c config]
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+\&\fB\-h\fR, \fB\-\-help\fR
+    print out this help message
+.PP
+\&\fB\-v\fR, \fB\-\-verbose\fR
+    be verbose (multiple v's will increase verbosity) 
+    \-v          \s-1ERROR\s0 level
+    \-vvv        \s-1WARNING\s0  + \s-1ERROR\s0 level
+    \-vvvvv      \s-1INFO\s0 + \s-1WARNING\s0 level
+    \-vvvvvvv    \s-1DEBUG\s0 + \s-1INFO\s0 level
+    \-vvvvvvvvv  in and out going xml messages will be displayed
+.PP
+\&\fB\-f\fR, \fB\-\-foreground\fR 
+    foregroud, process will not be forked to background
+.PP
+\&\fB\-c\fR \fIfile\fR, \fB\-\-config=\fR\fIfile\fR
+    configuration file, default \fI/etc/gosa\-si/client.conf\fR
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+\&\fBgosa-si-client\fR belongs to the support infrastructure of GOsa. 
+The client registrates at a GOsa-SI-server and accepts messages from it. 
+Each message is related to a working instruction which will be executed on the client. 
+Depending on the message an answer can be send back to the server.
+.SH "BUGS"
+.IX Header "BUGS"
+Please report any bugs, or post any suggestions, to the GOsa mailing list <gosa\-devel@oss.gonicus.de> or to <https://oss.gonicus.de/labs/gosa>
+.SH "LICENCE AND COPYRIGHT"
+.IX Header "LICENCE AND COPYRIGHT"
+This code is part of GOsa (<http://www.gosa\-project.org>)
+.PP
+Copyright (C) 2003\-2008 \s-1GONICUS\s0 GmbH
+.PP
+This program is distributed in the hope that it will be useful,
+but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
+\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the
+\&\s-1GNU\s0 General Public License for more details.

diff --git a/gosa-si/gosa-si-client.pod b/gosa-si/gosa-si-client.pod
new file mode 100644 (file)
index 0000000..a5d2b24
--- /dev/null
+++ b/gosa-si/gosa-si-client.pod
@@ -0,0 +1,56 @@
+
+=head1 NAME
+
+gosa-si-client - Client for GOsa support infrastructure
+
+=head1 SYNOPSIS
+
+gosa-si-client [-hvf] [-c config]
+
+=head1 OPTIONS
+
+B<-h>, B<--help>
+    print out this help message
+
+B<-v>, B<--verbose>
+    be verbose (multiple v's will increase verbosity) 
+    -v          ERROR level
+    -vvv        WARNING  + ERROR level
+    -vvvvv      INFO + WARNING level
+    -vvvvvvv    DEBUG + INFO level
+    -vvvvvvvvv  in and out going xml messages will be displayed
+
+B<-f>, B<--foreground> 
+    foregroud, process will not be forked to background
+
+B<-c> I<file>, B<--config=>I<file>
+    configuration file, default F</etc/gosa-si/client.conf>
+
+
+=head1 DESCRIPTION
+
+B<gosa-si-client> belongs to the support infrastructure of GOsa. 
+The client registrates at a GOsa-SI-server and accepts messages from it. 
+Each message is related to a working instruction which will be executed on the client. 
+Depending on the message an answer can be send back to the server.
+
+=head1 BUGS 
+
+Please report any bugs, or post any suggestions, to the GOsa mailing list <gosa-devel@oss.gonicus.de> or to <https://oss.gonicus.de/labs/gosa>
+
+
+=head1 LICENCE AND COPYRIGHT
+
+This code is part of GOsa (L<http://www.gosa-project.org>)
+
+Copyright (C) 2003-2008 GONICUS GmbH
+
+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 General Public License for more details.
+
+=cut
+
+
+

diff --git a/gosa-si/gosa-si-server.1 b/gosa-si/gosa-si-server.1
index ba2707e69f87ca6c91567d11d65446deae0f2ea3..6571e57f30e8af5883647176b30b3dae9bad59cf 100644 (file)
--- a/gosa-si/gosa-si-server.1
+++ b/gosa-si/gosa-si-server.1
@@ -132,7 +132,7 @@
 .\" ========================================================================
 .\"
 .IX Title "GOSA-SI-SERVER 1"
-.TH GOSA-SI-SERVER 1 "2008-08-07" " " " "
+.TH GOSA-SI-SERVER 1 "2008-08-08" " " " "
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -146,17 +146,25 @@ gosa\-si\-server \-Support infrastructure for GOsa
 .Ve
 .SH "OPTIONS"
 .IX Header "OPTIONS"
-.Vb 1
-\&    \-h        : print out this help message
-\&
-\&    \-f        : foregroud, process will not be forked to background
-\&
-\&    \-v*       : be verbose (multiple v\*(Aqs will increase verbosity)
-\&
-\&    \-c <file> : configuration file, default F</etc/gosa\-si/server.conf>
-\&
-\&    \-\-no\-arp  : starts script without connection to arp module
-.Ve
+\&\fB\-h\fR, \fB\-\-help\fR
+    print out this help message
+.PP
+\&\fB\-v\fR, \fB\-\-verbose\fR
+    be verbose (multiple v's will increase verbosity) 
+    \-v          \s-1ERROR\s0 level
+    \-vvv        \s-1WARNING\s0  + \s-1ERROR\s0 level
+    \-vvvvv      \s-1INFO\s0 + \s-1WARNING\s0 level
+    \-vvvvvvv    \s-1DEBUG\s0 + \s-1INFO\s0 level
+    \-vvvvvvvvv  in and out going xml messages will be displayed
+.PP
+\&\fB\-f\fR, \fB\-\-foreground\fR 
+    foregroud, process will not be forked to background
+.PP
+\&\fB\-c\fR \fIfile\fR, \fB\-\-config=\fR\fIfile\fR
+    configuration file, default \fI/etc/gosa\-si/server.conf\fR
+.PP
+\&\fB\-\-no\-arp\fR
+    starts script without connection to arp module
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
 gosa-si-server  belongs  to  the  support infrastructure of GOsa.  Several gosa-si-clients can connect to one gosa-si-server.  The server take care of the message forwarding from GOsa to si-clients.  At the client site each message is related to a working instruction which will be executed there.  Depending of the message an answer from the client to GOsa via the server is possible.  Additional to answers clients reporting events  or  information  to the server.  The server registers himself at other servers in network and shares his knowledge with them.  So messages to clients which are no registrated locally will be forward to the client corresponding server. The communication within the complete \s-1SI\s0 nework is realised by \s-1XML\s0 messages.

diff --git a/gosa-si/gosa-si-server.pod b/gosa-si/gosa-si-server.pod
index b41fe5f808b241fa1d49c84a06445683ba9fa898..24356b9b8ab278e13842bf938cc14fbe118ebc30 100644 (file)
--- a/gosa-si/gosa-si-server.pod
+++ b/gosa-si/gosa-si-server.pod
@@ -5,19 +5,30 @@ gosa-si-server -Support infrastructure for GOsa
 
 =head1 SYNOPSIS
 
-    gosa-si-server [-hvf] [-c config]
+gosa-si-server [-hvf] [-c config]
 
 =head1 OPTIONS
 
-    -h        : print out this help message
+B<-h>, B<--help>
+    print out this help message
 
-    -f        : foregroud, process will not be forked to background
+B<-v>, B<--verbose>
+    be verbose (multiple v's will increase verbosity) 
+    -v          ERROR level
+    -vvv        WARNING  + ERROR level
+    -vvvvv      INFO + WARNING level
+    -vvvvvvv    DEBUG + INFO level
+    -vvvvvvvvv  in and out going xml messages will be displayed
 
-    -v*       : be verbose (multiple v's will increase verbosity)
+B<-f>, B<--foreground> 
+    foregroud, process will not be forked to background
 
-    -c <file> : configuration file, default F</etc/gosa-si/server.conf>
+B<-c> I<file>, B<--config=>I<file>
+    configuration file, default F</etc/gosa-si/server.conf>
+
+B<--no-arp>
+    starts script without connection to arp module
 
-    --no-arp  : starts script without connection to arp module
 
 
 =head1 DESCRIPTION