Project

General

Profile

Actions

Documentation #3396

closed

ceph - man page - comprehensive options/switches

Added by Anonymous over 11 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
-
Target version:
-
% Done:

0%

Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:

Description

I have some 2 cents/suggestions with regards to the man page of "ceph":

" ie: CEPH

NAME
ceph - ceph file system control utility"

Noticed that it only documents a subset of what the ceph CLI command can do; it would be great to have the man page output all of its options (switches), parameters (arguments), that way it will be in a single/central place. (In parallel, having a MAN Page section in CEPH docs would also be good - similar to industry standard documentations that would have man CLI pages be available in the Admin Guides (as in Appendices sections).

For instance, in the man page, there are quite a few stuff missing, such as ceph auth list; Although there is a section that points out MONITOR Commands and then displays a URL that points to the Ceph Monitor Commands:

"MONITOR COMMANDS
A more complete summary of commands understood by the monitor cluster can be found in the wiki, at
http://ceph.newdream.net/wiki/Monitor_commands"

Instead of having user hop from one source to another, would be great to have a comprehensive list of what the ceph control utility can do in the man page display.

Actions

Also available in: Atom PDF