5403N/ASection renumbering and more consistent use of .BR. Add language
5403N/Adescribing use of SMF. Fix a few small errors. Some of this is obviously
5403N/ASolaris-specific, but the rest could be submitted upstream.
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-\- configuration file for the openstack-swift account server
+\- configuration file for the OpenStack Swift account server
@@ -245,13 +245,13 @@ Connection timeout to external services.
More in depth documentation about the swift-account-server and
-also Openstack-Swift as a whole can be found at
+also OpenStack Swift as a whole can be found at
-.BR swift-account-server(1),
+.BR swift-account-server (1)
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-\- configuration file for the openstack-swift container server
+\- configuration file for the OpenStack Swift container server
@@ -270,13 +270,13 @@ Maximum amount of time to spend syncing
More in depth documentation about the swift-container-server and
-also Openstack-Swift as a whole can be found at
+also OpenStack Swift as a whole can be found at
-.BR swift-container-server(1),
+.BR swift-container-server (1)
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-\- configuration file for the openstack-swift dispersion tools
+\- configuration file for the OpenStack Swift dispersion tools
-Location of openstack-swift configuration and ring files
+Location of OpenStack Swift configuration and ring files
.IP "\fBdispersion_coverage\fR"
Percentage of partition coverage to use. The default is 1.
@@ -80,13 +80,13 @@ Whether to run the object report. The de
More in depth documentation about the swift-dispersion utilities and
-also Openstack-Swift as a whole can be found at
+also OpenStack Swift as a whole can be found at
-.BR swift-dispersion-report(1),
-.BR swift-dispersion-populate(1)
+.BR swift-dispersion-report (1),
+.BR swift-dispersion-populate (1)
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-\- configuration file for the openstack-swift object exprier daemon
+\- configuration file for the OpenStack Swift object exprier daemon
@@ -133,12 +133,12 @@ The default is \fBegg:swift#catch_errors
More in depth documentation about the swift-object-expirer and
-also Openstack-Swift as a whole can be found at
+also OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-\- configuration file for the openstack-swift object server
+\- configuration file for the OpenStack Swift object server
@@ -262,13 +262,13 @@ The default is 50.
More in depth documentation about the swift-object-server and
-also Openstack-Swift as a whole can be found at
+also OpenStack Swift as a whole can be found at
-.BR swift-object-server(1),
+.BR swift-object-server (1)
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-\- configuration file for the openstack-swift proxy server
+\- configuration file for the OpenStack Swift proxy server
@@ -539,10 +539,10 @@ per second. The default is 1.
More in depth documentation about the swift-proxy-server and
-also Openstack-Swift as a whole can be found at
+also OpenStack Swift as a whole can be found at
-.BR swift-proxy-server(1)
+.BR swift-proxy-server (1)
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-account-auditor 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-account-auditor 1 "8/26/2011" "OpenStack" "OpenStack Swift"
-\- Openstack-swift account auditor
+\- OpenStack Swift account auditor
-.B swift-account-auditor
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
@@ -50,13 +50,25 @@ The options are as follows:
+The account auditor should be enabled and disabled using the Solaris
+Service Management Facility, \fBsmf\fR(5). The service FMRI for the
More in depth documentation in regards to
.BI swift-account-auditor
-and also about Openstack-Swift as a whole can be found at
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-account-reaper 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-account-reaper 1 "8/26/2011" "OpenStack" "OpenStack Swift"
-\- Openstack-swift account reaper
+\- OpenStack Swift account reaper
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
@@ -56,14 +56,25 @@ The options are as follows:
+The account reaper should be enabled and disabled using the Solaris Service
+Management Facility, \fBsmf\fR(5). The service FMRI for the account reaper
More in depth documentation in regards to
-.BI swift-object-auditor
-and also about Openstack-Swift as a whole can be found at
+.BI swift-account-reaper
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-account-replicator 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-account-replicator 1 "8/26/2011" "OpenStack" "OpenStack Swift"
.B swift-account-replicator
-\- Openstack-swift account replicator
+\- OpenStack Swift account replicator
-.B swift-account-replicator
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
@@ -58,14 +58,25 @@ The options are as follows:
+The account replicator should be enabled and disabled using the Solaris
+Service Management Facility, \fBsmf\fR(5). The service FMRI for the
More in depth documentation in regards to
.BI swift-account-replicator
-and also about Openstack-Swift as a whole can be found at
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-account-server 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-account-server 1 "8/26/2011" "OpenStack" "OpenStack Swift"
-\- Openstack-swift account server
+\- OpenStack Swift account server
[CONFIG] [-h|--help] [-v|--verbose]
@@ -33,15 +33,26 @@ The Account Server's primary job is to h
are stored as sqlite database files, and replicated across the cluster similar to how
+The account server should be enabled and disabled using the Solaris Service
+Management Facility, \fBsmf\fR(5). The service FMRI for the account server
More in depth documentation in regards to
-and also about Openstack-Swift as a whole can be found at
+and also about Openstack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-container-auditor 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-container-auditor 1 "8/26/2011" "OpenStack" "OpenStack Swift"
.B swift-container-auditor
-\- Openstack-swift container auditor
+\- OpenStack Swift container auditor
-.B swift-container-auditor
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
@@ -50,15 +50,26 @@ The options are as follows:
+The container auditor should be enabled and disabled using the Solaris
+Service Management Facility, \fBsmf\fR(5). The service FMRI for the
More in depth documentation in regards to
.BI swift-container-auditor
-and also about Openstack-Swift as a whole can be found at
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-container-replicator 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-container-replicator 1 "8/26/2011" "OpenStack" "OpenStack Swift"
.B swift-container-replicator
-\- Openstack-swift container replicator
+\- OpenStack Swift container replicator
-.B swift-container-replicator
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
@@ -57,15 +57,26 @@ The options are as follows:
+The container replicator should be enabled and disabled using the Solaris
+Service Management Facility, \fBsmf\fR(5). The service FMRI for the
+container replicator is:
More in depth documentation in regards to
.BI swift-container-replicator
-and also about Openstack-Swift as a whole can be found at
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-container-server 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-container-server 1 "8/26/2011" "OpenStack" "OpenStack Swift"
.B swift-container-server
-\- Openstack-swift container server
+\- OpenStack Swift container server
-.B swift-container-server
[CONFIG] [-h|--help] [-v|--verbose]
@@ -35,11 +35,22 @@ are stored as sqlite database files, and
objects are. Statistics are also tracked that include the total number of objects, and
total storage usage for that container.
+The container server should be enabled and disabled using the Solaris
+Service Management Facility, \fBsmf\fR(5). The service FMRI for the
More in depth documentation in regards to
.BI swift-container-server
-and also about Openstack-Swift as a whole can be found at
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-container-sync 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-container-sync 1 "8/26/2011" "OpenStack" "OpenStack Swift"
-\- Openstack-swift container sync
+\- OpenStack Swift container sync
@@ -44,7 +44,7 @@ newer rows since the last sync will trig
More in depth documentation in regards to
-and also about Openstack-Swift as a whole can be found at
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-container-updater 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-container-updater 1 "8/26/2011" "OpenStack" "OpenStack Swift"
.B swift-container-updater
-\- Openstack-swift container updater
+\- OpenStack Swift container updater
-.B swift-container-updater
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
@@ -59,14 +59,26 @@ The options are as follows:
+The container updater should be enabled and disabled using the Solaris
+Service Management Facility, \fBsmf\fR(5). The service FMRI for the
More in depth documentation in regards to
.BI swift-container-updater
-and also about Openstack-Swift as a whole can be found at
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-dispersion-populate 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-dispersion-populate 1 "8/26/2011" "OpenStack" "OpenStack Swift"
.B swift-dispersion-populate
-\- Openstack-swift dispersion populate
+\- OpenStack Swift dispersion populate
More in depth documentation about the swift-dispersion utilities and
-also Openstack-Swift as a whole can be found at
+also OpenStack Swift as a whole can be found at
-.BR swift-dispersion-report(1),
+.BR swift-dispersion-report (1),
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-dispersion-report 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-dispersion-report 1 "8/26/2011" "OpenStack" "OpenStack Swift"
.B swift-dispersion-report
-\- Openstack-swift dispersion report
+\- OpenStack Swift dispersion report
More in depth documentation about the swift-dispersion utilities and
-also Openstack-Swift as a whole can be found at
+also OpenStack Swift as a whole can be found at
-.BR swift-dispersion-populate(1),
+.BR swift-dispersion-populate (1),
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-get-nodes 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-get-nodes 1 "8/26/2011" "OpenStack" "OpenStack Swift"
-\- Openstack-swift get-nodes tool
+\- OpenStack Swift get-nodes tool
@@ -72,11 +72,11 @@ where the container resides by using the
-More documentation about Openstack-Swift can be found at
+More documentation about OpenStack Swift can be found at
-.BR swift-object-info(1),
-.BR swift-ring-builder(1)
+.BR swift-object-info (1),
+.BR swift-ring-builder (1)
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-init 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-init 1 "8/26/2011" "OpenStack" "OpenStack Swift"
-\- Openstack-swift swift-init tool
+\- Openstack Swift swift-init tool
- <server> [<server> ...] <command> [options]
+<server> [<server> ...] <command> [options]
+The suite of servers implementing OpenStack Swift should be managed using
+the Solaris Service Management Facility, \fBsmf\fR(5). There are sixteen
+Each service is described more completely in its corresponding manual page.
+Note that there are no dependencies between the services, although most of
+them should be started in groups, even if the entire suite isn't necessary.
+Although the \fBswift-init\fR tool can be used to manage the services,
+doing so is not supported on Solaris.
The swift-init tool can be used to initialize all swift daemons available as part of
-openstack-swift. Instead of calling individual init scripts for each
+OpenStack Swift. Instead of calling individual init scripts for each
swift daemon, one can just use swift-init. With swift-init you can initialize
just one swift service, such as the "proxy", or a combination of them. The tool also
allows one to use the keywords such as "all", "main" and "rest" for the <server> argument.
@@ -116,8 +148,26 @@ allows one to use the keywords such as "
-More documentation about Openstack-Swift can be found at
+More documentation about OpenStack Swift can be found at
+.BR swift-account-auditor (1),
+.BR swift-account-reaper (1),
+.BR swift-account-replicator (1),
+.BR swift-account-server (1),
+.BR swift-container-auditor (1),
+.BR swift-container-replicator (1),
+.BR swift-container-server (1),
+.BR swift-container-sync (1),
+.BR swift-container-updater
+.BR swift-object-auditor (1),
+.BR swift-object-expirer (1),
+.BR swift-object-replicator (1),
+.BR swift-object-server (1),
+.BR swift-object-updater (1),
+.BR swift-proxy-server (1),
+.BR swift-replicator-rsync (1),
.\" 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"
+.TH swift-object-auditor 1 "8/26/2011" "OpenStack" "OpenStack Swift"
-\- Openstack-swift object auditor
+\- OpenStack Swift object auditor
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once] [-z|--zero_byte_fps]
@@ -56,15 +56,26 @@ The options are as follows:
+The object auditor should be enabled and disabled using the Solaris Service
+Management Facility, \fBsmf\fR(5). The service FMRI for the object auditor
More in depth documentation in regards to
-and also about Openstack-Swift as a whole can be found at
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-object-expirer 1 "3/15/2012" "Linux" "OpenStack Swift"
+.TH swift-object-expirer 1 "3/15/2012" "OpenStack" "OpenStack Swift"
-\- Openstack-swift object expirer
+\- OpenStack Swift object expirer
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
@@ -57,18 +57,28 @@ The options are as follows:
+The object expirer should be enabled and disabled using the Solaris Service
+Management Facility, \fBsmf\fR(5). The service FMRI for the object expirer
More in depth documentation in regards to
-and also about Openstack-Swift as a whole can be found at
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-object-info 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-object-info 1 "8/26/2011" "OpenStack" "OpenStack Swift"
-\- Openstack-swift object-info tool
+\- OpenStack Swift object-info tool
@@ -48,8 +48,8 @@ It will then return several information
-More documentation about Openstack-Swift can be found at
+More documentation about OpenStack Swift can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-object-replicator 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-object-replicator 1 "8/26/2011" "OpenStack" "OpenStack Swift"
.B swift-object-replicator
-\- Openstack-swift object replicator
+\- OpenStack Swift object replicator
-.B swift-object-replicator
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
@@ -57,15 +57,26 @@ The options are as follows:
+The object replicator should be enabled and disabled using the Solaris
+Service Management Facility, \fBsmf\fR(5). The service FMRI for the object
More in depth documentation in regards to
.BI swift-object-replicator
-and also about Openstack-Swift as a whole can be found at
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-object-server 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-object-server 1 "8/26/2011" "OpenStack" "OpenStack Swift"
-\- Openstack-swift object server.
+\- OpenStack Swift object server.
[CONFIG] [-h|--help] [-v|--verbose]
@@ -40,15 +40,27 @@ served. A deletion is also treated as a
".ts", which stands for tombstone). This ensures that deleted files are replicated
correctly and older versions don't magically reappear due to failure scenarios.
+The object server should be enabled and disabled using the Solaris Service
+Management Facility, \fBsmf\fR(5). The service FMRI for the object server
More in depth documentation in regards to
-and also about Openstack-Swift as a whole can be found at
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-object-updater 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-object-updater 1 "8/26/2011" "OpenStack" "OpenStack Swift"
-\- Openstack-swift object updater
+\- OpenStack Swift object updater
[CONFIG] [-h|--help] [-v|--verbose] [-o|--once]
@@ -64,15 +64,26 @@ The options are as follows:
+The object updater should be enabled and disabled using the Solaris Service
+Management Facility, \fBsmf\fR(5). The service FMRI for the object updater
More in depth documentation in regards to
-and also about Openstack-Swift as a whole can be found at
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-orphans 1 "3/15/2012" "Linux" "OpenStack Swift"
+.TH swift-orphans 1 "3/15/2012" "OpenStack" "OpenStack Swift"
-\- Openstack-swift orphans tool
+\- OpenStack Swift orphans tool
@@ -65,6 +65,6 @@ The options are as follows:
-More documentation about Openstack-Swift can be found at
+More documentation about OpenStack Swift can be found at
.\" 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"
+.TH swift-proxy-server 1 "8/26/2011" "OpenStack" "OpenStack Swift"
-\- Openstack-swift proxy server.
+\- OpenStack Swift proxy server.
[CONFIG] [-h|--help] [-v|--verbose]
@@ -38,13 +38,25 @@ and route there instead. When objects ar
streamed directly through the proxy server to or from the user the proxy server does
+The proxy server should be enabled and disabled using the Solaris Service
+Management Facility, \fBsmf\fR(5). The service FMRI for the proxy server
More in depth documentation in regards to
-and also about Openstack-Swift as a whole can be found at
+and also about OpenStack Swift as a whole can be found at
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-recon 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-recon 1 "8/26/2011" "OpenStack" "OpenStack Swift"
-\- Openstack-swift recon middleware cli tool
+\- OpenStack Swift recon middleware cli tool
@@ -104,7 +104,7 @@ cronjob to run the swift-recon-cron scri
-More documentation about Openstack-Swift can be found at
+More documentation about OpenStack Swift can be found at
Also more specific documentation about swift-recon can be found at
@@ -112,6 +112,6 @@ Also more specific documentation about s
.\" See the License for the specific language governing permissions and
.\" limitations under the License.
-.TH swift-ring-builder 1 "8/26/2011" "Linux" "OpenStack Swift"
+.TH swift-ring-builder 1 "8/26/2011" "OpenStack" "OpenStack Swift"
-\- Openstack-swift ring builder
+\- OpenStack Swift ring builder
@@ -208,7 +208,7 @@ calls when no rebalance is needed but yo
-More in depth documentation about the swift ring and also Openstack-Swift as a
+More in depth documentation about the swift ring and also OpenStack Swift as a