1TORSOCKS(1)                                                        TORSOCKS(1)
2
3
4

NAME

6       torsocks — Shell wrapper to simplify the use of the torsocks(8) library
7       to transparently torify an application.
8
9

SYNOPSIS

11       torsocks [OPTIONS] [COMMAND [ARG ...]]
12
13

DESCRIPTION

15       torsocks is a wrapper between the torsocks library and the  application
16       in  order  to make every Internet communication go through the Tor net‐
17       work.
18
19       By default, torsocks will assume that it  should  connect  to  the  Tor
20       SOCKS proxy running at 127.0.0.1 on port 9050 being the defaults of the
21       Tor daemon.
22
23       In order to use a  configuration  file,  torsocks  tries  to  read  the
24       /etc/tor/torsocks.conf  file  or look for the environment variable TOR‐
25       SOCKS_CONF_FILE with the location of the file. If that file  cannot  be
26       read, torsocks will use sensible defaults for most Tor installations.
27
28       For further information on configuration, see torsocks.conf(5).
29
30

OPTIONS

32       -h, --help
33              Show summary of possible options and commands.
34
35       --shell
36              Create a new shell with LD_PRELOAD including torsocks(8).
37
38       --version
39              Show version.
40
41       -u, --user
42              Set username for the SOCKS5 authentication. Use for circuit iso‐
43              lation in Tor.  Note that you MUST have a password set either by
44              the  command  line,  environment  variable or configuration file
45              (torsocks.conf(5).
46
47       -p, --pass
48              Set password for the SOCKS5 authentication. Use for circuit iso‐
49              lation in Tor.  Note that you MUST have a username set either by
50              the command line, environment  variable  or  configuration  file
51              (torsocks.conf(5)).
52
53       -a, --address
54              Set Tor address.
55
56       -P, --port
57              Set Tor port.
58
59       -i, --isolate
60              Automatic  tor  isolation. Set the username and password for the
61              SOCKS5 authentication method to a PID/current time  based  value
62              automatically. Username and Password MUST NOT be set.
63
64       -d, --debug
65              Activate the debug mode. Output will be written on stderr.
66
67       -q, --quiet
68              Suppress every log messages (even errors).
69
70       on | off
71              This  option  adds  or  removes  torsocks(8) from the LD_PRELOAD
72              environment variable for the current shell. If you want  to  use
73              this option, you HAVE to source torsocks from your shell.
74
75              Add the torsocks library to LD_PRELOAD
76              $ . torsocks on
77              Remove the torsocks library from LD_PRELOAD
78              $ . torsocks off
79
80       show | sh
81              Show the current value of the LD_PRELOAD environment variable.
82
83

ENVIRONMENT VARIABLES

85       Please  see  torsocks(8)  for more detail on possible environment vari‐
86       ables.
87

SEE ALSO

89       torsocks(8), torsocks.conf(5)
90
91

CREDITS

93       torsocks is distributed under the GNU General Public License version 2.
94
95       A Web site is available at https://www.torproject.org for more informa‐
96       tion.
97
98       You can also find the source code at https://git.torproject.org.
99
100       Mailing list for help is <tor-talk@lists.torproject.org> and for devel‐
101       opment use <tor-dev@lists.torproject.org>. You  can  find  the  project
102       also on IRC server irc.oftc.net (OFTC) in #tor and #tor-dev.
103

AUTHOR

105       torsocks  was originally written by Robert Hogan and has been rewritten
106       by David Goulet <dgoulet@torproject.org> in 2013.
107
108                                March 3rd, 2014                    TORSOCKS(1)