summaryrefslogtreecommitdiff
path: root/doc/manpages/swift-proxy-server.1
diff options
context:
space:
mode:
authorMarcelo Martins <btorch@gmail.com>2011-10-12 13:23:13 -0500
committerMarcelo Martins <btorch@gmail.com>2011-11-08 21:09:42 -0600
commit0b0785e984d9164c1d1cd84f05dd9909bb7d37a8 (patch)
tree87757674a903754e5f0c583a1bd14fb7b4609f0c /doc/manpages/swift-proxy-server.1
parent3b8e20d05944483a0ce21f2dc5d05e32098cb508 (diff)
downloadswift-0b0785e984d9164c1d1cd84f05dd9909bb7d37a8.tar.gz
changing config files to be on section 5 and also running spellchecks against all files
"Also adding the new swift-recon and swift-ring-builder manpages to this set" "Adding new manpages for configuration files and also making changes according to previous review suggestions" "removing the Author line from the manpages according to suggestions" Change-Id: I256d2b2851b55a379b59011894f214bf55ba7da9
Diffstat (limited to 'doc/manpages/swift-proxy-server.1')
-rw-r--r--doc/manpages/swift-proxy-server.158
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/manpages/swift-proxy-server.1 b/doc/manpages/swift-proxy-server.1
new file mode 100644
index 000000000..5533e7b53
--- /dev/null
+++ b/doc/manpages/swift-proxy-server.1
@@ -0,0 +1,58 @@
+.\"
+.\" Author: Joao Marcelo Martins <marcelo.martins@rackspace.com> or <btorch@gmail.com>
+.\" Copyright (c) 2010-2011 OpenStack, LLC.
+.\"
+.\" 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-proxy-server 1 "8/26/2011" "Linux" "OpenStack Swift"
+
+.SH NAME
+.LP
+.B swift-proxy-server
+\- Openstack-swift proxy server.
+
+.SH SYNOPSIS
+.LP
+.B swift-proxy-server
+[CONFIG] [-h|--help] [-v|--verbose]
+
+.SH DESCRIPTION
+.PP
+The Swift Proxy Server is responsible for tying together the rest of the Swift architecture.
+For each request, it will look up the location of the account, container, or object in the
+ring and route the request accordingly. The public API is also exposed through the Proxy
+Server. A large number of failures are also handled in the Proxy Server. For example,
+if a server is unavailable for an object PUT, it will ask the ring for a handoff server
+and route there instead. When objects are streamed to or from an object server, they are
+streamed directly through the proxy server to or from the user the proxy server does
+not spool them.
+
+.SH DOCUMENTATION
+.LP
+More in depth documentation in regards to
+.BI swift-proxy-server
+and also about Openstack-Swift as a whole can be found at
+.BI http://swift.openstack.org/index.html
+
+.\" One may need to change the path below if
+.SH FILES
+.IP "\fI/usr/share/doc/swift-proxy/proxy-server.conf-sample\fR" 0
+Sample configuration file for swift-proxy services
+.IP "\fI/etc/init.d/swift-proxy\fR" 0
+Proxy server init.d script
+
+
+
+.SH "SEE ALSO"
+.BR proxy-server.conf(5)