Shell.Xu
10 years ago
20 changed files with 936 additions and 0 deletions
@ -0,0 +1,6 @@ |
|||||
|
shadowsocks for Debian |
||||
|
---------------------- |
||||
|
|
||||
|
<possible notes regarding this package - if none, delete this file> |
||||
|
|
||||
|
-- Shell.Xu <shell909090@gmail.com> Sat, 23 Aug 2014 00:56:04 +0800 |
||||
@ -0,0 +1,9 @@ |
|||||
|
shadowsocks for Debian |
||||
|
---------------------- |
||||
|
|
||||
|
<this file describes information about the source package, see Debian policy |
||||
|
manual section 4.14. You WILL either need to modify or delete this file> |
||||
|
|
||||
|
|
||||
|
|
||||
|
|
||||
@ -0,0 +1,5 @@ |
|||||
|
shadowsocks (2.1.0-1) unstable; urgency=low |
||||
|
|
||||
|
* Initial release (Closes: 758900) |
||||
|
|
||||
|
-- Shell.Xu <shell909090@gmail.com> Sat, 23 Aug 2014 00:56:04 +0800 |
||||
@ -0,0 +1 @@ |
|||||
|
8 |
||||
@ -0,0 +1,15 @@ |
|||||
|
Source: python-shadowsocks |
||||
|
Section: python |
||||
|
Priority: extra |
||||
|
Maintainer: Shell.Xu <shell909090@gmail.com> |
||||
|
Build-Depends: debhelper (>= 8), python-setuptools |
||||
|
Standards-Version: 3.9.3 |
||||
|
Homepage: https://github.com/clowwindy/shadowsocks |
||||
|
#Vcs-Git: git://git.debian.org/collab-maint/shadowsocks.git |
||||
|
#Vcs-Browser: http://git.debian.org/?p=collab-maint/shadowsocks.git;a=summary |
||||
|
|
||||
|
Package: python-shadowsocks |
||||
|
Architecture: all |
||||
|
Depends: ${shlibs:Depends}, ${misc:Depends}, python-m2crypto |
||||
|
Description: A fast tunnel proxy that helps you bypass firewalls |
||||
|
A secure socks5 proxy, designed to protect your Internet traffic. |
||||
@ -0,0 +1,45 @@ |
|||||
|
Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ |
||||
|
Upstream-Name: shadowsocks |
||||
|
Source: https://github.com/clowwindy/shadowsocks |
||||
|
|
||||
|
Files: * |
||||
|
Copyright: 2014 clowwindy <clowwindy42@gmail.com> |
||||
|
License: MIT |
||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
|
of this software and associated documentation files (the "Software"), to deal |
||||
|
in the Software without restriction, including without limitation the rights |
||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
|
copies of the Software, and to permit persons to whom the Software is |
||||
|
furnished to do so, subject to the following conditions: |
||||
|
. |
||||
|
The above copyright notice and this permission notice shall be included in |
||||
|
all copies or substantial portions of the Software. |
||||
|
. |
||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||||
|
SOFTWARE. |
||||
|
|
||||
|
Files: debian/* |
||||
|
Copyright: 2014 Shell.Xu <shell909090@gmail.com> |
||||
|
License: MIT |
||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
|
of this software and associated documentation files (the "Software"), to deal |
||||
|
in the Software without restriction, including without limitation the rights |
||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
|
copies of the Software, and to permit persons to whom the Software is |
||||
|
furnished to do so, subject to the following conditions: |
||||
|
. |
||||
|
The above copyright notice and this permission notice shall be included in |
||||
|
all copies or substantial portions of the Software. |
||||
|
. |
||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||||
|
SOFTWARE. |
||||
@ -0,0 +1,2 @@ |
|||||
|
README.md |
||||
|
README.rst |
||||
@ -0,0 +1,154 @@ |
|||||
|
#!/bin/sh |
||||
|
### BEGIN INIT INFO |
||||
|
# Provides: shadowsocks |
||||
|
# Required-Start: $network $local_fs |
||||
|
# Required-Stop: |
||||
|
# Default-Start: 2 3 4 5 |
||||
|
# Default-Stop: 0 1 6 |
||||
|
# Short-Description: <Enter a short description of the software> |
||||
|
# Description: <Enter a long description of the software> |
||||
|
# <...> |
||||
|
# <...> |
||||
|
### END INIT INFO |
||||
|
|
||||
|
# Author: Shell.Xu <shell909090@gmail.com> |
||||
|
|
||||
|
# PATH should only include /usr/* if it runs after the mountnfs.sh script |
||||
|
PATH=/sbin:/usr/sbin:/bin:/usr/bin |
||||
|
DESC=shadowsocks # Introduce a short description here |
||||
|
NAME=shadowsocks # Introduce the short server's name here |
||||
|
DAEMON=/usr/sbin/shadowsocks # Introduce the server's location here |
||||
|
DAEMON_ARGS="" # Arguments to run the daemon with |
||||
|
PIDFILE=/var/run/$NAME.pid |
||||
|
SCRIPTNAME=/etc/init.d/$NAME |
||||
|
|
||||
|
# Exit if the package is not installed |
||||
|
[ -x $DAEMON ] || exit 0 |
||||
|
|
||||
|
# Read configuration variable file if it is present |
||||
|
[ -r /etc/default/$NAME ] && . /etc/default/$NAME |
||||
|
|
||||
|
# Load the VERBOSE setting and other rcS variables |
||||
|
. /lib/init/vars.sh |
||||
|
|
||||
|
# Define LSB log_* functions. |
||||
|
# Depend on lsb-base (>= 3.0-6) to ensure that this file is present. |
||||
|
. /lib/lsb/init-functions |
||||
|
|
||||
|
# |
||||
|
# Function that starts the daemon/service |
||||
|
# |
||||
|
do_start() |
||||
|
{ |
||||
|
# Return |
||||
|
# 0 if daemon has been started |
||||
|
# 1 if daemon was already running |
||||
|
# 2 if daemon could not be started |
||||
|
start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \ |
||||
|
|| return 1 |
||||
|
start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \ |
||||
|
$DAEMON_ARGS \ |
||||
|
|| return 2 |
||||
|
# Add code here, if necessary, that waits for the process to be ready |
||||
|
# to handle requests from services started subsequently which depend |
||||
|
# on this one. As a last resort, sleep for some time. |
||||
|
} |
||||
|
|
||||
|
# |
||||
|
# Function that stops the daemon/service |
||||
|
# |
||||
|
do_stop() |
||||
|
{ |
||||
|
# Return |
||||
|
# 0 if daemon has been stopped |
||||
|
# 1 if daemon was already stopped |
||||
|
# 2 if daemon could not be stopped |
||||
|
# other if a failure occurred |
||||
|
start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME |
||||
|
RETVAL="$?" |
||||
|
[ "$RETVAL" = 2 ] && return 2 |
||||
|
# Wait for children to finish too if this is a daemon that forks |
||||
|
# and if the daemon is only ever run from this initscript. |
||||
|
# If the above conditions are not satisfied then add some other code |
||||
|
# that waits for the process to drop all resources that could be |
||||
|
# needed by services started subsequently. A last resort is to |
||||
|
# sleep for some time. |
||||
|
start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON |
||||
|
[ "$?" = 2 ] && return 2 |
||||
|
# Many daemons don't delete their pidfiles when they exit. |
||||
|
rm -f $PIDFILE |
||||
|
return "$RETVAL" |
||||
|
} |
||||
|
|
||||
|
# |
||||
|
# Function that sends a SIGHUP to the daemon/service |
||||
|
# |
||||
|
do_reload() { |
||||
|
# |
||||
|
# If the daemon can reload its configuration without |
||||
|
# restarting (for example, when it is sent a SIGHUP), |
||||
|
# then implement that here. |
||||
|
# |
||||
|
start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME |
||||
|
return 0 |
||||
|
} |
||||
|
|
||||
|
case "$1" in |
||||
|
start) |
||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC " "$NAME" |
||||
|
do_start |
||||
|
case "$?" in |
||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;; |
||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;; |
||||
|
esac |
||||
|
;; |
||||
|
stop) |
||||
|
[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME" |
||||
|
do_stop |
||||
|
case "$?" in |
||||
|
0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;; |
||||
|
2) [ "$VERBOSE" != no ] && log_end_msg 1 ;; |
||||
|
esac |
||||
|
;; |
||||
|
status) |
||||
|
status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $? |
||||
|
;; |
||||
|
#reload|force-reload) |
||||
|
# |
||||
|
# If do_reload() is not implemented then leave this commented out |
||||
|
# and leave 'force-reload' as an alias for 'restart'. |
||||
|
# |
||||
|
#log_daemon_msg "Reloading $DESC" "$NAME" |
||||
|
#do_reload |
||||
|
#log_end_msg $? |
||||
|
#;; |
||||
|
restart|force-reload) |
||||
|
# |
||||
|
# If the "reload" option is implemented then remove the |
||||
|
# 'force-reload' alias |
||||
|
# |
||||
|
log_daemon_msg "Restarting $DESC" "$NAME" |
||||
|
do_stop |
||||
|
case "$?" in |
||||
|
0|1) |
||||
|
do_start |
||||
|
case "$?" in |
||||
|
0) log_end_msg 0 ;; |
||||
|
1) log_end_msg 1 ;; # Old process is still running |
||||
|
*) log_end_msg 1 ;; # Failed to start |
||||
|
esac |
||||
|
;; |
||||
|
*) |
||||
|
# Failed to stop |
||||
|
log_end_msg 1 |
||||
|
;; |
||||
|
esac |
||||
|
;; |
||||
|
*) |
||||
|
#echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2 |
||||
|
echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2 |
||||
|
exit 3 |
||||
|
;; |
||||
|
esac |
||||
|
|
||||
|
: |
||||
@ -0,0 +1,56 @@ |
|||||
|
.\" 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. |
||||
@ -0,0 +1,154 @@ |
|||||
|
<!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: |
||||
|
--> |
||||
@ -0,0 +1,291 @@ |
|||||
|
<?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> |
||||
|
|
||||
@ -0,0 +1,2 @@ |
|||||
|
?package(shadowsocks):needs="X11|text|vc|wm" section="Applications/see-menu-manual"\ |
||||
|
title="shadowsocks" command="/usr/bin/shadowsocks" |
||||
@ -0,0 +1,39 @@ |
|||||
|
#!/bin/sh |
||||
|
# postinst script for shadowsocks |
||||
|
# |
||||
|
# see: dh_installdeb(1) |
||||
|
|
||||
|
set -e |
||||
|
|
||||
|
# summary of how this script can be called: |
||||
|
# * <postinst> `configure' <most-recently-configured-version> |
||||
|
# * <old-postinst> `abort-upgrade' <new version> |
||||
|
# * <conflictor's-postinst> `abort-remove' `in-favour' <package> |
||||
|
# <new-version> |
||||
|
# * <postinst> `abort-remove' |
||||
|
# * <deconfigured's-postinst> `abort-deconfigure' `in-favour' |
||||
|
# <failed-install-package> <version> `removing' |
||||
|
# <conflicting-package> <version> |
||||
|
# for details, see http://www.debian.org/doc/debian-policy/ or |
||||
|
# the debian-policy package |
||||
|
|
||||
|
|
||||
|
case "$1" in |
||||
|
configure) |
||||
|
;; |
||||
|
|
||||
|
abort-upgrade|abort-remove|abort-deconfigure) |
||||
|
;; |
||||
|
|
||||
|
*) |
||||
|
echo "postinst called with unknown argument \`$1'" >&2 |
||||
|
exit 1 |
||||
|
;; |
||||
|
esac |
||||
|
|
||||
|
# dh_installdeb will replace this with shell code automatically |
||||
|
# generated by other debhelper scripts. |
||||
|
|
||||
|
#DEBHELPER# |
||||
|
|
||||
|
exit 0 |
||||
@ -0,0 +1,37 @@ |
|||||
|
#!/bin/sh |
||||
|
# postrm script for shadowsocks |
||||
|
# |
||||
|
# see: dh_installdeb(1) |
||||
|
|
||||
|
set -e |
||||
|
|
||||
|
# summary of how this script can be called: |
||||
|
# * <postrm> `remove' |
||||
|
# * <postrm> `purge' |
||||
|
# * <old-postrm> `upgrade' <new-version> |
||||
|
# * <new-postrm> `failed-upgrade' <old-version> |
||||
|
# * <new-postrm> `abort-install' |
||||
|
# * <new-postrm> `abort-install' <old-version> |
||||
|
# * <new-postrm> `abort-upgrade' <old-version> |
||||
|
# * <disappearer's-postrm> `disappear' <overwriter> |
||||
|
# <overwriter-version> |
||||
|
# for details, see http://www.debian.org/doc/debian-policy/ or |
||||
|
# the debian-policy package |
||||
|
|
||||
|
|
||||
|
case "$1" in |
||||
|
purge|remove|upgrade|failed-upgrade|abort-install|abort-upgrade|disappear) |
||||
|
;; |
||||
|
|
||||
|
*) |
||||
|
echo "postrm called with unknown argument \`$1'" >&2 |
||||
|
exit 1 |
||||
|
;; |
||||
|
esac |
||||
|
|
||||
|
# dh_installdeb will replace this with shell code automatically |
||||
|
# generated by other debhelper scripts. |
||||
|
|
||||
|
#DEBHELPER# |
||||
|
|
||||
|
exit 0 |
||||
@ -0,0 +1,35 @@ |
|||||
|
#!/bin/sh |
||||
|
# preinst script for shadowsocks |
||||
|
# |
||||
|
# see: dh_installdeb(1) |
||||
|
|
||||
|
set -e |
||||
|
|
||||
|
# summary of how this script can be called: |
||||
|
# * <new-preinst> `install' |
||||
|
# * <new-preinst> `install' <old-version> |
||||
|
# * <new-preinst> `upgrade' <old-version> |
||||
|
# * <old-preinst> `abort-upgrade' <new-version> |
||||
|
# for details, see http://www.debian.org/doc/debian-policy/ or |
||||
|
# the debian-policy package |
||||
|
|
||||
|
|
||||
|
case "$1" in |
||||
|
install|upgrade) |
||||
|
;; |
||||
|
|
||||
|
abort-upgrade) |
||||
|
;; |
||||
|
|
||||
|
*) |
||||
|
echo "preinst called with unknown argument \`$1'" >&2 |
||||
|
exit 1 |
||||
|
;; |
||||
|
esac |
||||
|
|
||||
|
# dh_installdeb will replace this with shell code automatically |
||||
|
# generated by other debhelper scripts. |
||||
|
|
||||
|
#DEBHELPER# |
||||
|
|
||||
|
exit 0 |
||||
@ -0,0 +1,38 @@ |
|||||
|
#!/bin/sh |
||||
|
# prerm script for shadowsocks |
||||
|
# |
||||
|
# see: dh_installdeb(1) |
||||
|
|
||||
|
set -e |
||||
|
|
||||
|
# summary of how this script can be called: |
||||
|
# * <prerm> `remove' |
||||
|
# * <old-prerm> `upgrade' <new-version> |
||||
|
# * <new-prerm> `failed-upgrade' <old-version> |
||||
|
# * <conflictor's-prerm> `remove' `in-favour' <package> <new-version> |
||||
|
# * <deconfigured's-prerm> `deconfigure' `in-favour' |
||||
|
# <package-being-installed> <version> `removing' |
||||
|
# <conflicting-package> <version> |
||||
|
# for details, see http://www.debian.org/doc/debian-policy/ or |
||||
|
# the debian-policy package |
||||
|
|
||||
|
|
||||
|
case "$1" in |
||||
|
remove|upgrade|deconfigure) |
||||
|
;; |
||||
|
|
||||
|
failed-upgrade) |
||||
|
;; |
||||
|
|
||||
|
*) |
||||
|
echo "prerm called with unknown argument \`$1'" >&2 |
||||
|
exit 1 |
||||
|
;; |
||||
|
esac |
||||
|
|
||||
|
# dh_installdeb will replace this with shell code automatically |
||||
|
# generated by other debhelper scripts. |
||||
|
|
||||
|
#DEBHELPER# |
||||
|
|
||||
|
exit 0 |
||||
@ -0,0 +1,13 @@ |
|||||
|
#!/usr/bin/make -f |
||||
|
# -*- makefile -*- |
||||
|
# Sample debian/rules that uses debhelper. |
||||
|
# This file was originally written by Joey Hess and Craig Small. |
||||
|
# As a special exception, when this file is copied by dh-make into a |
||||
|
# dh-make output file, you may use that output file without restriction. |
||||
|
# This special exception was added by Craig Small in version 0.37 of dh-make. |
||||
|
|
||||
|
# Uncomment this to turn on verbose mode. |
||||
|
#export DH_VERBOSE=1 |
||||
|
|
||||
|
%: |
||||
|
dh --with python2 --buildsystem=python_distutils $@ |
||||
@ -0,0 +1,10 @@ |
|||||
|
# Defaults for shadowsocks initscript |
||||
|
# sourced by /etc/init.d/shadowsocks |
||||
|
# installed at /etc/default/shadowsocks by the maintainer scripts |
||||
|
|
||||
|
# |
||||
|
# This is a POSIX shell fragment |
||||
|
# |
||||
|
|
||||
|
# Additional options that are passed to the Daemon. |
||||
|
DAEMON_OPTS="" |
||||
@ -0,0 +1 @@ |
|||||
|
3.0 (quilt) |
||||
@ -0,0 +1,23 @@ |
|||||
|
# Example watch control file for uscan |
||||
|
# Rename this file to "watch" and then you can run the "uscan" command |
||||
|
# to check for upstream updates and more. |
||||
|
# See uscan(1) for format |
||||
|
|
||||
|
# Compulsory line, this is a version 3 file |
||||
|
version=3 |
||||
|
|
||||
|
# Uncomment to examine a Webpage |
||||
|
# <Webpage URL> <string match> |
||||
|
#http://www.example.com/downloads.php shadowsocks-(.*)\.tar\.gz |
||||
|
|
||||
|
# Uncomment to examine a Webserver directory |
||||
|
#http://www.example.com/pub/shadowsocks-(.*)\.tar\.gz |
||||
|
|
||||
|
# Uncommment to examine a FTP server |
||||
|
#ftp://ftp.example.com/pub/shadowsocks-(.*)\.tar\.gz debian uupdate |
||||
|
|
||||
|
# Uncomment to find new files on sourceforge, for devscripts >= 2.9 |
||||
|
# http://sf.net/shadowsocks/shadowsocks-(.*)\.tar\.gz |
||||
|
|
||||
|
# Uncomment to find new files on GooglePages |
||||
|
# http://example.googlepages.com/foo.html shadowsocks-(.*)\.tar\.gz |
||||
Loading…
Reference in new issue