From ff69122b2d11b1e8ea85a309efae85ea5e48e927 Mon Sep 17 00:00:00 2001 From: cajus Date: Mon, 28 Jul 2008 10:30:05 +0000 Subject: [PATCH] Updated man pages git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@12071 594d385d-05f5-0310-b6e9-bd551577e9d8 --- gosa-core/contrib/gosa.conf.5 | 2 +- gosa-core/dh-make-gosa | 2 +- gosa-core/dh-make-gosa.1 | 133 +++++++++++++++++----------------- 3 files changed, 67 insertions(+), 70 deletions(-) diff --git a/gosa-core/contrib/gosa.conf.5 b/gosa-core/contrib/gosa.conf.5 index 1c487753f..deb9d8c7c 100644 --- a/gosa-core/contrib/gosa.conf.5 +++ b/gosa-core/contrib/gosa.conf.5 @@ -1,4 +1,4 @@ -.TH gosa.conf 5 +.TH gosa.conf 5 "2008-04-07" "GOsa v2.6" "Debian" .SH NAME gosa.conf - GOsa configuration file .SH DESCRIPTION diff --git a/gosa-core/dh-make-gosa b/gosa-core/dh-make-gosa index cdb53def3..f3813ae90 100755 --- a/gosa-core/dh-make-gosa +++ b/gosa-core/dh-make-gosa @@ -19,7 +19,7 @@ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA usage() { - echo "Usage: ${0##*/} [--download] [--section section name] [-b|--branch branch] [-e|--email mail] [--depends] plugin-dir|plugin.tar.gz" >&2 + echo "Usage: ${0##*/} [--section section name] [-b|--branch branch] [-e|--email mail] [--depends] plugin-dir|plugin.tar.gz" >&2 exit 1 } diff --git a/gosa-core/dh-make-gosa.1 b/gosa-core/dh-make-gosa.1 index 5cffd426a..885ac8b95 100644 --- a/gosa-core/dh-make-gosa.1 +++ b/gosa-core/dh-make-gosa.1 @@ -1,76 +1,73 @@ -.\" 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 -.SH "SEE ALSO" -.BR bar (1), -.BR foo (5), -.BR xyzzy (1) +Cajus Pollmeier + -- 2.30.2