trietptm / pentoo

Automatically exported from code.google.com/p/pentoo
1 stars 0 forks source link

missing manpages #1

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
I went through today and check for security related tools that lack manuals. I 
found that not only do some lack manpages but they also lack usage help 
(commonly --help). I even found one binary executable to used DOS syntax and 
another that crashed on an illegal option as an unhandled exception! So much 
for GNU standards.

What I would like to see is a pentoo-documentation ebuild which contains 
manpages that upstream fails to provide. As I write these manpages I will be 
submitting them to upstream. If you would also like to use them for a 
pentoo-documentation ebuild, that would be great.

"RTFM" is a common term in the Linux and Security communities. It is no good if 
there isn't a manual to read. I am aware that a few of these applications, w3af 
and metasploit for example, have detailed PDF documentation. I personally think 
that this is not acceptable... but it is still documented and the information 
is there. These applications would be at the bottom of priority.

The following is the list of security applications that lack manpages:

aimsniff

authforce

autoscan - MUST SUPPLY VERSION

bed

bluemaho

btscanner

buddy-ng - DOESN'T EXIST?

burpsuite - SELF DOCUMENTING

chntpw

cmospwd - USES DOS SYNTAX

cuda-multiforcer

cuda-rarcrypt

dnsa

dnsenum

mbrowse

snmpenum

thcrut

psmscan

rfcomm_scan

john - NO USAGE HELP OR MAN

md5bf

ophcrack

pyrit - UPSTREAM ISSUE... INVALID OPTION IS UNHANDLED EXCEPTION

rcracki_mt

sipcrack

mssqlscan

sqlninja

minimysqlator

ALL ORACLE TOOLS

fast-track

sqid

sqlibf

sqlix

sqlmap

sqlibf

inguma

mosref

metasploit?

raccess

w3af

winexe

fierce

subdomainer

siphon

ntp-fingerprint

smtpmap

geoedge

wfuzz

theHarvester

metagoofil

gspoof

hping - man hping3 points to the man page of hping2 but man hping2 does not

isic

fusil-*

smudge

ohrwurm

taof

sslsniff

httpush

proxychains

proxyresolv

proxystrike

edb

galleta

pasco

nikto

webshag

nbtscan

autoscan

onesixtyone

ppscan

sv*.py

sipdump

sipsack

videojak

voiphopper

voipong

cowpatty

gerix

mdk3

spectool*

wepattack

wifitap

Lets not let google be the primary source of documentation.

Alright, I have started work on writing these manpages today. In case someone 
else wants to work on some, I will list the ones that I am currently working. I 
will be going down the list from top to bottom, possibly skipping software with 
closed licenses (if there is any).

To start, I will work on the following:

aimsniff

authforce

bed

bluemaho

btscanner

chntpw

Original issue reported on code.google.com by sidhayn on 24 Apr 2012 at 2:19

GoogleCodeExporter commented 9 years ago
aimsniff

authforce

bed

btscanner

chntpw

I omitted bluemaho after I saw that it was a GUI. I still plan to write 
something up but it is lower priority than the command line tools that need a 
decent reference.

Next set:

cmospwd

dnsa

dnsenum

mbrowse

snmpenum

Original comment by sidhayn on 24 Apr 2012 at 2:21

Attachments:

GoogleCodeExporter commented 9 years ago
The next set was all taken from Debian. It includes:

galleta.1

john.8

mbrowse.1

nbtscan.1

nikto.1

onesixtyone.1

ophcrack.1

pasco.1

proxychains.1

sipcrack.1

sipdump.1

squid.8

I also found that autoscan's manpage is included in Pentoo. Like hping, the 
version number must be specified.

TODO: rename /usr/share/man/man1/autoscan-2.63.1.gz to 
/usr/share/man/man1/autoscan.1.gz

rename /usr/share/man/man8/hping3.8.gz /usr/share/man/man8/hping.8.gz

Original comment by sidhayn on 24 Apr 2012 at 2:21

Attachments:

GoogleCodeExporter commented 9 years ago
All work on this ticket including original report was done by Titan8990 and 
copied from the old bugtracker

Original comment by sidhayn on 24 Apr 2012 at 2:23

GoogleCodeExporter commented 9 years ago

