[Pkg-privacy-commits] [onioncat] 129/241: added Man page for debian

Wed Aug 26 16:16:49 UTC 2015

This is an automated email from the git hooks/post-receive script.

intrigeri pushed a commit to branch upstream-master
in repository onioncat.

commit bb58267fa158cd4ca5de362aeda4c65ef11ad8cf
Author: axp <axp at 58e1ccc2-750e-0410-8d0d-f93ca75ab447>
Date:   Fri Feb 20 12:31:31 2009 +0000

    added Man page for debian
    
    git-svn-id: https://www.cypherpunk.at/svn/onioncat/trunk@441 58e1ccc2-750e-0410-8d0d-f93ca75ab447
---
 debian/manpage.1 | 167 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 167 insertions(+)

diff --git a/debian/manpage.1 b/debian/manpage.1
new file mode 100644
index 0000000..ddf1400
--- /dev/null
+++ b/debian/manpage.1
@@ -0,0 +1,167 @@
+.\" Copyright 2008 Bernhard R. Fischer, Daniel Haslinger.
+.\"
+.\" This file is part of OnionCat.
+.\"
+.\" OnionCat is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, version 3 of the License.
+.\"
+.\" OnionCat is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with OnionCat. If not, see <http://www.gnu.org/licenses/>.
+.\"
+.TH OCAT 1 2008-12-07 "ocat" "OnionCat User's Manual"
+.SH NAME
+ocat \- OnionCat creates a transparent IPv6 layer on top of Tor's hidden services.
+.SH SYNOPSIS
+.B ocat
+-i \fIonion_id                      (1st form)\fP
+.br
+.B ocat
+-o \fIIPv6_address                  (2nd form)\fP
+.br
+.B ocat
+[\fIOPTION\fP] \fIonion_id                (3rd form)\fP
+.br
+.B ocat
+-R [\fIOPTION\fP]\fI                      (4th form)\fP
+.br
+.SH DESCRIPTION
+OnionCat creates a transparent IPv6 layer on top of Tor's hidden services. It
+transmits any kind of IP-based data transparently through the Tor network on a
+location hidden basis. You can think of it as a point-to-multipoint VPN
+between hidden services.
+
+OnionCat is a stand-alone application which runs in userland and is a connector
+between Tor and the local OS. Any protocol which is based on IP can be
+transmitted. Of course, UDP and TCP (and probably ICMP) are the most important
+ones but all other protocols can also be forwarded through it.
+
+OnionCat opens a TUN device and assigns an IPv6 address to it. All packets
+forwarded to the TUN device by the kernel are forwarded by OnionCat to other
+OnionCats listening on Tor's hidden service ports.  The IPv6 address depends on
+the \fIonion_id\fP of the locally configured hidden service (see \fBtor(8)\fP).
+Depending on the configuration of Tor the \fIonion_id\fP usually can be found
+at \fI/var/lib/tor/hidden_service/hostname\fP or similar location.
+
+.SS OPTIONS
+.TP
+\fB\-4\fP
+Enable IPv4 forwarding. See http://www.cypherpunk.at/onioncat/wiki/IPv4 for further
+information on IPv4.
+.TP
+\fB\-a\fP
+OnionCat creates a log file at $HOME/.ocat/connect_log. All incomming connects are
+logged to that file. $HOME is determined from the user under which OnionCat runs
+(see option -u).
+.TP
+\fB\-b\fP
+Run OnionCat in background.
+.TP
+\fB\-C\fP
+Disable the local controller interface. The controller interfaces listens on
+localhost (127.0.0.1 and ::1 port 8066) for incomming connections. It's
+currently used for debugging purpose and not thread-safe and does not have any
+kind of authentication or authorization mechanism. Hence, it should not be used
+in production environments.
+.TP
+\fB\-d\fP \fIn\fP
+Set debug level to \fIn\fP. Default = 7 which is maximum. Debug output will
+only be created if OnionCat was compiled with option DEBUG (i.e. configure was
+run with option --enable-debug).
+.TP
+\fB\-f\fP \fIconfig file\fP
+Read initial configuration from \fIconfig file\fP. 
+.TP
+\fB\-h\fP
+Display short usage message and shows options.
+.TP
+\fB\-i\fP
+Convert \fIonion_id\fP to IPv6 address and exit.
+.TP
+\fB\-l\fP \fIport\fP
+Local \fIport\fP number OnionCat listens for incoming connections.
+.TP
+\fB\-L\fP \fIlog_file\fP
+Log output to \fIlog_file\fP instead of stderr.
+.TP
+\fB\-o\fP \fIIPv6 address\fP
+Convert \fIIPv6 address\fP to \fIonion_id\fP and exit program.
+.TP
+\fB\-p\fP
+Use TAP device instead of TUN device. There are a view differences. See \fBTAP
+DEVICE\fP later.
+.TP
+\fB\-P\fP \fIpid file\fP
+Create \fIpid file\fP instead of \fB/var/run/ocat.pid\fP.
+.TP
+\fB\-r\fP
+Run OnionCat as root and don't change user id (see option \fB\-u\fP).
+.TP
+\fB\-R\fP
+Use this option only if you really know what you do!
+Generate a random local onion_id. With this option it is not necessary to add a
+hidden service to the Tor configuration file \fBtorrc\fP.
+One might use OnionCat services within Tor as usualy but it is NOT possible to
+receive incoming connections. If you plan to also receive connections (e.g.
+because you provide a service or you use software which opens sockets for
+incomming connections like Bitorrent) you MUST configure a hidden service and
+supply its hostname to OnionCat on the command line.
+.TP
+\fB\-s\fP \fIport\fP
+Set OnionCat's virtual hidden service port to \fIport\fP.
+.TP
+\fB\-t\fP \fI(IP|[IP:]port)\fP
+Set Tor SOCKS \fIIP\fP and/or \fIport\fP. If no \fIIP\fP is specified 127.0.0.1
+will be used, if no \fIport\fP is specified 9050 will be used as defaults. IPv6
+addresses must be escaped by square brackets.
+.TP
+\fB\-T\fP \fItun_dev\fP
+TUN device file to open for creation of TUN interface, defaults to
+/dev/net/tun. Setup of a TUN device needs root permissions. OnionCat automatically
+changes userid after the TUN device is set up correctly.
+.TP
+\fB\-u\fP \fIusername\fP
+\fIusername\fP under which ocat should run. The uid is changed as soon as possible
+after tun device setup.
+
+.SS TAP DEVICE
+Usually OnionCat opens a TUN device which is a layer 3 interface. With option
+\fB\-p\fP OnionCat opens a TAP device instead which is a virtual ethernet
+(layer 2) interface.
+
+.SH NOTES
+This man page is still not finished...
+
+.SH FILES
+$HOME/.ocat/connect_log
+
+.SH AUTHOR
+Software and man page written by Bernhard R. Fischer.
+Concept by Bernhard R. Fischer and Daniel Haslinger.
+
+.SH "SEE ALSO"
+OnionCat project page http://www.cypherpunk.at/onioncat/
+
+Tor project homepage http://www.torproject.org/
+
+.SH COPYRIGHT
+Copyright 2008 Bernhard R. Fischer, Daniel Haslinger.
+
+This file is part of OnionCat.
+
+OnionCat is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, version 3 of the License.
+
+OnionCat is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with OnionCat. If not, see <http://www.gnu.org/licenses/>.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/onioncat.git

