POD files to create man pages

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

diff --git a/gosa-si/client.conf.pod b/gosa-si/client.conf.pod
new file mode 100644 (file)
index 0000000..203b2f6
--- /dev/null
+++ b/gosa-si/client.conf.pod
@@ -0,0 +1,118 @@
+
+=head1 NAME
+
+gosa-si-client.conf - Configuration file for gosa-si-client.
+
+
+=head1 DESCRIPTION
+
+The gosa-si-client.conf file defines all parameter GOsa-SI-client needs for running and communication with GOsa-SI-server. It is normally located in the F</etc/gosa-si/> directory and is generated automatically by the gosa-si-client(1) program during installation. 
+
+=head1 DIRECTIVES
+
+=head2 [general]
+
+=over 4
+
+=item log-file = /var/run/gosa-si-client.log
+
+Defines the location for the log file.
+
+=item pid-file = /var/run/gosa-si-client.pid
+
+Defines the location for the pid file.
+
+=back
+
+
+=head2 [client]
+
+=over 4
+
+=item port = 20083
+
+Defines the port GOsa-SI-client is listening for incoming messages.
+
+=item ip = 0.0.0.0
+
+If set GOsa-SI-client is forced to use this ip address. If it is not set, an automated determination is tried.
+
+=item mac-address = 00:00:00:00:00:00
+
+If set GOsa-SI-client is forced to use this mac address. If it is not set, an automated determination is tried.
+
+=item server-domain =
+
+???
+
+=item ldap = 1 | 0
+
+???
+
+=item ldap-config = /etc/ldap/ldap.conf
+
+Defines the location for ldap.conf file.
+
+=item pam-config = /etc/pam_ldap.conf
+
+Defines the location for pam-ldap.conf file. 
+
+=item nss-config = /etc/libnss-ldap.conf
+
+Defines the location for libnss-ldap.conf file.
+
+=item fai-logpath = /var/log/fai/fai.log
+
+Defines the location for fai.log file.
+
+=item force-hostname = false | true
+
+???
+
+=back
+
+
+=head2 [server]
+
+=over 4
+
+=item ip = 127.0.0.1
+
+If set GOsa-SI-client is forced to register at specified GOsa-SI-Server. If it is not set, GOsa-SI tries to register at GOsa-SI-servers found in DNS. 
+
+=item port = 20081
+
+Defines the port GOsa-SI-server is listening for incoming messages.
+
+=item key = 
+
+Defines the password GOsa-SI-server messages should be encrypted. This has to be modified, default value will usually not work!!!
+
+=item timeout = 10
+
+Defines in seconds the timeout GOsa-SI-client is waiting for the next try if all registraion efforts fails.
+
+=item key-lifetime = 600
+
+Defines in seconds the lifetime of the key GOsa-SI-server messages should be encrypted with. 
+
+=back
+
+
+=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.pod b/gosa-si/gosa-si-server.pod
new file mode 100644 (file)
index 0000000..c69d824
--- /dev/null
+++ b/gosa-si/gosa-si-server.pod
@@ -0,0 +1,60 @@
+#
+#===============================================================================
+#
+#         FILE:  gosa-si-server.pod
+#
+#  DESCRIPTION:  
+#
+#       AUTHOR:   (), <>
+#      COMPANY:  
+#      CREATED:  31.07.2008 15:52:15 CEST
+#     REVISION:  ---
+#===============================================================================
+
+
+=head1 NAME
+
+gosa-si-server -Support infrastructure for GOsa
+
+=head1 SYNOPSIS
+
+    gosa-si-server [-hvf] [-c config]
+
+=head1 OPTIONS
+
+    -h        : print out this help message
+
+    -f        : foregroud, process will not be forked to background
+
+    -v*       : be verbose (multiple v's will increase verbosity)
+
+    -c <file> : configuration file, default F</etc/gosa-si/server.conf>
+
+    --no-arp  : starts script without connection to arp module
+
+
+=head1 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 SI nework is realised by XML messages.
+
+
+=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/server.conf.pod b/gosa-si/server.conf.pod
new file mode 100644 (file)
index 0000000..957c3a6
--- /dev/null
+++ b/gosa-si/server.conf.pod
@@ -0,0 +1,227 @@
+
+=head1 NAME
+
+gosa-si-server.conf - Configuration file for gosa-si-server.
+
+
+=head1 DESCRIPTION
+
+The gosa-si-server.conf file defines all parameter GOsa-SI-server needs for running. It is normally located in the /etc/gosa-si/ directory and is generated automatically by the gosa-si-server(1) program during installation. 
+
+=head1 DIRECTIVES
+
+
+=head2 [general]
+
+=over 4
+
+=item logfile = /var/log/gosa-si-server.log
+
+Defines the location for the log file.
+
+=item pid-file = /var/run/gosa-si-server.pid
+Defines the location for the pid file.
+
+=back
+
+
+=head2 [server]
+
+=over 4
+
+=item port = 20081
+
+Defines the port GOsa-SI-server is listening for incoming messages.
+
+=item known-clients = /var/lib/gosa-si/clients.db
+
+Defines the location for the local DB 'known_clients'.
+
+=item known-server = /var/lib/gosa-si/servers.db
+
+Defines the location for the local DB 'known_server'.
+
+=item incoming = /var/lib/gosa-si/incoming.db
+
+Defines the location for the local DB 'incoming'.
+
+=item login-users = /var/lib/gosa-si/users.db
+
+Defines the location for the local DB 'login_users'.
+
+=item fai-server = /var/lib/gosa-si/fai_server.db
+
+Defines the location for the local DB 'fai_server'.
+
+=item fai-release = /var/lib/gosa-si/fai_release.db
+
+Defines the location for the local DB 'fai_release'.
+
+=item packages-list = /var/lib/gosa-si/packages.db
+
+Defines the location for the local DB 'packages_list'.
+
+=item messaging = /var/lib/gosa-si/messaging.db
+
+Defines the location for the local DB 'messaging'.
+
+=item foreign-clients = /var/lib/gosa-si/foreign_clients.db
+
+Defines the location for the local DB 'foreign_clients'.
+
+=item source-list = /etc/apt/sources.list
+
+Defines the location for the sources file. 
+
+=item repo-path = /srv/www/repository
+
+???
+
+=item ldap-uri = 
+
+Defines the LDAP uniform resource identifier.
+
+=item ldap-base = 
+
+Defines the LDAP base. 
+
+=item ldap-admin-dn = 
+
+Defines the distinguished name of the administrator.
+
+=item ldap-admin-password = 
+
+Defines the password of the administrator.
+
+=item gosa-unit-tag = 
+
+???
+
+=item max-clients = 10
+
+Defines the maximum number of GOsa-SI-clients connected to the GOsa-SI-server.
+
+=item wol-password =
+
+Defines the password for wake on LAN (WOL).
+
+=back
+
+=head2 [GOsaPackages]
+
+=over 4
+
+=item job-queue = /var/lib/gosa-si/jobs.db
+
+Defines the location for the local DB 'job_queue'.
+
+=item job-queue-loop-delay = 3
+
+Defines the seconds the job queue is checked. 
+
+=item messaging-db-loop-delay = 3
+
+Defines the seconds the messaging queue is checked.
+
+=item key = none
+
+Defines the password incoming GOsaPackages messages should be encrypted. This has to be modified, default value will not work!!!
+
+=item dak-base = /srv/archive
+
+???
+
+=item dak-keyring = /srv/archive/keyrings
+
+???
+
+=item dak-queue = /srv/archive/queue
+
+???
+
+=item dak-usr = deb-dak
+
+???
+
+=back
+
+
+=head2 [ClientPackages]
+
+=over 4
+
+=item key = none
+
+Defines the password incoming ClientPackages messages should be encrypted. This has to be modified, default value will not work!!!
+
+=back
+
+
+=head2 [ServerPackages]
+
+=over 4
+
+=item address = 
+
+???
+
+=item domain =
+
+???
+
+=item key = none
+
+Defines the password incoming ServerPackages messages should be encrypted. This has to be modified, default value will not work!!!
+
+=item key-lifetime = 120
+
+Defines the lifetime in seconds of a GOsa-SI-server key. After expiring the key will be automatically renewed. 
+
+=item job-synchronization-enabled = true | false
+
+Defines whether job queue informations are be shared with other GOsa-SI-server in network.
+
+=item synchronization-loog = 5
+
+Defines in seconds after which time the job queue synchronization is being done. 
+
+=back
+
+
+=head2 [ArpHandler]
+
+=over
+
+=item enabled = true | false
+
+Defines whether the ArpHandler is being activated at GOsa-SI-server start.
+
+=item interface = all
+
+???
+
+=back
+
+
+=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
+
+
+