swift/doc/manpages/swift-container-info.1
Alistair Coles 721cd1634a Show file parameters as mandatory in swift-*-info man pages
Changes the file parameters on command line to use the convention of
<file> for a mandatory option rather than [file] which suggests an
optional flag. Also drop to lower case as is convention in other man
pages.

Change-Id: Icfb4b4786343eb493a73b092cad1fdadc935d066
2016-11-11 16:34:15 +00:00

75 lines
2.0 KiB
Groff

.\"
.\" Author: Madhuri Kumari <madhuri.rai07@gmail.com>
.\" Copyright (c) 2010-2011 OpenStack Foundation.
.\"
.\" Licensed under the Apache License, Version 2.0 (the "License");
.\" you may not use this file except in compliance with the License.
.\" You may obtain a copy of the License at
.\"
.\" http://www.apache.org/licenses/LICENSE-2.0
.\"
.\" Unless required by applicable law or agreed to in writing, software
.\" distributed under the License is distributed on an "AS IS" BASIS,
.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
.\" implied.
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
.\"
.TH swift-container-info 1 "10/25/2016" "Linux" "OpenStack Swift"
.SH NAME
.LP
.B swift-container-info
\- OpenStack Swift container-info tool
.SH SYNOPSIS
.LP
.B swift-container-info
<container_db_file> [options]
.SH DESCRIPTION
.PP
This is a very simple swift tool that allows a swiftop engineer to retrieve
information about a container that is located on the storage node.
One calls the tool with a given container db file as
it is stored on the storage node system.
It will then return several information about that container such as;
.PD 0
.IP "- Account it belongs to"
.IP "- Container "
.IP "- Created timestamp "
.IP "- Put timestamp "
.IP "- Delete timestamp "
.IP "- Object count "
.IP "- Bytes used "
.IP "- Reported put timestamp "
.IP "- Reported delete timestamp "
.IP "- Reported object count "
.IP "- Reported bytes used "
.IP "- Hash "
.IP "- ID "
.IP "- User metadata "
.IP "- X-Container-Sync-Point 1 "
.IP "- X-Container-Sync-Point 2 "
.IP "- Location on the ring "
.PD
.SH OPTIONS
.TP
\fB\-h, --help \fR
Shows the help message and exit
.TP
\fB\-d SWIFT_DIR, --swift-dir=SWIFT_DIR\fR
Pass location of swift configuration file if different from the default
location /etc/swift
.SH DOCUMENTATION
.LP
More documentation about OpenStack Swift can be found at
.BI http://swift.openstack.org/index.html
.SH "SEE ALSO"
.BR swift-get-nodes(1),
.BR swift-object-info(1)