swift/doc/manpages/swift-orphans.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

71 lines
1.9 KiB
Groff

.\"
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
.\" Copyright (c) 2012 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-orphans 1 "3/15/2012" "Linux" "OpenStack Swift"
.SH NAME
.LP
.B swift-orphans
\- OpenStack Swift orphans tool
.SH SYNOPSIS
.LP
.B swift-orphans
[-h|--help] [-a|--age] [-k|--kill] [-w|--wide] [-r|--run-dir]
.SH DESCRIPTION
.PP
Lists and optionally kills orphaned Swift processes. This is done by scanning
/var/run/swift or the directory specified to the \-r switch for .pid files and
listing any processes that look like Swift processes but aren't associated with
the pids in those .pid files. Any Swift processes running with the 'once'
parameter are ignored, as those are usually for full-speed audit scans and
such.
Example (sends SIGTERM to all orphaned Swift processes older than two hours):
swift-orphans \-a 2 \-k TERM
The options are as follows:
.RS 4
.PD 0
.IP "-a HOURS"
.IP "--age=HOURS"
.RS 4
.IP "Look for processes at least HOURS old; default: 24"
.RE
.IP "-k SIGNAL"
.IP "--kill=SIGNAL"
.RS 4
.IP "Send SIGNAL to matched processes; default: just list process information"
.RE
.IP "-w"
.IP "--wide"
.RS 4
.IP "Don't clip the listing at 80 characters"
.RE
.PD
.RE
.SH DOCUMENTATION
.LP
More documentation about OpenStack Swift can be found at
.BI https://docs.openstack.org/swift/latest/