diff options
author | Pete Zaitcev <zaitcev@kotori.zaitcev.us> | 2013-05-21 15:34:21 -0600 |
---|---|---|
committer | Pete Zaitcev <zaitcev@kotori.zaitcev.us> | 2013-05-21 15:34:21 -0600 |
commit | 07311a0639ba06d2b2ed190dc49095df95ae669b (patch) | |
tree | d03dab6c3cc04b52db84049d83cf660ae23ad9d0 | |
parent | d5b6d29a30ec806e5aa8af17ad5b8e6cc2b9fbf1 (diff) | |
download | python-swiftclient-07311a0639ba06d2b2ed190dc49095df95ae669b.tar.gz |
Update the man page
- Add -V option
- Use uniform and correct capitalization for OpenStack Swift
- Make the example of output of stat command up-to-date
- Generally prettify the document
- Remove all trailing whitespace
Change-Id: Id3da2035851847c4bff8cec8f927d3654824bf5b
-rw-r--r-- | doc/manpages/swift.1 | 66 |
1 files changed, 32 insertions, 34 deletions
diff --git a/doc/manpages/swift.1 b/doc/manpages/swift.1 index 42291fa..71530e9 100644 --- a/doc/manpages/swift.1 +++ b/doc/manpages/swift.1 @@ -14,46 +14,49 @@ .\" implied. .\" See the License for the specific language governing permissions and .\" limitations under the License. -.\" +.\" .TH swift 1 "8/26/2011" "Linux" "OpenStack Swift" -.SH NAME +.SH NAME .LP .B swift -\- Openstack-swift swift tool +\- OpenStack Swift client tool .SH SYNOPSIS .LP .B swift [options] <command> [args] -.SH DESCRIPTION +.SH DESCRIPTION .PP -The swift tool is a command line interface script for communicating with -an openstack-swift object storage environment. It allows one to perform +The \fBswift\fR tool is a command line utility for communicating with +an OpenStack Object Storage (Swift) environment. It allows one to perform several types of operations. .SH COMMANDS -.PP +.PP \fBstat\fR [\fIcontainer\fR] [\fIobject\fR] .RS 4 Displays information for the account, container, or object depending on the args given (if any). +In verbose mode, the Storage URL and the authentication token are displayed +as well. .RE \fBlist\fR [\fIcommand-options\fR] [\fIcontainer\fR] .RS 4 -Lists the containers for the account or the objects for a container. The -p or --prefix is an option that will only list items beginning -with that prefix. The -d or --delimiter is option (for container listings only) -that will roll up items with the given delimiter (see Cloud Files general +Lists the containers for the account or the objects for a container. +The -p or --prefix is an option that will only list items beginning +with that prefix. The -d or --delimiter is option (for container listings only) +that will roll up items with the given delimiter (see Cloud Files general documentation for what this means). -.RE +.RE \fBupload\fR [\fIcommand-options\fR] container file_or_directory [\fIfile_or_directory\fR] [...] .RS 4 -Uploads to the given container the files and directories specified by the -remaining args. The -c or --changed is an option that will only upload files -that have changed since the last upload. The -S <size> or --segment-size <size> +Uploads to the given container the files and directories specified by the +remaining args. The -c or --changed is an option that will only upload files +that have changed since the last upload. The -S <size> or --segment-size <size> and --leave-segments are options as well (see --help for more). .RE @@ -61,13 +64,12 @@ and --leave-segments are options as well (see --help for more). .RS 4 Updates meta information for the account, container, or object depending on the args given. If the container is not found, it will be created -automatically; but this is not true for accounts and objects. Containers +automatically; but this is not true for accounts and objects. Containers also allow the -r (or --read-acl) and -w (or --write-acl) options. The -m or --meta option is allowed on all and used to define the user meta data -items to set in the form Name:Value. This option can be repeated. +items to set in the form Name:Value. This option can be repeated. \fBExample\fR: post -m Color:Blue -m Size:Large -.RE - +.RE \fBdownload\fR [\fIcommand-options\fR] [\fIcontainer\fR] [\fIobject\fR] [\fIobject\fR] [...] .RS 4 @@ -84,11 +86,11 @@ Deletes everything in the account (with --all), or everything in a container, or a list of objects depending on the args given. Segments of manifest objects will be deleted as well, unless you specify the --leave-segments option. -.RE +.RE .SH OPTIONS -.PD 0 +.PD 0 .IP "--version Show program's version number and exit" .IP "-h, --help Show this help message and exit" .IP "-s, --snet Use SERVICENET internal network" @@ -96,33 +98,29 @@ will be deleted as well, unless you specify the --leave-segments option. .IP "-q, --quiet Suppress status output" .IP "-A AUTH, --auth=AUTH URL for obtaining an auth token " .IP "-U USER, --user=USER User name for obtaining an auth token" +.IP "-V 1|2 Authentication protocol version" .IP "-K KEY, --key=KEY Key for obtaining an auth token" -.PD +.PD .SH EXAMPLE -.PP +.PP swift -A https://127.0.0.1:443/auth/v1.0 -U swiftops:swiftops -K swiftops stat .RS 2 -.PD 0 -.IP "Account: AUTH_43b42dae-dc0b-4a4b-ac55-97de614d6e6e" +.PD 0 +.IP " Account: AUTH_43b42dae-dc0b-4a4b-ac55-97de614d6e6e" .IP "Containers: 1" -.IP "Objects: 1" -.IP "Bytes: 1124" +.IP " Objects: 1" +.IP " Bytes: 1124" .IP "Accept-Ranges: bytes" .IP "X-Trans-Id: txb21186a9eef64ed295a1e95896a0fc72" -.PD -.RE +.PD +.RE - .SH DOCUMENTATION .LP -More in depth documentation about Openstack-Swift as a whole can be found at +More in depth documentation about OpenStack Swift as a whole can be found at .BI http://swift.openstack.org - - -.LP - |