Original comment by sidhayn on 24 Apr 2012 at 2:23

GoogleCodeExporter commented 9 years ago

Original comment by sidhayn on 24 Apr 2012 at 6:54

GoogleCodeExporter commented 9 years ago
Sane cleanup for this bug step by step

1.) check if that program is even still installed in pentoo
2.) if yes, check that it still has no man page
3.) download the attached tarballs, find the appropriate manpage
4.) cp the existing version of the ebuild and add a -r1 (or up the -r1 to -r2 
and so on)
5.) edit the ebuild for the package, add a "doman ${FILESDIR}/whatever" line to 
the src_install section of the ebuild
6.) ebuild edited-1.0-r1.ebuild manifest
7.) emerge edited -1 (then check if the man page works
8.) svn diff and attach to the ticket

Do a good job on a few and I'll give you commit access for the rest.

Original comment by sidhayn on 24 Apr 2012 at 7:00

GoogleCodeExporter commented 9 years ago
Also go through the attached man pages before blinding adding them. Make sure 
they belong to the right version, etc.

It wouldn't hurt to poke upstream about it if upstream still exists.

Original comment by sidhayn on 24 Apr 2012 at 7:01

GoogleCodeExporter commented 9 years ago
[deleted comment]
GoogleCodeExporter commented 9 years ago
--- pasco-20040505_p1.ebuild    2012-04-26 11:54:24.000000000 -0700
+++ pasco-20040505_p1-r1.ebuild 2012-04-26 12:18:11.000000000 -0700
@@ -22,6 +22,6 @@

 src_install() {
    dobin src/pasco
-   #doman /usr/share/man/man1/pasco.1.gz
-   #doman $(find man/ -type f)
+   doman ${FILESDIR}/pasco.1.gz
+
 }

Original comment by anthonyb...@gmail.com on 27 Apr 2012 at 3:20

Attachments:

GoogleCodeExporter commented 9 years ago
--- galleta-20040505_p1.ebuild  2012-04-26 12:21:35.000000000 -0700
+++ galleta-20040505_p1-r1.ebuild   2012-04-26 12:24:26.000000000 -0700
@@ -25,4 +25,5 @@
 src_install() {
    dodoc Readme.txt
    dobin src/galleta
+   doman ${FILESDIR}/galleta.1
 }

Original comment by anthonyb...@gmail.com on 27 Apr 2012 at 3:28

Attachments:

GoogleCodeExporter commented 9 years ago
--- ophcrack-3.3.1.ebuild   2012-04-26 11:48:15.000000000 -0700
+++ ophcrack-3.3.1-r1.ebuild    2012-04-26 12:31:37.000000000 -0700
@@ -39,4 +39,5 @@
    cd "${S}"
    newicon src/gui/pixmaps/os.xpm ophcrack.xpm
    make_desktop_entry "${PN}" OphCrack ophcrack
+   doman ${FILESDIR}/ophcrack.1
 }

Original comment by anthonyb...@gmail.com on 27 Apr 2012 at 3:45

Attachments:

GoogleCodeExporter commented 9 years ago
Went threw the list these packages aren't even installed so disregard them.
authforce
bluemaho
psmscan
rcracki_mt
mosref
smudge
httpush
gerix
wifitap

Original comment by TheEccen...@gmail.com on 27 Apr 2012 at 4:26

GoogleCodeExporter commented 9 years ago
--- SIPcrack-0.4-r1.ebuild  2012-04-27 08:38:22.000000000 -0700
+++ SIPcrack-0.4-r2.ebuild  2012-04-27 09:49:21.000000000 -0700
@@ -29,4 +29,6 @@
 src_install() {
    dobin sipcrack sipdump
    dodoc README USAGE_EXAMPLES
+   doman ${FILESDIR}/sipcrack.1
+   doman ${FILESDIR}/sipdump.1
 }
h@x0

Original comment by TheEccen...@gmail.com on 28 Apr 2012 at 12:59

Attachments:

