aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar YAEGASHI Takeshi <yaegashi@debian.org>2014-02-15 19:14:40 (JST)
committerGravatar YAEGASHI Takeshi <yaegashi@debian.org>2014-02-17 05:37:22 (JST)
commit7489123c46a67ef328aead1b1eca0239b3d98eae (patch)
tree0ed837227f4d808bdc946cd6c917fdf86ee7aa28
parent6952f164c10689e3c112dbef85e461a6246654be (diff)
downloadcgit-7489123c46a67ef328aead1b1eca0239b3d98eae.zip
cgit-7489123c46a67ef328aead1b1eca0239b3d98eae.tar.gz
Debianized by dh_make -s -p cgit_0.10
-rw-r--r--debian/README.Debian6
-rw-r--r--debian/README.source10
-rw-r--r--debian/cgit.cron.d.ex4
-rw-r--r--debian/cgit.default.ex10
-rw-r--r--debian/cgit.doc-base.EX20
-rw-r--r--debian/changelog5
-rw-r--r--debian/compat1
-rw-r--r--debian/control24
-rw-r--r--debian/copyright38
-rw-r--r--debian/docs3
-rw-r--r--debian/init.d.ex166
-rw-r--r--debian/manpage.1.ex56
-rw-r--r--debian/manpage.sgml.ex154
-rw-r--r--debian/manpage.xml.ex291
-rw-r--r--debian/menu.ex2
-rw-r--r--debian/postinst.ex39
-rw-r--r--debian/postrm.ex37
-rw-r--r--debian/preinst.ex35
-rw-r--r--debian/prerm.ex38
-rwxr-xr-xdebian/rules23
-rw-r--r--debian/source/format1
-rw-r--r--debian/watch.ex23
22 files changed, 986 insertions, 0 deletions
diff --git a/debian/README.Debian b/debian/README.Debian
new file mode 100644
index 0000000..c172530
--- /dev/null
+++ b/debian/README.Debian
@@ -0,0 +1,6 @@
1cgit for Debian
2---------------
3
4<possible notes regarding this package - if none, delete this file>
5
6 -- YAEGASHI Takeshi <yaegashi@debian.org> Fri, 14 Feb 2014 20:57:51 +0900
diff --git a/debian/README.source b/debian/README.source
new file mode 100644
index 0000000..1566c44
--- /dev/null
+++ b/debian/README.source
@@ -0,0 +1,10 @@
1cgit for Debian
2---------------
3
4<this file describes information about the source package, see Debian policy
5manual section 4.14. You WILL either need to modify or delete this file>
6
7
8
9 -- YAEGASHI Takeshi <yaegashi@debian.org> Fri, 14 Feb 2014 20:57:51 +0900
10
diff --git a/debian/cgit.cron.d.ex b/debian/cgit.cron.d.ex
new file mode 100644
index 0000000..85a9e7b
--- /dev/null
+++ b/debian/cgit.cron.d.ex
@@ -0,0 +1,4 @@
1#
2# Regular cron jobs for the cgit package
3#
40 4 * * * root [ -x /usr/bin/cgit_maintenance ] && /usr/bin/cgit_maintenance
diff --git a/debian/cgit.default.ex b/debian/cgit.default.ex
new file mode 100644
index 0000000..bd6b10c
--- /dev/null
+++ b/debian/cgit.default.ex
@@ -0,0 +1,10 @@
1# Defaults for cgit initscript
2# sourced by /etc/init.d/cgit
3# installed at /etc/default/cgit by the maintainer scripts
4
5#
6# This is a POSIX shell fragment
7#
8
9# Additional options that are passed to the Daemon.
10DAEMON_OPTS=""
diff --git a/debian/cgit.doc-base.EX b/debian/cgit.doc-base.EX
new file mode 100644
index 0000000..ee68aec
--- /dev/null
+++ b/debian/cgit.doc-base.EX
@@ -0,0 +1,20 @@
1Document: cgit
2Title: Debian cgit Manual
3Author: <insert document author here>
4Abstract: This manual describes what cgit is
5 and how it can be used to
6 manage online manuals on Debian systems.
7Section: unknown
8
9Format: debiandoc-sgml
10Files: /usr/share/doc/cgit/cgit.sgml.gz
11
12Format: postscript
13Files: /usr/share/doc/cgit/cgit.ps.gz
14
15Format: text
16Files: /usr/share/doc/cgit/cgit.text.gz
17
18Format: HTML
19Index: /usr/share/doc/cgit/html/index.html
20Files: /usr/share/doc/cgit/html/*.html
diff --git a/debian/changelog b/debian/changelog
new file mode 100644
index 0000000..086182f
--- /dev/null
+++ b/debian/changelog
@@ -0,0 +1,5 @@
1cgit (0.10-1) unstable; urgency=low
2
3 * Initial release (Closes: #nnnn) <nnnn is the bug number of your ITP>
4
5 -- YAEGASHI Takeshi <yaegashi@debian.org> Fri, 14 Feb 2014 20:57:51 +0900
diff --git a/debian/compat b/debian/compat
new file mode 100644
index 0000000..ec63514
--- /dev/null
+++ b/debian/compat
@@ -0,0 +1 @@
9
diff --git a/debian/control b/debian/control
new file mode 100644
index 0000000..a79f032
--- /dev/null
+++ b/debian/control
@@ -0,0 +1,24 @@
1Source: cgit
2Section: unknown
3Priority: optional
4Maintainer: YAEGASHI Takeshi <yaegashi@debian.org>
5Build-Depends: debhelper (>= 8.0.0),
6 pkg-config,
7 libssl-dev,
8 libluajit-5.1-dev,
9 curl,
10 ca-certificates,
11 asciidoc,
12 libxml2-utils,
13 xsltproc,
14 dblatex,
15Standards-Version: 3.9.4
16Homepage: http://git.zx2c4.com/cgit/about/
17Vcs-Git: http://git.zx2c4.com/cgit
18Vcs-Browser: http://git.zx2c4.com/cgit
19
20Package: cgit
21Architecture: any
22Depends: ${shlibs:Depends}, ${misc:Depends}
23Description: A hyperfast web frontend for git repositories written in C
24 Web interface (cgi) for Git repositories, written in C.
diff --git a/debian/copyright b/debian/copyright
new file mode 100644
index 0000000..748e9bc
--- /dev/null
+++ b/debian/copyright
@@ -0,0 +1,38 @@
1Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2Upstream-Name: cgit
3Source: <url://example.com>
4
5Files: *
6Copyright: <years> <put author's name and email here>
7 <years> <likewise for another author>
8License: <special license>
9 <Put the license of the package here indented by 1 space>
10 <This follows the format of Description: lines in control file>
11 .
12 <Including paragraphs>
13
14# If you want to use GPL v2 or later for the /debian/* files use
15# the following clauses, or change it to suit. Delete these two lines
16Files: debian/*
17Copyright: 2014 YAEGASHI Takeshi <yaegashi@debian.org>
18License: GPL-2+
19 This package is free software; you can redistribute it and/or modify
20 it under the terms of the GNU General Public License as published by
21 the Free Software Foundation; either version 2 of the License, or
22 (at your option) any later version.
23 .
24 This package is distributed in the hope that it will be useful,
25 but WITHOUT ANY WARRANTY; without even the implied warranty of
26 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 GNU General Public License for more details.
28 .
29 You should have received a copy of the GNU General Public License
30 along with this program. If not, see <http://www.gnu.org/licenses/>
31 .
32 On Debian systems, the complete text of the GNU General
33 Public License version 2 can be found in "/usr/share/common-licenses/GPL-2".
34
35# Please also look if there are files or directories which have a
36# different copyright/license attached and list them here.
37# Please avoid to pick license terms that are more restrictive than the
38# packaged work, as it may make Debian's contributions unacceptable upstream.
diff --git a/debian/docs b/debian/docs
new file mode 100644
index 0000000..95c5dc9
--- /dev/null
+++ b/debian/docs
@@ -0,0 +1,3 @@
1README
2cgitrc.5.txt
3robots.txt
diff --git a/debian/init.d.ex b/debian/init.d.ex
new file mode 100644
index 0000000..5bf16a6
--- /dev/null
+++ b/debian/init.d.ex
@@ -0,0 +1,166 @@
1#!/bin/sh
2### BEGIN INIT INFO
3# Provides: cgit
4# Required-Start: $local_fs $network $remote_fs $syslog
5# Required-Stop: $local_fs $network $remote_fs $syslog
6# Default-Start: 2 3 4 5
7# Default-Stop: 0 1 6
8# Short-Description: <Enter a short description of the software>
9# Description: <Enter a long description of the software>
10# <...>
11# <...>
12### END INIT INFO
13
14# Author: YAEGASHI Takeshi <yaegashi@debian.org>
15
16# Do NOT "set -e"
17
18# PATH should only include /usr/* if it runs after the mountnfs.sh script
19PATH=/sbin:/usr/sbin:/bin:/usr/bin
20DESC="cgit"
21NAME=cgit
22DAEMON=/usr/sbin/cgit
23DAEMON_ARGS=""
24PIDFILE=/var/run/$NAME.pid
25SCRIPTNAME=/etc/init.d/$NAME
26
27# Exit if the package is not installed
28[ -x "$DAEMON" ] || exit 0
29
30# Read configuration variable file if it is present
31[ -r /etc/default/$NAME ] && . /etc/default/$NAME
32
33# Load the VERBOSE setting and other rcS variables
34. /lib/init/vars.sh
35
36# Define LSB log_* functions.
37# Depend on lsb-base (>= 3.2-14) to ensure that this file is present
38# and status_of_proc is working.
39. /lib/lsb/init-functions
40
41#
42# Function that starts the daemon/service
43#
44do_start()
45{
46 # Return
47 # 0 if daemon has been started
48 # 1 if daemon was already running
49 # 2 if daemon could not be started
50 start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
51 || return 1
52 start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
53 $DAEMON_ARGS \
54 || return 2
55 # The above code will not work for interpreted scripts, use the next
56 # six lines below instead (Ref: #643337, start-stop-daemon(8) )
57 #start-stop-daemon --start --quiet --pidfile $PIDFILE --startas $DAEMON \
58 # --name $NAME --test > /dev/null \
59 # || return 1
60 #start-stop-daemon --start --quiet --pidfile $PIDFILE --startas $DAEMON \
61 # --name $NAME -- $DAEMON_ARGS \
62 # || return 2
63
64 # Add code here, if necessary, that waits for the process to be ready
65 # to handle requests from services started subsequently which depend
66 # on this one. As a last resort, sleep for some time.
67}
68
69#
70# Function that stops the daemon/service
71#
72do_stop()
73{
74 # Return
75 # 0 if daemon has been stopped
76 # 1 if daemon was already stopped
77 # 2 if daemon could not be stopped
78 # other if a failure occurred
79 start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
80 RETVAL="$?"
81 [ "$RETVAL" = 2 ] && return 2
82 # Wait for children to finish too if this is a daemon that forks
83 # and if the daemon is only ever run from this initscript.
84 # If the above conditions are not satisfied then add some other code
85 # that waits for the process to drop all resources that could be
86 # needed by services started subsequently. A last resort is to
87 # sleep for some time.
88 start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
89 [ "$?" = 2 ] && return 2
90 # Many daemons don't delete their pidfiles when they exit.
91 rm -f $PIDFILE
92 return "$RETVAL"
93}
94
95#
96# Function that sends a SIGHUP to the daemon/service
97#
98do_reload() {
99 #
100 # If the daemon can reload its configuration without
101 # restarting (for example, when it is sent a SIGHUP),
102 # then implement that here.
103 #
104 start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
105 return 0
106}
107
108case "$1" in
109 start)
110 [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
111 do_start
112 case "$?" in
113 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
114 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
115 esac
116 ;;
117 stop)
118 [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
119 do_stop
120 case "$?" in
121 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
122 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
123 esac
124 ;;
125 status)
126 status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $?
127 ;;
128 #reload|force-reload)
129 #
130 # If do_reload() is not implemented then leave this commented out
131 # and leave 'force-reload' as an alias for 'restart'.
132 #
133 #log_daemon_msg "Reloading $DESC" "$NAME"
134 #do_reload
135 #log_end_msg $?
136 #;;
137 restart|force-reload)
138 #
139 # If the "reload" option is implemented then remove the
140 # 'force-reload' alias
141 #
142 log_daemon_msg "Restarting $DESC" "$NAME"
143 do_stop
144 case "$?" in
145 0|1)
146 do_start
147 case "$?" in
148 0) log_end_msg 0 ;;
149 1) log_end_msg 1 ;; # Old process is still running
150 *) log_end_msg 1 ;; # Failed to start
151 esac
152 ;;
153 *)
154 # Failed to stop
155 log_end_msg 1
156 ;;
157 esac
158 ;;
159 *)
160 #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
161 echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
162 exit 3
163 ;;
164esac
165
166:
diff --git a/debian/manpage.1.ex b/debian/manpage.1.ex
new file mode 100644
index 0000000..2b30bf2
--- /dev/null
+++ b/debian/manpage.1.ex
@@ -0,0 +1,56 @@
1.\" Hey, EMACS: -*- nroff -*-
2.\" (C) Copyright 2014 YAEGASHI Takeshi <yaegashi@debian.org>,
3.\"
4.\" First parameter, NAME, should be all caps
5.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
6.\" other parameters are allowed: see man(7), man(1)
7.TH CGIT SECTION "February 14, 2014"
8.\" Please adjust this date whenever revising the manpage.
9.\"
10.\" Some roff macros, for reference:
11.\" .nh disable hyphenation
12.\" .hy enable hyphenation
13.\" .ad l left justify
14.\" .ad b justify to both left and right margins
15.\" .nf disable filling
16.\" .fi enable filling
17.\" .br insert line break
18.\" .sp <n> insert n+1 empty lines
19.\" for manpage-specific macros, see man(7)
20.SH NAME
21cgit \- program to do something
22.SH SYNOPSIS
23.B cgit
24.RI [ options ] " files" ...
25.br
26.B bar
27.RI [ options ] " files" ...
28.SH DESCRIPTION
29This manual page documents briefly the
30.B cgit
31and
32.B bar
33commands.
34.PP
35.\" TeX users may be more comfortable with the \fB<whatever>\fP and
36.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
37.\" respectively.
38\fBcgit\fP is a program that...
39.SH OPTIONS
40These programs follow the usual GNU command line syntax, with long
41options starting with two dashes (`-').
42A summary of options is included below.
43For a complete description, see the Info files.
44.TP
45.B \-h, \-\-help
46Show summary of options.
47.TP
48.B \-v, \-\-version
49Show version of program.
50.SH SEE ALSO
51.BR bar (1),
52.BR baz (1).
53.br
54The programs are documented fully by
55.IR "The Rise and Fall of a Fooish Bar" ,
56available via the Info system.
diff --git a/debian/manpage.sgml.ex b/debian/manpage.sgml.ex
new file mode 100644
index 0000000..da4bae3
--- /dev/null
+++ b/debian/manpage.sgml.ex
@@ -0,0 +1,154 @@
1<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3<!-- Process this file with docbook-to-man to generate an nroff manual
4 page: `docbook-to-man manpage.sgml > manpage.1'. You may view
5 the manual page with: `docbook-to-man manpage.sgml | nroff -man |
6 less'. A typical entry in a Makefile or Makefile.am is:
7
8manpage.1: manpage.sgml
9 docbook-to-man $< > $@
10
11
12 The docbook-to-man binary is found in the docbook-to-man package.
13 Please remember that if you create the nroff version in one of the
14 debian/rules file targets (such as build), you will need to include
15 docbook-to-man in your Build-Depends control field.
16
17 -->
18
19 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
20 <!ENTITY dhfirstname "<firstname>FIRSTNAME</firstname>">
21 <!ENTITY dhsurname "<surname>SURNAME</surname>">
22 <!-- Please adjust the date whenever revising the manpage. -->
23 <!ENTITY dhdate "<date>February 14, 2014</date>">
24 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
25 allowed: see man(7), man(1). -->
26 <!ENTITY dhsection "<manvolnum>SECTION</manvolnum>">
27 <!ENTITY dhemail "<email>yaegashi@debian.org</email>">
28 <!ENTITY dhusername "YAEGASHI Takeshi">
29 <!ENTITY dhucpackage "<refentrytitle>CGIT</refentrytitle>">
30 <!ENTITY dhpackage "cgit">
31
32 <!ENTITY debian "<productname>Debian</productname>">
33 <!ENTITY gnu "<acronym>GNU</acronym>">
34 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
35]>
36
37<refentry>
38 <refentryinfo>
39 <address>
40 &dhemail;
41 </address>
42 <author>
43 &dhfirstname;
44 &dhsurname;
45 </author>
46 <copyright>
47 <year>2003</year>
48 <holder>&dhusername;</holder>
49 </copyright>
50 &dhdate;
51 </refentryinfo>
52 <refmeta>
53 &dhucpackage;
54
55 &dhsection;
56 </refmeta>
57 <refnamediv>
58 <refname>&dhpackage;</refname>
59
60 <refpurpose>program to do something</refpurpose>
61 </refnamediv>
62 <refsynopsisdiv>
63 <cmdsynopsis>
64 <command>&dhpackage;</command>
65
66 <arg><option>-e <replaceable>this</replaceable></option></arg>
67
68 <arg><option>--example <replaceable>that</replaceable></option></arg>
69 </cmdsynopsis>
70 </refsynopsisdiv>
71 <refsect1>
72 <title>DESCRIPTION</title>
73
74 <para>This manual page documents briefly the
75 <command>&dhpackage;</command> and <command>bar</command>
76 commands.</para>
77
78 <para>This manual page was written for the &debian; distribution
79 because the original program does not have a manual page.
80 Instead, it has documentation in the &gnu;
81 <application>Info</application> format; see below.</para>
82
83 <para><command>&dhpackage;</command> is a program that...</para>
84
85 </refsect1>
86 <refsect1>
87 <title>OPTIONS</title>
88
89 <para>These programs follow the usual &gnu; command line syntax,
90 with long options starting with two dashes (`-'). A summary of
91 options is included below. For a complete description, see the
92 <application>Info</application> files.</para>
93
94 <variablelist>
95 <varlistentry>
96 <term><option>-h</option>
97 <option>--help</option>
98 </term>
99 <listitem>
100 <para>Show summary of options.</para>
101 </listitem>
102 </varlistentry>
103 <varlistentry>
104 <term><option>-v</option>
105 <option>--version</option>
106 </term>
107 <listitem>
108 <para>Show version of program.</para>
109 </listitem>
110 </varlistentry>
111 </variablelist>
112 </refsect1>
113 <refsect1>
114 <title>SEE ALSO</title>
115
116 <para>bar (1), baz (1).</para>
117
118 <para>The programs are documented fully by <citetitle>The Rise and
119 Fall of a Fooish Bar</citetitle> available via the
120 <application>Info</application> system.</para>
121 </refsect1>
122 <refsect1>
123 <title>AUTHOR</title>
124
125 <para>This manual page was written by &dhusername; &dhemail; for
126 the &debian; system (and may be used by others). Permission is
127 granted to copy, distribute and/or modify this document under
128 the terms of the &gnu; General Public License, Version 2 any
129 later version published by the Free Software Foundation.
130 </para>
131 <para>
132 On Debian systems, the complete text of the GNU General Public
133 License can be found in /usr/share/common-licenses/GPL.
134 </para>
135
136 </refsect1>
137</refentry>
138
139<!-- Keep this comment at the end of the file
140Local variables:
141mode: sgml
142sgml-omittag:t
143sgml-shorttag:t
144sgml-minimize-attributes:nil
145sgml-always-quote-attributes:t
146sgml-indent-step:2
147sgml-indent-data:t
148sgml-parent-document:nil
149sgml-default-dtd-file:nil
150sgml-exposed-tags:nil
151sgml-local-catalogs:nil
152sgml-local-ecat-files:nil
153End:
154-->
diff --git a/debian/manpage.xml.ex b/debian/manpage.xml.ex
new file mode 100644
index 0000000..bc254b6
--- /dev/null
+++ b/debian/manpage.xml.ex
@@ -0,0 +1,291 @@
1<?xml version='1.0' encoding='UTF-8'?>
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
5<!--
6
7`xsltproc -''-nonet \
8 -''-param man.charmap.use.subset "0" \
9 -''-param make.year.ranges "1" \
10 -''-param make.single.year.ranges "1" \
11 /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
12 manpage.xml'
13
14A manual page <package>.<section> will be generated. You may view the
15manual page with: nroff -man <package>.<section> | less'. A typical entry
16in a Makefile or Makefile.am is:
17
18DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/docbook-xsl/manpages/docbook.xsl
19XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
20
21manpage.1: manpage.xml
22 $(XP) $(DB2MAN) $<
23
24The xsltproc binary is found in the xsltproc package. The XSL files are in
25docbook-xsl. A description of the parameters you can use can be found in the
26docbook-xsl-doc-* packages. Please remember that if you create the nroff
27version in one of the debian/rules file targets (such as build), you will need
28to include xsltproc and docbook-xsl in your Build-Depends control field.
29Alternatively use the xmlto command/package. That will also automatically
30pull in xsltproc and docbook-xsl.
31
32Notes for using docbook2x: docbook2x-man does not automatically create the
33AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
34<refsect1> ... </refsect1>.
35
36To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
37read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
38found in the docbook-xsl-doc-html package.
39
40Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
41
42General documentation about man-pages and man-page-formatting:
43man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
44
45-->
46
47 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
48 <!ENTITY dhfirstname "FIRSTNAME">
49 <!ENTITY dhsurname "SURNAME">
50 <!-- dhusername could also be set to "&dhfirstname; &dhsurname;". -->
51 <!ENTITY dhusername "YAEGASHI Takeshi">
52 <!ENTITY dhemail "yaegashi@debian.org">
53 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
54 allowed: see man(7), man(1) and
55 http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
56 <!ENTITY dhsection "SECTION">
57 <!-- TITLE should be something like "User commands" or similar (see
58 http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
59 <!ENTITY dhtitle "cgit User Manual">
60 <!ENTITY dhucpackage "CGIT">
61 <!ENTITY dhpackage "cgit">
62]>
63
64<refentry>
65 <refentryinfo>
66 <title>&dhtitle;</title>
67 <productname>&dhpackage;</productname>
68 <authorgroup>
69 <author>
70 <firstname>&dhfirstname;</firstname>
71 <surname>&dhsurname;</surname>
72 <contrib>Wrote this manpage for the Debian system.</contrib>
73 <address>
74 <email>&dhemail;</email>
75 </address>
76 </author>
77 </authorgroup>
78 <copyright>
79 <year>2007</year>
80 <holder>&dhusername;</holder>
81 </copyright>
82 <legalnotice>
83 <para>This manual page was written for the Debian system
84 (and may be used by others).</para>
85 <para>Permission is granted to copy, distribute and/or modify this
86 document under the terms of the GNU General Public License,
87 Version 2 or (at your option) any later version published by
88 the Free Software Foundation.</para>
89 <para>On Debian systems, the complete text of the GNU General Public
90 License can be found in
91 <filename>/usr/share/common-licenses/GPL</filename>.</para>
92 </legalnotice>
93 </refentryinfo>
94 <refmeta>
95 <refentrytitle>&dhucpackage;</refentrytitle>
96 <manvolnum>&dhsection;</manvolnum>
97 </refmeta>
98 <refnamediv>
99 <refname>&dhpackage;</refname>
100 <refpurpose>program to do something</refpurpose>
101 </refnamediv>
102 <refsynopsisdiv>
103 <cmdsynopsis>
104 <command>&dhpackage;</command>
105 <!-- These are several examples, how syntaxes could look -->
106 <arg choice="plain"><option>-e <replaceable>this</replaceable></option></arg>
107 <arg choice="opt"><option>--example=<parameter>that</parameter></option></arg>
108 <arg choice="opt">
109 <group choice="req">
110 <arg choice="plain"><option>-e</option></arg>
111 <arg choice="plain"><option>--example</option></arg>
112 </group>
113 <replaceable class="option">this</replaceable>
114 </arg>
115 <arg choice="opt">
116 <group choice="req">
117 <arg choice="plain"><option>-e</option></arg>
118 <arg choice="plain"><option>--example</option></arg>
119 </group>
120 <group choice="req">
121 <arg choice="plain"><replaceable>this</replaceable></arg>
122 <arg choice="plain"><replaceable>that</replaceable></arg>
123 </group>
124 </arg>
125 </cmdsynopsis>
126 <cmdsynopsis>
127 <command>&dhpackage;</command>
128 <!-- Normally the help and version options make the programs stop
129 right after outputting the requested information. -->
130 <group choice="opt">
131 <arg choice="plain">
132 <group choice="req">
133 <arg choice="plain"><option>-h</option></arg>
134 <arg choice="plain"><option>--help</option></arg>
135 </group>
136 </arg>
137 <arg choice="plain">
138 <group choice="req">
139 <arg choice="plain"><option>-v</option></arg>
140 <arg choice="plain"><option>--version</option></arg>
141 </group>
142 </arg>
143 </group>
144 </cmdsynopsis>
145 </refsynopsisdiv>
146 <refsect1 id="description">
147 <title>DESCRIPTION</title>
148 <para>This manual page documents briefly the
149 <command>&dhpackage;</command> and <command>bar</command>
150 commands.</para>
151 <para>This manual page was written for the Debian distribution
152 because the original program does not have a manual page.
153 Instead, it has documentation in the GNU <citerefentry>
154 <refentrytitle>info</refentrytitle>
155 <manvolnum>1</manvolnum>
156 </citerefentry> format; see below.</para>
157 <para><command>&dhpackage;</command> is a program that...</para>
158 </refsect1>
159 <refsect1 id="options">
160 <title>OPTIONS</title>
161 <para>The program follows the usual GNU command line syntax,
162 with long options starting with two dashes (`-'). A summary of
163 options is included below. For a complete description, see the
164 <citerefentry>
165 <refentrytitle>info</refentrytitle>
166 <manvolnum>1</manvolnum>
167 </citerefentry> files.</para>
168 <variablelist>
169 <!-- Use the variablelist.term.separator and the
170 variablelist.term.break.after parameters to
171 control the term elements. -->
172 <varlistentry>
173 <term><option>-e <replaceable>this</replaceable></option></term>
174 <term><option>--example=<replaceable>that</replaceable></option></term>
175 <listitem>
176 <para>Does this and that.</para>
177 </listitem>
178 </varlistentry>
179 <varlistentry>
180 <term><option>-h</option></term>
181 <term><option>--help</option></term>
182 <listitem>
183 <para>Show summary of options.</para>
184 </listitem>
185 </varlistentry>
186 <varlistentry>
187 <term><option>-v</option></term>
188 <term><option>--version</option></term>
189 <listitem>
190 <para>Show version of program.</para>
191 </listitem>
192 </varlistentry>
193 </variablelist>
194 </refsect1>
195 <refsect1 id="files">
196 <title>FILES</title>
197 <variablelist>
198 <varlistentry>
199 <term><filename>/etc/foo.conf</filename></term>
200 <listitem>
201 <para>The system-wide configuration file to control the
202 behaviour of <application>&dhpackage;</application>. See
203 <citerefentry>
204 <refentrytitle>foo.conf</refentrytitle>
205 <manvolnum>5</manvolnum>
206 </citerefentry> for further details.</para>
207 </listitem>
208 </varlistentry>
209 <varlistentry>
210 <term><filename>${HOME}/.foo.conf</filename></term>
211 <listitem>
212 <para>The per-user configuration file to control the
213 behaviour of <application>&dhpackage;</application>. See
214 <citerefentry>
215 <refentrytitle>foo.conf</refentrytitle>
216 <manvolnum>5</manvolnum>
217 </citerefentry> for further details.</para>
218 </listitem>
219 </varlistentry>
220 </variablelist>
221 </refsect1>
222 <refsect1 id="environment">