doc/man/8/rados: include all available options

Include all available options in documentation page.

Signed-off-by: Rodrigo Severo <rodrigo@fabricadeideias.com>

diff --git a/doc/man/8/rados.rst b/doc/man/8/rados.rst
index 18807f5008fa89c75020d5e8e9c1ab104cd8941f..147313f146d6b848f6eb5cd9a5b32bbd98327cb2 100644 (file)
--- a/doc/man/8/rados.rst
+++ b/doc/man/8/rados.rst
@@ -19,13 +19,21 @@ Description
 cluster (RADOS), part of the Ceph distributed storage system.
 
 
-Options
-=======
+Global Options
+==============
+
+.. option:: --object-locator object_locator
+
+   Set object_locator for operation.
 
 .. option:: -p pool, --pool pool
 
    Interact with the given pool. Required by most commands.
 
+.. option:: --target-pool pool
+
+   Select target pool by name.
+
 .. option:: --pgid
 
    As an alternative to ``--pool``, ``--pgid`` also allow users to specify the
@@ -36,27 +44,30 @@ Options
 
    Specify the rados namespace to use for the object.
 
+.. option:: --all
+
+   Use with ls to list objects in all namespaces.
+   Put in CEPH_ARGS environment variable to make this the default.
+
+.. option:: --default
+
+   Use with ls to list objects in default namespace.
+   Takes precedence over --all in case --all is in environment.
+
 .. option:: -s snap, --snap snap
 
    Read from the given pool snapshot. Valid for all pool-specific read operations.
 
+.. option:: --create
+
+   Create the pool or directory that was specified.
+
 .. option:: -i infile
 
    will specify an input file to be passed along as a payload with the
    command to the monitor cluster. This is only used for specific
    monitor commands.
 
-.. option:: -o outfile
-
-   will write any payload returned by the monitor cluster with its
-   reply to outfile. Only specific monitor commands (e.g. osd getmap)
-   return a payload.
-
-.. option:: -c ceph.conf, --conf=ceph.conf
-
-   Use ceph.conf configuration file instead of the default
-   /etc/ceph/ceph.conf to determine monitor addresses during startup.
-
 .. option:: -m monaddress[:port]
 
    Connect to specified monitor (instead of looking through ceph.conf).
@@ -69,18 +80,154 @@ Options
 
    Uses the striping API of rados rather than the default one.
    Available for stat, stat2, get, put, append, truncate, rm, ls
-   and all xattr related operation
+   and all xattr related operation.
+
+.. option:: -O object_size, --object-size object_size
+
+   Set the object size for put/get ops and for write benchmarking.
 
-.. option:: -O object_size
+.. option:: --max-objects
 
-   Set the object size for put/get ops and for write benchmarking
+   Set the max number of objects for write benchmarking.
 
 .. option:: --lock-cookie locker-cookie
 
-   Will set the lock cookie for acquiring advisory lock (lock get command). 
+   Will set the lock cookie for acquiring advisory lock (lock get command).
    If the cookie is not empty, this option must be passed to lock break command
    to find the correct lock when releasing lock.
 
+.. option:: --target-locator
+
+   Use with cp to specify the locator of the new object.
+
+.. option:: --target-nspace
+
+   Use with cp to specify the namespace of the new object.
+
+
+Bench options
+=============
+
+.. option:: -t N, --concurrent-ios=N
+
+   Set number of concurrent I/O operations.
+
+.. option:: --show-time
+
+   Prefix output with date/time.
+
+.. option:: --no-verify
+
+   Do not verify contents of read objects.
+
+.. option:: --write-object
+
+   Write contents to the objects.
+
+.. option:: --write-omap
+
+   Write contents to the omap.
+
+.. option:: --write-xattr
+
+   Write contents to the extended attributes.
+
+
+Load gen options
+================
+
+.. option:: --num-objects
+
+   Total number of objects.
+
+.. option:: --min-object-size
+
+  Min object size.
+
+.. option:: --max-object-size
+
+   Max object size.
+
+.. option:: --min-op-len
+
+   Min io size of operations.
+
+.. option:: --max-op-len
+
+   Max io size of operations.
+
+.. option:: --max-ops
+
+   Max number of operations.
+
+.. option:: --max-backlog
+
+   Max backlog size.
+
+.. option:: --read-percent
+
+   Percent of operations that are read.
+
+.. option:: --target-throughput
+
+   Target throughput (in bytes).
+
+.. option:: --run-length
+
+   Total time (in seconds).
+
+.. option:: --offset-align
+
+   At what boundary to align random op offsets.
+
+
+Cache pools options
+===================
+
+.. option:: --with-clones
+
+   Include clones when doing flush or evict.
+
+
+OMAP options
+============
+
+.. option:: --omap-key-file file
+
+   Read the omap key from a file.
+
+
+Generic options
+===============
+
+.. option:: -c FILE, --conf FILE
+
+   Read configuration from the given configuration file.
+
+.. option:: --id ID
+
+   Set ID portion of my name.
+
+.. option:: -n TYPE.ID, --name TYPE.ID
+
+   Set cephx user name.
+
+.. option:: --cluster NAME
+
+   Set cluster name (default: ceph).
+
+.. option:: --setuser USER
+
+   Set uid to user or uid (and gid to user's gid).
+
+.. option:: --setgroup GROUP
+
+   Set gid to group or gid.
+
+.. option:: --version
+
+   Show version and quit.
+
 
 Global commands
 ===============