A man page for Linux

[GoogleCodeExporter]

I run the Ubuntu PPA at http://launchpad.net/~pi-rho/+archive/security

Debian and Ubuntu standards dictate that every command has a man page.  I 
created this based upon 'vol -h' off the latest trunk.  I want to contribute 
this to to project if the team is willing to accept it.

The description text and "submitting bug" text is from the project wiki, while 
the options were taken directly from the usage text from 'vol -h'

Original issue reported on code.google.com by pi-...@tyr.cx on 2 Sep 2012 at 2:13

Attachments:

• vol.1

[GoogleCodeExporter]

Hi there. Thanks for your interest in the project! I'm just CC'ing a few folks 
and changing the label from Defect to Enhancement. Can you let us know exactly 
what you'd like us to do (i.e. just approve your man page or modify it with 
something)? 

Also just FYI we're preparing for a big release so the guys might not have much 
time for another week or so...

Original comment by michael.hale@gmail.com on 6 Sep 2012 at 9:54

• Added labels: Priority-Low, Type-Enhancement
• Removed labels: Priority-Medium, Type-Defect

[GoogleCodeExporter]

Well, to me it's more efficient for the project team to own the manpage. If the 
project team doesn't want to accept it and distribute it with the source code, 
I'll continue to apply it to my packages -- I'll just need to keep tracking any 
command line options added/removed to vol.py. 

Ideally, if you include it with the source code, you can get 
distutils/setuptools to install it to the proper location by just adding 
something like the following to setup.py:

# after opts['data_files'] = find_pyfiles(['contrib'])
opts['data_files'].append(('share/man/man1', ['resources/vol.1']))

Original comment by pi-...@tyr.cx on 7 Sep 2012 at 12:54

[GoogleCodeExporter]

updated man page

Original comment by pi-...@tyr.cx on 8 Sep 2012 at 2:24

Attachments:

• vol.1

[GoogleCodeExporter]

updated for 2.3_alpha (as of svn-2754)
- added -W, --warnings

Original comment by pi-...@tyr.cx on 27 Oct 2012 at 6:12

Attachments:

• vol.1

[GoogleCodeExporter]

Hey there. Is there a way to automatically generate a man page from the output 
of vol.py -h? At this point, I'm don't think we can commit to maintaining the 
man page. Unfortunately we just don't have the extra time. I'll just mark this 
issue as "Done", but please feel free to continue including volatility in your 
Ubuntu PPA - its a really nice collection of security software and we're proud 
to be amongst them all. 

Original comment by michael.hale@gmail.com on 1 Feb 2013 at 4:24

• Changed state: Done