swift/doc/manpages/swift-object-info.1
junboli 6998d804ff doc migration: update the doc link address[1/3]
Update the doc link brought by the swift doc migration.
Although we had some effort to fix these before, it still left lots
of bad doc link, I separate these changes into 3 patches aim to fix
all of these, this is the 1st patch for doc/manpages.

Change-Id: Ib49696706e61bbd36ae56b15b1d94aa4ce84531c
2017-09-05 19:13:47 +00:00

74 lines
2.0 KiB
Groff

.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@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-object-info 1 "10/25/2016" "Linux" "OpenStack Swift"
.SH NAME
.LP
.B swift-object-info
\- OpenStack Swift object-info tool
.SH SYNOPSIS
.LP
.B swift-object-info
<object_file> [options]
.SH DESCRIPTION
.PP
This is a very simple swift tool that allows a swiftop engineer to retrieve
information about an object that is located on the storage node. One calls
the tool with a given object file as it is stored on the storage node system.
It will then return several information about that object such as;
.PD 0
.IP "- Account it belongs to"
.IP "- Container "
.IP "- Object hash "
.IP "- Content Type "
.IP "- timestamp "
.IP "- Etag "
.IP "- Content Length "
.IP "- User Metadata "
.IP "- Location on the ring "
.PD
.SH OPTIONS
.TP
\fB\-h --help \fR
Shows the help message and exit
.TP
\fB\-n, --no-check-etag\fR
Don't verify file contents against stored etag
.TP
\fB\-d SWIFT_DIR, --swift-dir=SWIFT_DIR\fR
Pass location of swift configuration file if different from the default
location /etc/swift
.TP
\fB\-P POLICY_NAME, --policy-name=POLICY_NAME \fR
Specify storage policy name
.SH DOCUMENTATION
.LP
More documentation about OpenStack Swift can be found at
.BI https://docs.openstack.org/swift/latest/
.SH "SEE ALSO"
.BR swift-account-info(1),
.BR swift-container-info(1),
.BR swift-get-nodes(1)