svn commit: r1630615 - /incubator/slider/site/trunk/content/docs/manpage.md

[st...@apache.org]

Author: stevel
Date: Thu Oct  9 22:56:15 2014
New Revision: 1630615

URL: http://svn.apache.org/r1630615
Log:
SLIDER-365 manpage adds "slider resolve"

Modified:
    incubator/slider/site/trunk/content/docs/manpage.md

Modified: incubator/slider/site/trunk/content/docs/manpage.md
URL: http://svn.apache.org/viewvc/incubator/slider/site/trunk/content/docs/manpage.md?rev=1630615&r1=1630614&r2=1630615&view=diff
==============================================================================
--- incubator/slider/site/trunk/content/docs/manpage.md (original)
+++ incubator/slider/site/trunk/content/docs/manpage.md Thu Oct  9 22:56:15 2014
@@ -127,6 +127,7 @@ The `--wait` parameter, if provided, spe
 #### **Arguments for `build` and `create`**
 
 
+
 ##### `--package <uri-to-package>`  
 
 This define the slider application package to be deployed.
@@ -380,7 +381,7 @@ Example
     slider list instance1
     slider list --live --history
 
-### `registry (--list | --listconf | --getconf <conf>) [--name <name>] [--servicetype <servicetype>] [--verbose]`
+### `registry (--list | --listconf | --getconf <conf> | --resolve <path>) [--name <name>] [--servicetype <servicetype>] [--out <filename>] [--verbose]`
 
 List registered application instances visible to the user. This is slightly
 different from the `slider list` command in that it does not make use of the
@@ -392,7 +393,7 @@ this is the application instance
 
 
 The `--servicetype <servicetype>` option allows a different service type to be chosen.
-The default is `"org.apache.slider`
+The default is `org-apache-slider`
 
 The `--verbose` flag triggers more verbose output on the operations
 
@@ -422,13 +423,87 @@ List the configurations exported by of a
 
 
 
-#### `slider registry --getconf <configuration> [--format (xml|json|properties)] [--dest <path>] [--internal] `
+#### `slider registry --getconf <configuration> [--format (xml|json|properties)] [--servicetype <servicetype>] [--name <name>] [--dest <path>] [--internal] ` get the configuration
  
 Get a named configuration in a chosen format. Default: XML
 
   `--dest <path>` : the filename or directory to save a configuration to.
   `--format (xml|json|properties)` defines the output format
 
+If the  `--dest` argument is set and refers to a directory, the file is saved
+under that file, with the filename derived from the configuration name requested:
+
+Example:
+
+    slider registry --getconf hbase-site.xml --name hbase1 --dest confdir
+
+If `confdir` exists, this downloads the hbase site configuration to `confdir/hbase-site.xml`.
+
+If the destination path refers to a file (or does not exist), the specified
+path is used for the file:
+
+    slider registry --getconf hbase-site.xml --name hbase1 --dest configfile.xml
+
+This will download the configuration to the file `configfile.xml`.
+
+### `slider resolve --path <path> [--out <filename>] [--list] [--destdir <dir]`
+
+This command resolves the service record under a path in the registry,
+or lists all service records directly under a path.
+
+The result can be printed to the console (default) or saved to the filesystem;
+the means of specifiying the destination varies depending on whether a single
+record or a listing is requested.
+
+### Resolve a single entry: `slider resolve --path <path>`
+
+The basic `slider resolve --path <path>` command, without the `--list` option
+will attempt to resolve the service record at the destination. The record
+may be saved to the file specified with the `--out`
+
+*Example*: resolve and print the record at `/users/hbase/services/org-apache-hbase/instance1`
+
+    slider resolve --path /users/hbase/services/org-apache-hbase/instance1
+
+*Example*: resolve the record at `/users/hbase/services/org-apache-hbase/instance1`
+and save it to a file
+
+    slider resolve --path /users/hbase/services/org-apache-hbase/instance1 --out hbase.json
+
+If the specified path is not in the registry, or the path exists but there
+is no service record there, the return code is `EXIT_NOT_FOUND`, 77.
+
+### List all services under a path: `slider resolve --path <path> --list`
+
+`slider resolve --path <path> --list` command will list all service records
+directly under a path. The listing can be displayed in the console, or saved
+to a directory, one JSON file per entry. The `--destdir` option enables
+this saving of the entries —and identifies the destination directory for them.
+Each entry will be saved with the entry name suffixed by `.json`.
+
+It is an error if the path does not exist; the exit code will be `EXIT_NOT_FOUND`, 77.
+
+It is *not* an error if the path does exist but there are no records underneath
+it.
+
+*Example*: list services under `/users/hbase/services/org-apache-hbase/`
+
+    slider resolve --path /users/hbase/services/org-apache-hbase/ --list
+
+This will list all services deployed under this path. If a service `"hbase-1"`
+had been deployed, it would be printed.
+
+
+*Example*: list services under `/users/hbase/services/org-apache-hbase/` and
+save the results
+
+    slider resolve --path /users/hbase/services/org-apache-hbase/ --list --destdir services
+
+This will create a directory `services` and save service records to it. 
+If a service `"hbase-1"` was registered a under this path, its service record
+would be saved to the file `services/hbase-1.json`.
+
+
 
 ### `start <name> [--wait time`]
 (**start** used to be **thaw** in develop branch)