Bug #6691
closed
User story #6659: Man pages for the rudder command
Bug #6689: Man pages for rudder commands introduced in 3.1
Add support for command options or arguments
Added by Alexis Mousset over 9 years ago.
Updated over 9 years ago.
Description
Add a simple syntax for command options and arguments:
# @argument node: node ip or address
# @argument [-s]: start the service
Add a simple syntax for options and agruments to have a complete man page.
# @argument node: node ip or hostname
# @argument [-s]: start the service
- Status changed from New to In progress
This is a bit unclear.
What is the goal of @argument and how will it be used ?
If this is only for documentation, isn't @man sufficient ?
That would allow to display the arguments on the same line:
server
commands for rudder server, run with rudder server command
debug [--truc] <node>
run a debug cf-serverd intended for a specific node. This command targets a specific node and does not affect the running infrastructure. It uses iptables to redirect the specific node communications to the port the debug server is listening on (5310 by default).
Use Ctrl+C to stop the debug server.
Arguments:
node: node ip or address
But it is not that important, and using asciidoc syntax in the @man is enough for the list of arguments/options in the section.
- Status changed from In progress to Pending technical review
- Assignee changed from Alexis Mousset to Benoît PECCATTE
- Pull Request set to https://github.com/Normation/rudder-agent/pull/14
- Status changed from Pending technical review to Pending release
- % Done changed from 0 to 100
- Status changed from Pending release to Released
This bug has been fixed in Rudder 3.0.6 and 3.1.0~rc1 which were released on the 16th June 2015.
Also available in: Atom
PDF