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
		
			
				
	
	
		
			71 lines
		
	
	
		
			1.7 KiB
		
	
	
	
		
			Groff
		
	
	
	
	
	
			
		
		
	
	
			71 lines
		
	
	
		
			1.7 KiB
		
	
	
	
		
			Groff
		
	
	
	
	
	
.\"
 | 
						|
.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
 | 
						|
.\" Copyright (c) 2010-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-object-auditor 1 "8/26/2011" "Linux" "OpenStack Swift"
 | 
						|
 | 
						|
.SH NAME
 | 
						|
.LP
 | 
						|
.B swift-object-auditor
 | 
						|
\- OpenStack Swift object auditor
 | 
						|
 | 
						|
.SH SYNOPSIS
 | 
						|
.LP
 | 
						|
.B swift-object-auditor
 | 
						|
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once] [-z|--zero_byte_fps]
 | 
						|
 | 
						|
.SH DESCRIPTION
 | 
						|
.PP
 | 
						|
The object auditor crawls the local object system checking the integrity of objects.
 | 
						|
If corruption is found (in the case of bit rot, for example), the file is
 | 
						|
quarantined, and replication will replace the bad file from another replica.
 | 
						|
 | 
						|
The options are as follows:
 | 
						|
 | 
						|
.RS 4
 | 
						|
.PD 0
 | 
						|
.IP "-v"
 | 
						|
.IP "--verbose"
 | 
						|
.RS 4
 | 
						|
.IP "log to console"
 | 
						|
.RE
 | 
						|
 | 
						|
.IP "-o"
 | 
						|
.IP "--once"
 | 
						|
.RS 4
 | 
						|
.IP "only run one pass of daemon"
 | 
						|
.RE
 | 
						|
 | 
						|
.IP "-z ZERO_BYTE_FPS"
 | 
						|
.IP "--zero_byte_fps=ZERO_BYTE_FPS"
 | 
						|
.RS 4
 | 
						|
.IP "Audit only zero byte files at specified files/sec"
 | 
						|
.RE
 | 
						|
.PD
 | 
						|
.RE
 | 
						|
 | 
						|
 | 
						|
.SH DOCUMENTATION
 | 
						|
.LP
 | 
						|
More in depth documentation in regards to
 | 
						|
.BI swift-object-auditor
 | 
						|
and also about OpenStack Swift as a whole can be found at
 | 
						|
.BI https://docs.openstack.org/swift/latest/
 | 
						|
 | 
						|
 | 
						|
.SH "SEE ALSO"
 | 
						|
.BR object-server.conf(5)
 |