1nyx(1)                      General Commands Manual                     nyx(1)
2
3
4

NAME

6       nyx - Tor terminal status monitor
7
8

SYNOPSIS

10       nyx [OPTION]
11
12

DESCRIPTION

14       Nyx  is a command line interface for Tor (https://www.torproject.org/),
15       providing detailed real-time relaying information for...
16
17         * bandwidth, cpu, and memory usage
18         * connection information
19         * tor configuration
20         * event logs
21         * etc
22
23       As a curses interface Nyx is particularly well suited for  ssh  connec‐
24       tions,  tty terminals, and command-line aficionados to check the status
25       of tor.
26
27       Nyx  can  be  customized  through  a  configuration  file  located   at
28       ~/.nyx/config.  For  options see https://nyx.torproject.org/#configura‐
29       tion.
30
31

OPTIONS

33       -i, --interface [ADDRESS:]PORT
34              tor control port we should attach to (default is 127.0.0.1:9051)
35
36
37       -s, --socket SOCKET_PATH
38              tor  control  socket   we   should   attach   to   (default   is
39              /var/run/tor/control)
40
41
42       -c, --config CONFIG_PATH
43              user configuration preferences (default is ~/.nyx/config)
44
45
46       -d, --debug LOG_PATH
47              writes all nyx logs to the given location
48
49
50       -l, --log EVENTS
51              comma separated list of events to log
52
53
54       -v, --version
55              provides version information
56
57
58       -h, --help
59              provides usage information
60
61

FILES

63       ~/.nyx/config
64              Your personal nyx configuration file
65
66
67       /usr/share/doc/nyx/nyxrc.sample
68              Sample nyxrc configuration file that documents all options
69
70

AUTHOR

72       Written by Damian Johnson (atagar@torproject.org)
73
74
75
76
77                                27 August 2010                          nyx(1)