openstack/python-swiftclient
Code Issues Proposed changes

Update the man page

Browse Source 
- 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
This commit is contained in:
Pete Zaitcev
2013-05-21 15:34:21 -06:00
parent d5b6d29a30
commit 07311a0639
1 changed files with 32 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/manpages/swift.1
View File

@@ -20,7 +20,7 @@
.SH NAME
.LP
.B swift
\- Openstack-swift swift tool
\- OpenStack Swift client tool
.SH SYNOPSIS
.LP
@@ -29,8 +29,8 @@
.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
@@ -39,11 +39,14 @@ several types of operations.
\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
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).
@@ -68,7 +71,6 @@ items to set in the form Name:Value. This option can be repeated.
\fBExample\fR: post -m Color:Blue -m Size:Large
.RE
\fBdownload\fR [\fIcommand-options\fR] [\fIcontainer\fR] [\fIobject\fR] [\fIobject\fR] [...]
.RS 4
Downloads everything in the account (with --all), or everything in a
@@ -96,6 +98,7 @@ 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
@@ -107,22 +110,17 @@ 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"
.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
.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