[or-cvs] r23085: {arm} added: installing a man page along with arm (arm/trunk)

[Damian Johnson]

Author: atagar
Date: 2010-08-28 20:44:08 +0000 (Sat, 28 Aug 2010)
New Revision: 23085

Modified:
   arm/trunk/arm.1
   arm/trunk/setup.py
Log:
added: installing a man page along with arm



Modified: arm/trunk/arm.1
===================================================================
--- arm/trunk/arm.1	2010-08-28 08:19:36 UTC (rev 23084)
+++ arm/trunk/arm.1	2010-08-28 20:44:08 UTC (rev 23085)
@@ -1,26 +1,69 @@
-.TH arm 1 "24 August 2010"
+.TH arm 1 "27 August 2010"
 .SH NAME
 arm - Terminal Tor status monitor
+
 .SH SYNOPSIS
-arm [OPTION]
+arm [\fIOPTION\fR]
+
 .SH DESCRIPTION
+The anonymizing relay monitor (arm) is a terminal status monitor for Tor
+relays, intended for command-line aficionados, ssh connections, and anyone
+stuck with a tty terminal. This works much like top does for system usage,
+providing real time statistics for:
+  * bandwidth, cpu, and memory usage
+  * relay's current configuration
+  * logged events
+  * connection details (ip, hostname, fingerprint, and consensus data)
+  * etc
 
-.B arm
-is a terminal status monitor for
-.B Tor
-relays.
+Defaults and interface properties are configurable via a user provided
+configuration file (for an example see the provided \fBarmrc.sample\fR).
+Releases and information are available at \fIhttp://www.atagar.com/arm\fR.
 
 .SH OPTIONS
+.TP
+\fB\-i\fR, \fB\-\-interface [ADDRESS:]PORT\fR
+tor control port arm should attach to (default is \fB127.0.0.1:9051\fR)
 
-.B -h
-.IP
-Print usage information for
-.B arm(1)
-.P
+.TP
+\fB\-c\fR, \fB\-\-config CONFIG_PATH\fR
+user provided configuration file (default is \fB~/.armrc\fR)
 
+.TP
+\fB\-b\fR, \fB\-\-blind\fR
+disable connection lookups (netstat, lsof, and ss), dropping the parts of the
+interface that rely on this information
+
+.TP
+\fB\-e\fR, \fB\-\-event EVENT_FLAGS\fR
+flags for tor, arm, and torctl events to be logged (default is \fBN3\fR)
+
+  d DEBUG      a ADDRMAP           k DESCCHANGED   s STREAM
+  i INFO       f AUTHDIR_NEWDESCS  g GUARD         r STREAM_BW
+  n NOTICE     h BUILDTIMEOUT_SET  l NEWCONSENSUS  t STATUS_CLIENT
+  w WARN       b BW                m NEWDESC       u STATUS_GENERAL
+  e ERR        c CIRC              p NS            v STATUS_SERVER
+               j CLIENTS_SEEN      q ORCONN
+    DINWE tor runlevel+            A All Events
+    12345 arm runlevel+            X No Events
+    67890 torctl runlevel+         U Unknown Events
+
+.TP
+\fB\-v\fR, \fB\-\-verion\fR
+provides version information
+
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+provides usage information
+
 .SH FILES
-.B ~/.armrc
-.IP
-Optional user customized configuration
-.P
+.TP
+\fB/usr/arm/armrc.sample\fR
+example configuration file
 
+.SH AUTHOR
+Written by Damian Johnson (atagar1 at gmail.com)
+
+.SH COPYRIGHT
+GNU GPL version 3, \fIhttp://gnu.org/licenses/gpl.html\fR
+

Modified: arm/trunk/setup.py
===================================================================
--- arm/trunk/setup.py	2010-08-28 08:19:36 UTC (rev 23084)
+++ arm/trunk/setup.py	2010-08-28 20:44:08 UTC (rev 23085)
@@ -14,6 +14,7 @@
       packages=['arm', 'arm.interface', 'arm.interface.graphing', 'arm.util', 'arm.TorCtl'],
       package_dir={'arm': 'src'},
       scripts=["arm"],
+      data_files=[("/usr/share/man/man1", ["arm.1"])],
      )
 
 # Removes the egg_info file. Apparently it is not optional during setup