mirror_corosync/man/corosync.8
Christoph Berg 7162e75dcf Man: Move overview mp to sections 3 and 7 from 8
The _overview manpages are not actually commands and hence do not belong
into manpage section 8. Move corosync_overview to section 7
("Miscellaneous") and the other *_overview pages to section 3 as they
contain API documentation (cf. string(3) for precedence of
multi-function manpages).

Signed-off-by: Christoph Berg <myon@debian.org>
Reviewed-by: Jan Friesse <jfriesse@redhat.com>
2018-01-30 13:42:10 +01:00

85 lines
2.9 KiB
Groff

.\"/*
.\" * Copyright (C) 2010-2017 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Angus Salkeld <asalkeld@redhat.com>
.\" *
.\" * This software licensed under BSD license, the text of which follows:
.\" *
.\" * Redistribution and use in source and binary forms, with or without
.\" * modification, are permitted provided that the following conditions are met:
.\" *
.\" * - Redistributions of source code must retain the above copyright notice,
.\" * this list of conditions and the following disclaimer.
.\" * - Redistributions in binary form must reproduce the above copyright notice,
.\" * this list of conditions and the following disclaimer in the documentation
.\" * and/or other materials provided with the distribution.
.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its
.\" * contributors may be used to endorse or promote products derived from this
.\" * software without specific prior written permission.
.\" *
.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" * THE POSSIBILITY OF SUCH DAMAGE.
.\" */
.TH COROSYNC 8 2017-07-07
.SH NAME
corosync \- The Corosync Cluster Engine.
.SH SYNOPSIS
.B "corosync [\-f] [\-P num] [\-p] [\-r] [-R] [\-t] [\-v]"
.SH DESCRIPTION
.B corosync
Corosync provides clustering infrastructure such as membership, messaging and quorum.
.SH OPTIONS
.TP
.B -f
Start application in foreground.
.TP
.B -p
Do not set realtime scheduling.
.TP
.B -P
Set priority of process. Has effect only when
.B -r
is not used. Can be ether numeric value with similar meaning as
.BR nice (1)
or
.B max
/
.B min
meaning maximal / minimal priority (so minimal / maximal nice value).
.TP
.B -r
Set round robin realtime scheduling with maximal priority (default). When setting
of scheduler fails, fallback to set maximal priority.
.TP
.B -R
Do not try to move Corosync to root cpu cgroup. This feature is available only
for corosync with libcgroup enabled during the build.
.TP
.B -t
Test configuration and then exit.
.TP
.B -v
Display version and SVN revision of Corosync and exit.
.SH SEE ALSO
.BR corosync_overview (7),
.BR corosync.conf (5),
.BR cpg_overview (3),
.BR votequorum_overview (3),
.BR sam_overview (3),
.BR cmap_overview (3),
.BR quorum_overview (3)
.SH AUTHOR
Angus Salkeld
.PP