Updated gen_uids - much faster for big ldap trees now.

[gosa.git] / gosa-core / dh-make-gosa.1

diff --git a/gosa-core/dh-make-gosa.1 b/gosa-core/dh-make-gosa.1
index 5cffd426a74f59f45a78749b657b81e0dfe7ee65..a4b5f36b00f1410907f62af92b7044f2c3027d2c 100644 (file)
--- a/gosa-core/dh-make-gosa.1
+++ b/gosa-core/dh-make-gosa.1
@@ -1,76 +1,89 @@
-.\" Process this file with
-.\" groff -man -Tascii foo.1
-.\"
 .TH DH-MAKE-GOSA 1 "2008-04-07" "GOsa v2.6" "Debian"
 .SH NAME
-dh-make-gosa \- Create debian source packages from GOsa plugins
+dh-make-gosa \- Debianizes the source of a given gosa plugin
 .SH SYNOPSIS
 .B dh-make-gosa [OPTION]...
 .B SOURCE
 .SH DESCRIPTION
-.B foo
-frobnicates the bar library by tweaking internal
-symbol tables. By default it parses all baz segments
-and rearranges them in reverse order by time for the
-.BR xyzzy (1)
-linker to find them. The symdef entry is then compressed
-using the WBG (Whiz-Bang-Gizmo) algorithm.
-All files are processed in the order specified.
+.B dh-make-gosa
+takes a directory or tar ball of an existing gosa plugin
+and adds debian information to it. Feel free to use
+.I dpkg-buildpackage
+to generate your own gosa-plugin package from source or
+svn and enable it in the
+.BR gosa.conf (5)
+file to activate it.
 .SH OPTIONS
-.\"[--download] [-b|--branch branch] [-e|--email mail] [--depends] plugin-dir|plugin.tar.gz
-.IP -b
-Do not write `busy' to stdout while processing.
-.IP "-c config-file"
-Use the alternate system wide
-.I config-file
-instead of
-.IR /etc/foo.conf .
-This overrides any
-.B FOOCONF
-environment variable.
-.IP -a
-In addition to the baz segments, also parse the
-blurfl headers.
-.IP -r
-Recursive mode. Operates as fast as lightning
-at the expense of a megabyte of virtual memory.
-.SH FILES
-.I /etc/foo.conf
-.RS
-The system wide configuration file. See
-.BR foo (5)
-for further details.
-.RE
-.I ~/.foorc
-.RS
-Per user configuration file. See
-.BR foo (5)
-for further details.
-.SH ENVIRONMENT
-.IP FOOCONF
-If non-null the full pathname for an alternate system wide
-.IR foo.conf .
-Overridden by the
-.B -c
-option.
-.SH DIAGNOSTICS
-The following diagnostics may be issued on stderr:
- 
-Bad magic number.
-.RS
-The input file does not look like an archive file.
-.RE
-Old style baz segments.
-.RS
-.B foo
-can only handle new style baz segments. COBOL
-object libraries are not supported in this version.
-.SH BUGS
-The command name should have been chosen more carefully
-to reflect its purpose.
+.\"[-r|--release release] [--section section] [-e|--email mail] [--depends] plugin-dir|plugin.tar.gz
+
+.IP "-r debian-release, --release debian-release"
+Set the Debian release to
+.B debian-release
+when generating the Debian tree. Default is the
+.I unstable
+release.
+
+.IP "--dest destination-directory"
+Place where
+.B dh-make-gosa
+will place its working data while generating the source directory.
+Defaults to the current directory.
+
+.IP "--section debian-section"
+Set the Debian section to
+.B debian-section
+when generating the Debian tree.  Defaults to the the
+.I web
+section.
+
+.IP "--depends package,package,..."
+Add additional dependencies to the Debian tree which did not get
+listed in the
+.I plugin.dsc
+file. This is a comma seperated list of Debian package names.
+
+.IP "-e mail, --email mail"
+Overrides the Debian packager defined inside the
+.I plugin.dsc
+file by the one specified by
+.B mail.
+
+.SH Example usage
+
+.nf
+# Check out a plugin from SVN
+svn co https://oss.gonicus.de/repositories/gosa/trunk/gosa-plugins/samba /tmp/samba
+
+# Debianize the tree
+cd /tmp
+dh-make-gosa --email cajus@debian.org --release etch --section web samba
+
+# Build debian package
+cd samba
+dpkg-buildpackage -uc -us -rfakeroot
+.fi
+
+To build everything from the subversion repository which is GOsa related, please
+take a look at the contributed
+.B make-gosa-package
+script.
+
 .SH AUTHOR
-Jens Schweikhardt <howto at schweikhardt dot net>
-.SH "SEE ALSO"
-.BR bar (1),
-.BR foo (5),
-.BR xyzzy (1)
+Cajus Pollmeier <cajus@debian.org>
+
+.SH 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
+
+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.
+