Feature #884
closedadd man pages
Added by Victor Julien almost 13 years ago. Updated about 7 years ago.
Description
For all shipped binaries/scripts, we should create manpages. help2man tool would be a good start.
VJ Updated by Victor Julien over 12 years ago Actions #1
- Target version set to TBD
AH Updated by Andreas Herz over 10 years ago Actions #2
- Assignee set to OISF Dev
VJ Updated by Victor Julien almost 8 years ago Actions #3
We do have some manpages now, which ones are missing?
AH Updated by Andreas Herz about 7 years ago Actions #4
I would add `man suricata-update` and `man suricatasc`
VJ Updated by Victor Julien about 7 years ago Actions #5
- Status changed from New to Assigned
- Assignee changed from OISF Dev to Shivani Bhardwaj
Shivani can you check if the python tools have manpages, and if not add them? Suricata-Update, suricatasc and suricatactl.
VJ Updated by Victor Julien about 7 years ago Actions #6
- Target version changed from TBD to 70
SB Updated by Shivani Bhardwaj about 7 years ago Actions #7
I think I'm halfway through this but wanted to confirm if using Sphinx is the right thing or am I supposed to use help2man as in the description? suricata-update does have a sphinx target to make very detailed man pages, I think suricatasc and suricatactl are the only ones left TBD.
VJ Updated by Victor Julien about 7 years ago Actions #8
I prefer sphinx based, just like the suricata one. The ticket predates our sphinx use.
VJ Updated by Victor Julien about 7 years ago Actions #9
- Target version changed from 70 to 5.0beta1
SB Updated by Shivani Bhardwaj about 7 years ago Actions #10
- Status changed from Assigned to Feedback
VJ Updated by Victor Julien about 7 years ago Actions #11
- Status changed from Feedback to Closed