GoogleCodeExporter commented 9 years ago
--- dnsa-0.5_beta-r2.ebuild 2012-04-27 10:53:19.000000000 -0700
+++ dnsa-0.5_beta-r3.ebuild 2012-04-27 11:13:16.000000000 -0700
@@ -32,4 +32,5 @@
 src_install() {
    dobin dnsa || die "install failed"
    dodoc ../docs/README ../docs/EXAMPLES
-}
+   doman ${FILESDIR}/dnsa.1 
+   }

Original comment by TheEccen...@gmail.com on 28 Apr 2012 at 2:43

Attachments:

GoogleCodeExporter commented 9 years ago
--- mbrowse-0.4.3.ebuild    2012-04-27 11:51:28.000000000 -0700
+++ mbrowse-0.4.3-r1.ebuild 2012-04-27 11:55:12.000000000 -0700
@@ -34,4 +34,5 @@
    emake DESTDIR="${D}" install || die

    dodoc AUTHORS README ChangeLog
+   doman ${FILESDIR}/mbrowse.1
 }

Original comment by TheEccen...@gmail.com on 28 Apr 2012 at 3:01

Attachments:

GoogleCodeExporter commented 9 years ago
--- proxychains-3.1_p20110225.ebuild    2012-04-27 11:26:59.000000000 -0700
+++ proxychains-3.1_p20110225-r1.ebuild 2012-04-27 12:02:56.000000000 -0700
@@ -28,3 +28,7 @@
    autotools-utils_src_prepare
    eautoreconf
 }
+
+src_install() {
+   doman ${FILESDIR}/proxychains.1
+}

Original comment by TheEccen...@gmail.com on 28 Apr 2012 at 3:14

Attachments:

GoogleCodeExporter commented 9 years ago
--- nikto-2.1.4.ebuild  2012-04-27 12:15:42.000000000 -0700
+++ nikto-2.1.4-r1.ebuild   2012-04-27 12:16:18.000000000 -0700
@@ -55,4 +55,5 @@

    dodoc docs/*.txt || die
    dohtml docs/nikto_manual.html || die
+   doman ${FILESDIR}/nikto.1
 }

Original comment by TheEccen...@gmail.com on 28 Apr 2012 at 3:27

Attachments:

GoogleCodeExporter commented 9 years ago
--- nbtscan-1.5.1-r2.ebuild 2012-04-27 12:08:46.000000000 -0700
+++ nbtscan-1.5.1-r3.ebuild 2012-04-27 12:10:56.000000000 -0700
@@ -31,4 +31,5 @@
 src_install () {
    dobin ${PN} || die "dobin ${PN}"
    dodoc ChangeLog README
+   doman ${FILESDIR}/nbtscan.1
 }

Original comment by TheEccen...@gmail.com on 28 Apr 2012 at 3:40

Attachments:

GoogleCodeExporter commented 9 years ago
--- johntheripper-1.7.9-r2.ebuild   2012-04-27 13:01:12.000000000 -0700
+++ johntheripper-1.7.9-r3.ebuild   2012-04-27 13:02:21.000000000 -0700
@@ -214,4 +214,6 @@

    # documentation
    dodoc doc/*
+   #manual 
+   doman ${FILESDIR}/john.8
 }

Original comment by TheEccen...@gmail.com on 28 Apr 2012 at 4:29

Attachments:

GoogleCodeExporter commented 9 years ago
--- sslsniff-0.8.ebuild 2012-04-27 13:39:00.000000000 -0700
+++ sslsniff-0.8-r1.ebuild  2012-04-27 13:47:46.000000000 -0700
@@ -35,4 +35,5 @@

    insinto /usr/share/sslsniff/certs
    doins certs/*
+   doman ${FILESDIR}/sslsniff.1
 }

Original comment by TheEccen...@gmail.com on 28 Apr 2012 at 4:57

Attachments:

GoogleCodeExporter commented 9 years ago
--- dnsa-0.5_beta-r2.ebuild 2012-04-27 10:53:19.000000000 -0700
+++ dnsa-0.5_beta-r3.ebuild 2012-04-27 11:13:16.000000000 -0700
@@ -32,4 +32,5 @@
 src_install() {
    dobin dnsa || die "install failed"
    dodoc ../docs/README ../docs/EXAMPLES
-}
+   doman ${FILESDIR}/dnsa.1 
+}

Original comment by TheEccen...@gmail.com on 30 Apr 2012 at 1:58