Project

General

Profile

Actions
Copy link

Feature #884

closed
VJ SB

add man pages

Feature #884: add man pages

Added by Victor Julien over 12 years ago. Updated almost 7 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Shivani Bhardwaj
Target version:
5.0beta1
Effort:
Difficulty:
Label:

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
Copy link
 #1

  • Target version set to TBD

AH Updated by Andreas Herz over 10 years ago Actions
Copy link
 #2

  • Assignee set to OISF Dev

VJ Updated by Victor Julien over 7 years ago Actions
Copy link
 #3

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

AH Updated by Andreas Herz about 7 years ago Actions
Copy link
 #4

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

VJ Updated by Victor Julien about 7 years ago Actions
Copy link
 #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
Copy link
 #6

  • Target version changed from TBD to 70

SB Updated by Shivani Bhardwaj about 7 years ago Actions
Copy link
 #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
Copy link
 #8

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

VJ Updated by Victor Julien almost 7 years ago Actions
Copy link
 #9

  • Target version changed from 70 to 5.0beta1

SB Updated by Shivani Bhardwaj almost 7 years ago Actions
Copy link
 #10

  • Status changed from Assigned to Feedback

VJ Updated by Victor Julien almost 7 years ago Actions
Copy link
 #11

  • Status changed from Feedback to Closed
Actions
Copy link

Also available in: PDF Atom