Project

General

Profile

Actions

Feature #884

closed

add man pages

Added by Victor Julien about 9 years ago. Updated over 3 years ago.

Status:
Closed
Priority:
Normal
Target version:
Effort:
Difficulty:
Label:

Description

For all shipped binaries/scripts, we should create manpages. help2man tool would be a good start.

Actions #1

Updated by Victor Julien almost 9 years ago

  • Target version set to TBD
Actions #2

Updated by Andreas Herz almost 7 years ago

  • Assignee set to OISF Dev
Actions #3

Updated by Victor Julien about 4 years ago

We do have some manpages now, which ones are missing?

Actions #4

Updated by Andreas Herz over 3 years ago

I would add `man suricata-update` and `man suricatasc`

Actions #5

Updated by Victor Julien over 3 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.

Actions #6

Updated by Victor Julien over 3 years ago

  • Target version changed from TBD to 70
Actions #7

Updated by Shivani Bhardwaj over 3 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.

Actions #8

Updated by Victor Julien over 3 years ago

I prefer sphinx based, just like the suricata one. The ticket predates our sphinx use.

Actions #9

Updated by Victor Julien over 3 years ago

  • Target version changed from 70 to 5.0beta1
Actions #10

Updated by Shivani Bhardwaj over 3 years ago

  • Status changed from Assigned to Feedback
Actions #11

Updated by Victor Julien over 3 years ago

  • Status changed from Feedback to Closed
Actions

Also available in: Atom PDF