+ add manpage
This commit is contained in:
Shell.Xu
parent
48780fed24
commit
8d74b6276e
6 changed files with 62 additions and 504 deletions
2
debian/changelog
vendored
2
debian/changelog
vendored
|
|
@ -1,4 +1,4 @@
|
||||||
python-shadowsocks (2.1.0-1) unstable; urgency=low
|
shadowsocks (2.1.0-1) unstable; urgency=low
|
||||||
|
|
||||||
* Initial release (Closes: 758900)
|
* Initial release (Closes: 758900)
|
||||||
|
|
||||||
|
|
|
||||||
4
debian/control
vendored
4
debian/control
vendored
|
|
@ -1,4 +1,4 @@
|
||||||
Source: python-shadowsocks
|
Source: shadowsocks
|
||||||
Section: python
|
Section: python
|
||||||
Priority: extra
|
Priority: extra
|
||||||
Maintainer: Shell.Xu <shell909090@gmail.com>
|
Maintainer: Shell.Xu <shell909090@gmail.com>
|
||||||
|
|
@ -8,7 +8,7 @@ Homepage: https://github.com/clowwindy/shadowsocks
|
||||||
#Vcs-Git: git://git.debian.org/collab-maint/shadowsocks.git
|
#Vcs-Git: git://git.debian.org/collab-maint/shadowsocks.git
|
||||||
#Vcs-Browser: http://git.debian.org/?p=collab-maint/shadowsocks.git;a=summary
|
#Vcs-Browser: http://git.debian.org/?p=collab-maint/shadowsocks.git;a=summary
|
||||||
|
|
||||||
Package: python-shadowsocks
|
Package: shadowsocks
|
||||||
Architecture: all
|
Architecture: all
|
||||||
Depends: ${shlibs:Depends}, ${misc:Depends}, python, python-m2crypto
|
Depends: ${shlibs:Depends}, ${misc:Depends}, python, python-m2crypto
|
||||||
Description: Fast tunnel proxy that helps you bypass firewalls
|
Description: Fast tunnel proxy that helps you bypass firewalls
|
||||||
|
|
|
||||||
59
debian/manpage.1
vendored
Normal file
59
debian/manpage.1
vendored
Normal file
|
|
@ -0,0 +1,59 @@
|
||||||
|
.\" Hey, EMACS: -*- nroff -*-
|
||||||
|
.\" (C) Copyright 2014 Shell.Xu <shell909090@gmail.com>,
|
||||||
|
.\"
|
||||||
|
.TH SHADOWSOCKS SECTION "August 23, 2014"
|
||||||
|
.SH NAME
|
||||||
|
shadowsocks \- Fast tunnel proxy that helps you bypass firewalls
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B ssserver
|
||||||
|
.RI [ options ]
|
||||||
|
.br
|
||||||
|
.B sslocal
|
||||||
|
.RI [ options ]
|
||||||
|
.SH DESCRIPTION
|
||||||
|
shadowsocks is a tunnel proxy helps you bypass firewall.
|
||||||
|
.B ssserver
|
||||||
|
is the server part, and
|
||||||
|
.B sslocal
|
||||||
|
is the local part.
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
.B \-h, \-\-help
|
||||||
|
Show this help message and exit.
|
||||||
|
.TP
|
||||||
|
.B \-s SERVER_ADDR
|
||||||
|
Server address, default: 0.0.0.0.
|
||||||
|
.TP
|
||||||
|
.B \-p SERVER_PORT
|
||||||
|
Server port, default: 8388.
|
||||||
|
.TP
|
||||||
|
.B \-k PASSWORD
|
||||||
|
Password.
|
||||||
|
.TP
|
||||||
|
.B \-m METHOD
|
||||||
|
Encryption method, default: aes-256-cfb.
|
||||||
|
.TP
|
||||||
|
.B \-t TIMEOUT
|
||||||
|
Timeout in seconds, default: 300.
|
||||||
|
.TP
|
||||||
|
.B \-c CONFIG
|
||||||
|
Path to config file.
|
||||||
|
.TP
|
||||||
|
.B \-\-fast-open
|
||||||
|
Use TCP_FASTOPEN, requires Linux 3.7+.
|
||||||
|
.TP
|
||||||
|
.B \-\-workers WORKERS
|
||||||
|
Number of workers, available on Unix/Linux.
|
||||||
|
.TP
|
||||||
|
.B \-v, \-vv
|
||||||
|
Verbose mode.
|
||||||
|
.TP
|
||||||
|
.B \-q, \-qq
|
||||||
|
Quiet mode, only show warnings/errors.
|
||||||
|
.SH SEE ALSO
|
||||||
|
.br
|
||||||
|
The programs are documented fully by
|
||||||
|
.IR "Shell Xu <shell909090@gmail.com>"
|
||||||
|
and
|
||||||
|
.IR "Clowwindy <clowwindy42@gmail.com>",
|
||||||
|
available via the Info system.
|
||||||
56
debian/manpage.1.ex
vendored
56
debian/manpage.1.ex
vendored
|
|
@ -1,56 +0,0 @@
|
||||||
.\" Hey, EMACS: -*- nroff -*-
|
|
||||||
.\" (C) Copyright 2014 Shell.Xu <shell909090@gmail.com>,
|
|
||||||
.\"
|
|
||||||
.\" First parameter, NAME, should be all caps
|
|
||||||
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
|
|
||||||
.\" other parameters are allowed: see man(7), man(1)
|
|
||||||
.TH SHADOWSOCKS SECTION "August 23, 2014"
|
|
||||||
.\" Please adjust this date whenever revising the manpage.
|
|
||||||
.\"
|
|
||||||
.\" Some roff macros, for reference:
|
|
||||||
.\" .nh disable hyphenation
|
|
||||||
.\" .hy enable hyphenation
|
|
||||||
.\" .ad l left justify
|
|
||||||
.\" .ad b justify to both left and right margins
|
|
||||||
.\" .nf disable filling
|
|
||||||
.\" .fi enable filling
|
|
||||||
.\" .br insert line break
|
|
||||||
.\" .sp <n> insert n+1 empty lines
|
|
||||||
.\" for manpage-specific macros, see man(7)
|
|
||||||
.SH NAME
|
|
||||||
shadowsocks \- program to do something
|
|
||||||
.SH SYNOPSIS
|
|
||||||
.B shadowsocks
|
|
||||||
.RI [ options ] " files" ...
|
|
||||||
.br
|
|
||||||
.B bar
|
|
||||||
.RI [ options ] " files" ...
|
|
||||||
.SH DESCRIPTION
|
|
||||||
This manual page documents briefly the
|
|
||||||
.B shadowsocks
|
|
||||||
and
|
|
||||||
.B bar
|
|
||||||
commands.
|
|
||||||
.PP
|
|
||||||
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
|
|
||||||
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
|
|
||||||
.\" respectively.
|
|
||||||
\fBshadowsocks\fP is a program that...
|
|
||||||
.SH OPTIONS
|
|
||||||
These programs follow the usual GNU command line syntax, with long
|
|
||||||
options starting with two dashes (`-').
|
|
||||||
A summary of options is included below.
|
|
||||||
For a complete description, see the Info files.
|
|
||||||
.TP
|
|
||||||
.B \-h, \-\-help
|
|
||||||
Show summary of options.
|
|
||||||
.TP
|
|
||||||
.B \-v, \-\-version
|
|
||||||
Show version of program.
|
|
||||||
.SH SEE ALSO
|
|
||||||
.BR bar (1),
|
|
||||||
.BR baz (1).
|
|
||||||
.br
|
|
||||||
The programs are documented fully by
|
|
||||||
.IR "The Rise and Fall of a Fooish Bar" ,
|
|
||||||
available via the Info system.
|
|
||||||
154
debian/manpage.sgml.ex
vendored
154
debian/manpage.sgml.ex
vendored
|
|
@ -1,154 +0,0 @@
|
||||||
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
|
|
||||||
|
|
||||||
<!-- Process this file with docbook-to-man to generate an nroff manual
|
|
||||||
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
|
|
||||||
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
|
|
||||||
less'. A typical entry in a Makefile or Makefile.am is:
|
|
||||||
|
|
||||||
manpage.1: manpage.sgml
|
|
||||||
docbook-to-man $< > $@
|
|
||||||
|
|
||||||
|
|
||||||
The docbook-to-man binary is found in the docbook-to-man package.
|
|
||||||
Please remember that if you create the nroff version in one of the
|
|
||||||
debian/rules file targets (such as build), you will need to include
|
|
||||||
docbook-to-man in your Build-Depends control field.
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
|
|
||||||
<!ENTITY dhfirstname "<firstname>FIRSTNAME</firstname>">
|
|
||||||
<!ENTITY dhsurname "<surname>SURNAME</surname>">
|
|
||||||
<!-- Please adjust the date whenever revising the manpage. -->
|
|
||||||
<!ENTITY dhdate "<date>August 23, 2014</date>">
|
|
||||||
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
|
|
||||||
allowed: see man(7), man(1). -->
|
|
||||||
<!ENTITY dhsection "<manvolnum>SECTION</manvolnum>">
|
|
||||||
<!ENTITY dhemail "<email>shell909090@gmail.com</email>">
|
|
||||||
<!ENTITY dhusername "Shell.Xu">
|
|
||||||
<!ENTITY dhucpackage "<refentrytitle>SHADOWSOCKS</refentrytitle>">
|
|
||||||
<!ENTITY dhpackage "shadowsocks">
|
|
||||||
|
|
||||||
<!ENTITY debian "<productname>Debian</productname>">
|
|
||||||
<!ENTITY gnu "<acronym>GNU</acronym>">
|
|
||||||
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
|
|
||||||
]>
|
|
||||||
|
|
||||||
<refentry>
|
|
||||||
<refentryinfo>
|
|
||||||
<address>
|
|
||||||
&dhemail;
|
|
||||||
</address>
|
|
||||||
<author>
|
|
||||||
&dhfirstname;
|
|
||||||
&dhsurname;
|
|
||||||
</author>
|
|
||||||
<copyright>
|
|
||||||
<year>2003</year>
|
|
||||||
<holder>&dhusername;</holder>
|
|
||||||
</copyright>
|
|
||||||
&dhdate;
|
|
||||||
</refentryinfo>
|
|
||||||
<refmeta>
|
|
||||||
&dhucpackage;
|
|
||||||
|
|
||||||
&dhsection;
|
|
||||||
</refmeta>
|
|
||||||
<refnamediv>
|
|
||||||
<refname>&dhpackage;</refname>
|
|
||||||
|
|
||||||
<refpurpose>program to do something</refpurpose>
|
|
||||||
</refnamediv>
|
|
||||||
<refsynopsisdiv>
|
|
||||||
<cmdsynopsis>
|
|
||||||
<command>&dhpackage;</command>
|
|
||||||
|
|
||||||
<arg><option>-e <replaceable>this</replaceable></option></arg>
|
|
||||||
|
|
||||||
<arg><option>--example <replaceable>that</replaceable></option></arg>
|
|
||||||
</cmdsynopsis>
|
|
||||||
</refsynopsisdiv>
|
|
||||||
<refsect1>
|
|
||||||
<title>DESCRIPTION</title>
|
|
||||||
|
|
||||||
<para>This manual page documents briefly the
|
|
||||||
<command>&dhpackage;</command> and <command>bar</command>
|
|
||||||
commands.</para>
|
|
||||||
|
|
||||||
<para>This manual page was written for the &debian; distribution
|
|
||||||
because the original program does not have a manual page.
|
|
||||||
Instead, it has documentation in the &gnu;
|
|
||||||
<application>Info</application> format; see below.</para>
|
|
||||||
|
|
||||||
<para><command>&dhpackage;</command> is a program that...</para>
|
|
||||||
|
|
||||||
</refsect1>
|
|
||||||
<refsect1>
|
|
||||||
<title>OPTIONS</title>
|
|
||||||
|
|
||||||
<para>These programs follow the usual &gnu; command line syntax,
|
|
||||||
with long options starting with two dashes (`-'). A summary of
|
|
||||||
options is included below. For a complete description, see the
|
|
||||||
<application>Info</application> files.</para>
|
|
||||||
|
|
||||||
<variablelist>
|
|
||||||
<varlistentry>
|
|
||||||
<term><option>-h</option>
|
|
||||||
<option>--help</option>
|
|
||||||
</term>
|
|
||||||
<listitem>
|
|
||||||
<para>Show summary of options.</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><option>-v</option>
|
|
||||||
<option>--version</option>
|
|
||||||
</term>
|
|
||||||
<listitem>
|
|
||||||
<para>Show version of program.</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
</variablelist>
|
|
||||||
</refsect1>
|
|
||||||
<refsect1>
|
|
||||||
<title>SEE ALSO</title>
|
|
||||||
|
|
||||||
<para>bar (1), baz (1).</para>
|
|
||||||
|
|
||||||
<para>The programs are documented fully by <citetitle>The Rise and
|
|
||||||
Fall of a Fooish Bar</citetitle> available via the
|
|
||||||
<application>Info</application> system.</para>
|
|
||||||
</refsect1>
|
|
||||||
<refsect1>
|
|
||||||
<title>AUTHOR</title>
|
|
||||||
|
|
||||||
<para>This manual page was written by &dhusername; &dhemail; for
|
|
||||||
the &debian; system (and may be used by others). Permission is
|
|
||||||
granted to copy, distribute and/or modify this document under
|
|
||||||
the terms of the &gnu; General Public License, Version 2 any
|
|
||||||
later version published by the Free Software Foundation.
|
|
||||||
</para>
|
|
||||||
<para>
|
|
||||||
On Debian systems, the complete text of the GNU General Public
|
|
||||||
License can be found in /usr/share/common-licenses/GPL.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
</refsect1>
|
|
||||||
</refentry>
|
|
||||||
|
|
||||||
<!-- Keep this comment at the end of the file
|
|
||||||
Local variables:
|
|
||||||
mode: sgml
|
|
||||||
sgml-omittag:t
|
|
||||||
sgml-shorttag:t
|
|
||||||
sgml-minimize-attributes:nil
|
|
||||||
sgml-always-quote-attributes:t
|
|
||||||
sgml-indent-step:2
|
|
||||||
sgml-indent-data:t
|
|
||||||
sgml-parent-document:nil
|
|
||||||
sgml-default-dtd-file:nil
|
|
||||||
sgml-exposed-tags:nil
|
|
||||||
sgml-local-catalogs:nil
|
|
||||||
sgml-local-ecat-files:nil
|
|
||||||
End:
|
|
||||||
-->
|
|
||||||
291
debian/manpage.xml.ex
vendored
291
debian/manpage.xml.ex
vendored
|
|
@ -1,291 +0,0 @@
|
||||||
<?xml version='1.0' encoding='UTF-8'?>
|
|
||||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|
||||||
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
|
||||||
`xsltproc -''-nonet \
|
|
||||||
-''-param man.charmap.use.subset "0" \
|
|
||||||
-''-param make.year.ranges "1" \
|
|
||||||
-''-param make.single.year.ranges "1" \
|
|
||||||
/usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
|
|
||||||
manpage.xml'
|
|
||||||
|
|
||||||
A manual page <package>.<section> will be generated. You may view the
|
|
||||||
manual page with: nroff -man <package>.<section> | less'. A typical entry
|
|
||||||
in a Makefile or Makefile.am is:
|
|
||||||
|
|
||||||
DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/docbook-xsl/manpages/docbook.xsl
|
|
||||||
XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
|
|
||||||
|
|
||||||
manpage.1: manpage.xml
|
|
||||||
$(XP) $(DB2MAN) $<
|
|
||||||
|
|
||||||
The xsltproc binary is found in the xsltproc package. The XSL files are in
|
|
||||||
docbook-xsl. A description of the parameters you can use can be found in the
|
|
||||||
docbook-xsl-doc-* packages. Please remember that if you create the nroff
|
|
||||||
version in one of the debian/rules file targets (such as build), you will need
|
|
||||||
to include xsltproc and docbook-xsl in your Build-Depends control field.
|
|
||||||
Alternatively use the xmlto command/package. That will also automatically
|
|
||||||
pull in xsltproc and docbook-xsl.
|
|
||||||
|
|
||||||
Notes for using docbook2x: docbook2x-man does not automatically create the
|
|
||||||
AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
|
|
||||||
<refsect1> ... </refsect1>.
|
|
||||||
|
|
||||||
To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
|
|
||||||
read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
|
|
||||||
found in the docbook-xsl-doc-html package.
|
|
||||||
|
|
||||||
Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
|
|
||||||
|
|
||||||
General documentation about man-pages and man-page-formatting:
|
|
||||||
man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
|
|
||||||
<!ENTITY dhfirstname "FIRSTNAME">
|
|
||||||
<!ENTITY dhsurname "SURNAME">
|
|
||||||
<!-- dhusername could also be set to "&dhfirstname; &dhsurname;". -->
|
|
||||||
<!ENTITY dhusername "Shell.Xu">
|
|
||||||
<!ENTITY dhemail "shell909090@gmail.com">
|
|
||||||
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
|
|
||||||
allowed: see man(7), man(1) and
|
|
||||||
http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
|
|
||||||
<!ENTITY dhsection "SECTION">
|
|
||||||
<!-- TITLE should be something like "User commands" or similar (see
|
|
||||||
http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
|
|
||||||
<!ENTITY dhtitle "shadowsocks User Manual">
|
|
||||||
<!ENTITY dhucpackage "SHADOWSOCKS">
|
|
||||||
<!ENTITY dhpackage "shadowsocks">
|
|
||||||
]>
|
|
||||||
|
|
||||||
<refentry>
|
|
||||||
<refentryinfo>
|
|
||||||
<title>&dhtitle;</title>
|
|
||||||
<productname>&dhpackage;</productname>
|
|
||||||
<authorgroup>
|
|
||||||
<author>
|
|
||||||
<firstname>&dhfirstname;</firstname>
|
|
||||||
<surname>&dhsurname;</surname>
|
|
||||||
<contrib>Wrote this manpage for the Debian system.</contrib>
|
|
||||||
<address>
|
|
||||||
<email>&dhemail;</email>
|
|
||||||
</address>
|
|
||||||
</author>
|
|
||||||
</authorgroup>
|
|
||||||
<copyright>
|
|
||||||
<year>2007</year>
|
|
||||||
<holder>&dhusername;</holder>
|
|
||||||
</copyright>
|
|
||||||
<legalnotice>
|
|
||||||
<para>This manual page was written for the Debian system
|
|
||||||
(and may be used by others).</para>
|
|
||||||
<para>Permission is granted to copy, distribute and/or modify this
|
|
||||||
document under the terms of the GNU General Public License,
|
|
||||||
Version 2 or (at your option) any later version published by
|
|
||||||
the Free Software Foundation.</para>
|
|
||||||
<para>On Debian systems, the complete text of the GNU General Public
|
|
||||||
License can be found in
|
|
||||||
<filename>/usr/share/common-licenses/GPL</filename>.</para>
|
|
||||||
</legalnotice>
|
|
||||||
</refentryinfo>
|
|
||||||
<refmeta>
|
|
||||||
<refentrytitle>&dhucpackage;</refentrytitle>
|
|
||||||
<manvolnum>&dhsection;</manvolnum>
|
|
||||||
</refmeta>
|
|
||||||
<refnamediv>
|
|
||||||
<refname>&dhpackage;</refname>
|
|
||||||
<refpurpose>program to do something</refpurpose>
|
|
||||||
</refnamediv>
|
|
||||||
<refsynopsisdiv>
|
|
||||||
<cmdsynopsis>
|
|
||||||
<command>&dhpackage;</command>
|
|
||||||
<!-- These are several examples, how syntaxes could look -->
|
|
||||||
<arg choice="plain"><option>-e <replaceable>this</replaceable></option></arg>
|
|
||||||
<arg choice="opt"><option>--example=<parameter>that</parameter></option></arg>
|
|
||||||
<arg choice="opt">
|
|
||||||
<group choice="req">
|
|
||||||
<arg choice="plain"><option>-e</option></arg>
|
|
||||||
<arg choice="plain"><option>--example</option></arg>
|
|
||||||
</group>
|
|
||||||
<replaceable class="option">this</replaceable>
|
|
||||||
</arg>
|
|
||||||
<arg choice="opt">
|
|
||||||
<group choice="req">
|
|
||||||
<arg choice="plain"><option>-e</option></arg>
|
|
||||||
<arg choice="plain"><option>--example</option></arg>
|
|
||||||
</group>
|
|
||||||
<group choice="req">
|
|
||||||
<arg choice="plain"><replaceable>this</replaceable></arg>
|
|
||||||
<arg choice="plain"><replaceable>that</replaceable></arg>
|
|
||||||
</group>
|
|
||||||
</arg>
|
|
||||||
</cmdsynopsis>
|
|
||||||
<cmdsynopsis>
|
|
||||||
<command>&dhpackage;</command>
|
|
||||||
<!-- Normally the help and version options make the programs stop
|
|
||||||
right after outputting the requested information. -->
|
|
||||||
<group choice="opt">
|
|
||||||
<arg choice="plain">
|
|
||||||
<group choice="req">
|
|
||||||
<arg choice="plain"><option>-h</option></arg>
|
|
||||||
<arg choice="plain"><option>--help</option></arg>
|
|
||||||
</group>
|
|
||||||
</arg>
|
|
||||||
<arg choice="plain">
|
|
||||||
<group choice="req">
|
|
||||||
<arg choice="plain"><option>-v</option></arg>
|
|
||||||
<arg choice="plain"><option>--version</option></arg>
|
|
||||||
</group>
|
|
||||||
</arg>
|
|
||||||
</group>
|
|
||||||
</cmdsynopsis>
|
|
||||||
</refsynopsisdiv>
|
|
||||||
<refsect1 id="description">
|
|
||||||
<title>DESCRIPTION</title>
|
|
||||||
<para>This manual page documents briefly the
|
|
||||||
<command>&dhpackage;</command> and <command>bar</command>
|
|
||||||
commands.</para>
|
|
||||||
<para>This manual page was written for the Debian distribution
|
|
||||||
because the original program does not have a manual page.
|
|
||||||
Instead, it has documentation in the GNU <citerefentry>
|
|
||||||
<refentrytitle>info</refentrytitle>
|
|
||||||
<manvolnum>1</manvolnum>
|
|
||||||
</citerefentry> format; see below.</para>
|
|
||||||
<para><command>&dhpackage;</command> is a program that...</para>
|
|
||||||
</refsect1>
|
|
||||||
<refsect1 id="options">
|
|
||||||
<title>OPTIONS</title>
|
|
||||||
<para>The program follows the usual GNU command line syntax,
|
|
||||||
with long options starting with two dashes (`-'). A summary of
|
|
||||||
options is included below. For a complete description, see the
|
|
||||||
<citerefentry>
|
|
||||||
<refentrytitle>info</refentrytitle>
|
|
||||||
<manvolnum>1</manvolnum>
|
|
||||||
</citerefentry> files.</para>
|
|
||||||
<variablelist>
|
|
||||||
<!-- Use the variablelist.term.separator and the
|
|
||||||
variablelist.term.break.after parameters to
|
|
||||||
control the term elements. -->
|
|
||||||
<varlistentry>
|
|
||||||
<term><option>-e <replaceable>this</replaceable></option></term>
|
|
||||||
<term><option>--example=<replaceable>that</replaceable></option></term>
|
|
||||||
<listitem>
|
|
||||||
<para>Does this and that.</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><option>-h</option></term>
|
|
||||||
<term><option>--help</option></term>
|
|
||||||
<listitem>
|
|
||||||
<para>Show summary of options.</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><option>-v</option></term>
|
|
||||||
<term><option>--version</option></term>
|
|
||||||
<listitem>
|
|
||||||
<para>Show version of program.</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
</variablelist>
|
|
||||||
</refsect1>
|
|
||||||
<refsect1 id="files">
|
|
||||||
<title>FILES</title>
|
|
||||||
<variablelist>
|
|
||||||
<varlistentry>
|
|
||||||
<term><filename>/etc/foo.conf</filename></term>
|
|
||||||
<listitem>
|
|
||||||
<para>The system-wide configuration file to control the
|
|
||||||
behaviour of <application>&dhpackage;</application>. See
|
|
||||||
<citerefentry>
|
|
||||||
<refentrytitle>foo.conf</refentrytitle>
|
|
||||||
<manvolnum>5</manvolnum>
|
|
||||||
</citerefentry> for further details.</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term><filename>${HOME}/.foo.conf</filename></term>
|
|
||||||
<listitem>
|
|
||||||
<para>The per-user configuration file to control the
|
|
||||||
behaviour of <application>&dhpackage;</application>. See
|
|
||||||
<citerefentry>
|
|
||||||
<refentrytitle>foo.conf</refentrytitle>
|
|
||||||
<manvolnum>5</manvolnum>
|
|
||||||
</citerefentry> for further details.</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
</variablelist>
|
|
||||||
</refsect1>
|
|
||||||
<refsect1 id="environment">
|
|
||||||
<title>ENVIRONMENT</title>
|
|
||||||
<variablelist>
|
|
||||||
<varlistentry>
|
|
||||||
<term><envar>FOO_CONF</envar></term>
|
|
||||||
<listitem>
|
|
||||||
<para>If used, the defined file is used as configuration
|
|
||||||
file (see also <xref linkend="files"/>).</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
</variablelist>
|
|
||||||
</refsect1>
|
|
||||||
<refsect1 id="diagnostics">
|
|
||||||
<title>DIAGNOSTICS</title>
|
|
||||||
<para>The following diagnostics may be issued
|
|
||||||
on <filename class="devicefile">stderr</filename>:</para>
|
|
||||||
<variablelist>
|
|
||||||
<varlistentry>
|
|
||||||
<term><errortext>Bad configuration file. Exiting.</errortext></term>
|
|
||||||
<listitem>
|
|
||||||
<para>The configuration file seems to contain a broken configuration
|
|
||||||
line. Use the <option>--verbose</option> option, to get more info.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
</variablelist>
|
|
||||||
<para><command>&dhpackage;</command> provides some return codes, that can
|
|
||||||
be used in scripts:</para>
|
|
||||||
<segmentedlist>
|
|
||||||
<segtitle>Code</segtitle>
|
|
||||||
<segtitle>Diagnostic</segtitle>
|
|
||||||
<seglistitem>
|
|
||||||
<seg><errorcode>0</errorcode></seg>
|
|
||||||
<seg>Program exited successfully.</seg>
|
|
||||||
</seglistitem>
|
|
||||||
<seglistitem>
|
|
||||||
<seg><errorcode>1</errorcode></seg>
|
|
||||||
<seg>The configuration file seems to be broken.</seg>
|
|
||||||
</seglistitem>
|
|
||||||
</segmentedlist>
|
|
||||||
</refsect1>
|
|
||||||
<refsect1 id="bugs">
|
|
||||||
<!-- Or use this section to tell about upstream BTS. -->
|
|
||||||
<title>BUGS</title>
|
|
||||||
<para>The program is currently limited to only work
|
|
||||||
with the <package>foobar</package> library.</para>
|
|
||||||
<para>The upstreams <acronym>BTS</acronym> can be found
|
|
||||||
at <ulink url="http://bugzilla.foo.tld"/>.</para>
|
|
||||||
</refsect1>
|
|
||||||
<refsect1 id="see_also">
|
|
||||||
<title>SEE ALSO</title>
|
|
||||||
<!-- In alpabetical order. -->
|
|
||||||
<para><citerefentry>
|
|
||||||
<refentrytitle>bar</refentrytitle>
|
|
||||||
<manvolnum>1</manvolnum>
|
|
||||||
</citerefentry>, <citerefentry>
|
|
||||||
<refentrytitle>baz</refentrytitle>
|
|
||||||
<manvolnum>1</manvolnum>
|
|
||||||
</citerefentry>, <citerefentry>
|
|
||||||
<refentrytitle>foo.conf</refentrytitle>
|
|
||||||
<manvolnum>5</manvolnum>
|
|
||||||
</citerefentry></para>
|
|
||||||
<para>The programs are documented fully by <citetitle>The Rise and
|
|
||||||
Fall of a Fooish Bar</citetitle> available via the <citerefentry>
|
|
||||||
<refentrytitle>info</refentrytitle>
|
|
||||||
<manvolnum>1</manvolnum>
|
|
||||||
</citerefentry> system.</para>
|
|
||||||
</refsect1>
|
|
||||||
</refentry>
|
|
||||||
|
|
||||||
Loading…
Add table
Reference in a new issue