Author: atagar Date: 2010-11-15 03:16:54 +0000 (Mon, 15 Nov 2010) New Revision: 23797
Added: arm/trunk/arm.1 Removed: arm/trunk/debian/arm.1.gz arm/trunk/debian/manpages Modified: arm/trunk/debian/MANIFEST arm/trunk/debian/make-deb arm/trunk/setup.py Log: Storing uncompressed man page and compressing them as part of the install process. Added: arm/trunk/arm.1 =================================================================== --- arm/trunk/arm.1 (rev 0) +++ arm/trunk/arm.1 2010-11-15 03:16:54 UTC (rev 23797) @@ -0,0 +1,69 @@ +.TH arm 1 "27 August 2010" +.SH NAME +arm - Terminal Tor status monitor + +.SH SYNOPSIS +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 + +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) + +.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 +.TP +\fB/usr/arm/armrc.sample\fR +example configuration file + +.SH AUTHOR +Written by Damian Johnson ([email protected]) + +.SH COPYRIGHT +GNU GPL version 3, \fIhttp://gnu.org/licenses/gpl.html\fR + Modified: arm/trunk/debian/MANIFEST =================================================================== --- arm/trunk/debian/MANIFEST 2010-11-14 12:49:56 UTC (rev 23796) +++ arm/trunk/debian/MANIFEST 2010-11-15 03:16:54 UTC (rev 23797) @@ -2,8 +2,8 @@ setup.cfg setup.py arm +arm.1 armrc.sample -debian/arm.1.gz src/__init__.py src/prereq.py src/starter.py Deleted: arm/trunk/debian/arm.1.gz =================================================================== (Binary files differ) Modified: arm/trunk/debian/make-deb =================================================================== --- arm/trunk/debian/make-deb 2010-11-14 12:49:56 UTC (rev 23796) +++ arm/trunk/debian/make-deb 2010-11-15 03:16:54 UTC (rev 23797) @@ -1,10 +1,9 @@ #!/bin/sh cp debian/setup.cfg ./ -cp debian/arm.1.gz ./ debuild -I.svn -i.svn -I.pyc -i.pyc # cleans up after deb build -files="build debian/tor-arm debian/python-module-stampdir debian/tor-arm.debhelper.log debian/files debian/tor-arm.substvars setup.cfg arm.1.gz" +files="build debian/tor-arm debian/python-module-stampdir debian/tor-arm.debhelper.log debian/files debian/tor-arm.substvars setup.cfg" for i in $files do Deleted: arm/trunk/debian/manpages =================================================================== --- arm/trunk/debian/manpages 2010-11-14 12:49:56 UTC (rev 23796) +++ arm/trunk/debian/manpages 2010-11-15 03:16:54 UTC (rev 23797) @@ -1 +0,0 @@ -arm.1.gz Modified: arm/trunk/setup.py =================================================================== --- arm/trunk/setup.py 2010-11-14 12:49:56 UTC (rev 23796) +++ arm/trunk/setup.py 2010-11-15 03:16:54 UTC (rev 23797) @@ -1,9 +1,28 @@ #!/usr/bin/env python import os import sys +import gzip from src.version import VERSION from distutils.core import setup +# Compresses the man page. This is a temporary file that we'll install. If +# something goes wrong then we'll print the issue and use the uncompressed man +# page instead. Build resources are cleaned up by the installion script later. +try: + manInputFile = open('arm.1', 'r') + manContents = manInputFile.read() + manInputFile.close() + + if not os.path.exists('./build'): os.makedirs('./build') + manOutputFile = gzip.open('build/arm.1.gz', 'wb') + manOutputFile.write(manContents) + manOutputFile.close() + + manFilename = "build/arm.1.gz" +except IOError, exc: + print "Unable to compress man page: %s" % exc + manFilename = "arm.1" + setup(name='arm', version=VERSION, description='Terminal tor status monitor', @@ -14,8 +33,8 @@ packages=['arm', 'arm.interface', 'arm.interface.graphing', 'arm.util', 'arm.TorCtl'], package_dir={'arm': 'src'}, data_files=[("/usr/bin", ["arm"]), - ("/usr/lib/arm", ["src/settings.cfg"]), - ("/usr/share/man/man1", ["debian/arm.1.gz"])], + ("/usr/share/man/man1", [manFilename]), + ("/usr/lib/arm", ["src/settings.cfg"])], ) # Removes the egg_info file. Apparently it is not optional during setup
