Actions
Feature #884
closedadd man pages
Effort:
Difficulty:
Label:
Description
For all shipped binaries/scripts, we should create manpages. help2man tool would be a good start.
Updated by Victor Julien almost 6 years ago
We do have some manpages now, which ones are missing?
Updated by Andreas Herz about 5 years ago
I would add `man suricata-update` and `man suricatasc`
Updated by Victor Julien about 5 years ago
- 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.
Updated by Victor Julien about 5 years ago
- Target version changed from TBD to 70
Updated by Shivani Bhardwaj about 5 years ago
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.
Updated by Victor Julien about 5 years ago
I prefer sphinx based, just like the suricata one. The ticket predates our sphinx use.
Updated by Victor Julien about 5 years ago
- Target version changed from 70 to 5.0beta1
Updated by Shivani Bhardwaj about 5 years ago
- Status changed from Assigned to Feedback
Updated by Victor Julien almost 5 years ago
- Status changed from Feedback to Closed
Actions