Commit 354c4f62 authored by Michael Hanselmann's avatar Michael Hanselmann

man: Man page reference cleanup

Sphinx is stricter than pandoc when parsing reST and does not allow an
opening parenthesis to directly follow inline markup. [1] describes the
rules. A backslash, as described in [2], can be used to separate the
two.

Additionally, there were different forms for referring to man pages.
Sometimes it was a plain “ganeti(7)”, sometimes “**ganeti**(7)” and
other times “**ganeti(7)**” (of course with different names and
numbers).

Commit 7acbda7b added a new paragraph and used the Sphinx-specific
“:manpage:…” markup, which isn't supported by pandoc. It is replaced
with a standard reference.

[1]
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#
inline-markup-recognition-rules

[2]
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#
character-level-inline-markup
Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
parent f1f6f117
......@@ -8,26 +8,26 @@ or contact the developers using the `Ganeti mailing list
SEE ALSO
--------
Ganeti overview and specifications: **ganeti**(7) (general overview),
**ganeti-os-interface**(7) (guest OS definitions),
**ganeti-extstorage-interface**(7) (external storage providers).
Ganeti commands: **gnt-cluster**(8) (cluster-wide commands),
**gnt-job**(8) (job-related commands), **gnt-node**(8) (node-related
commands), **gnt-instance**(8) (instance commands), **gnt-os**(8) (guest
OS commands), **gnt-storage**(8) (storage commands), **gnt-group**(8)
(node group commands), **gnt-backup**(8) (instance import/export
commands), **gnt-debug**(8) (debug commands).
Ganeti daemons: **ganeti-watcher**(8) (automatic instance restarter),
**ganeti-cleaner**(8) (job queue cleaner), **ganeti-noded**(8) (node
daemon), **ganeti-masterd**(8) (master daemon), **ganeti-rapi**(8)
Ganeti overview and specifications: **ganeti**\(7) (general overview),
**ganeti-os-interface**\(7) (guest OS definitions),
**ganeti-extstorage-interface**\(7) (external storage providers).
Ganeti commands: **gnt-cluster**\(8) (cluster-wide commands),
**gnt-job**\(8) (job-related commands), **gnt-node**\(8) (node-related
commands), **gnt-instance**\(8) (instance commands), **gnt-os**\(8) (guest
OS commands), **gnt-storage**\(8) (storage commands), **gnt-group**\(8)
(node group commands), **gnt-backup**\(8) (instance import/export
commands), **gnt-debug**\(8) (debug commands).
Ganeti daemons: **ganeti-watcher**\(8) (automatic instance restarter),
**ganeti-cleaner**\(8) (job queue cleaner), **ganeti-noded**\(8) (node
daemon), **ganeti-masterd**\(8) (master daemon), **ganeti-rapi**\(8)
(remote API daemon).
Ganeti htools: **htools**(1) (generic binary), **hbal**(1) (cluster
balancer), **hspace**(1) (capacity calculation), **hail**(1) (IAllocator
plugin), **hscan**(1) (data gatherer from remote clusters), **hinfo**(1)
(cluster information printer), **mon-collector**(7) (data collectors
Ganeti htools: **htools**\(1) (generic binary), **hbal**\(1) (cluster
balancer), **hspace**\(1) (capacity calculation), **hail**\(1) (IAllocator
plugin), **hscan**\(1) (data gatherer from remote clusters), **hinfo**\(1)
(cluster information printer), **mon-collector**\(7) (data collectors
interface).
COPYRIGHT
......
......@@ -104,7 +104,7 @@ Upload a script, some auxiliary files and run the script:
SEE ALSO
--------
**dsh**(1), **cssh**(1)
**dsh**\(1), **cssh**\(1)
.. vim: set textwidth=72 :
.. Local Variables:
......
......@@ -19,7 +19,7 @@ node functions in the Ganeti system.
By default, in order to be able to support features such as node
powercycling even on systems with a very damaged root disk,
**ganeti-noded** locks itself in RAM using **mlockall**(2). You can
**ganeti-noded** locks itself in RAM using **mlockall**\(2). You can
disable this feature by passing in the ``--no-mlock`` to the daemon.
For testing purposes, you can give the ``-f`` option and the
......
......@@ -40,7 +40,7 @@ Cluster architecture
In Ganeti 2.0, the architecture of the cluster is a little more
complicated than in 1.2. The cluster is coordinated by a master daemon
(**ganeti-masterd**(8)), running on the master node. Each node runs
(**ganeti-masterd**\(8)), running on the master node. Each node runs
(as before) a node daemon, and the master has the RAPI daemon running
too.
......@@ -408,7 +408,7 @@ Operators:
*!~*
Logically negated from *=~*
*=\**
Globbing, see **glob**(7), though only * and ? are supported
Globbing, see **glob**\(7), though only * and ? are supported
*!\**
Logically negated from *=\**
*in*, *not in*
......@@ -419,7 +419,7 @@ Common daemon functionality
---------------------------
All Ganeti daemons re-open the log file(s) when sent a SIGHUP signal.
**logrotate**(8) can be used to rotate Ganeti's log files.
**logrotate**\(8) can be used to rotate Ganeti's log files.
.. vim: set textwidth=72 :
.. Local Variables:
......
......@@ -54,7 +54,7 @@ execution (and will be stored in the job log). It is recommended
that for any non-zero exit code, the backup is considered invalid,
and retried.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
......@@ -128,7 +128,7 @@ link
in bridged and openvswitch mode specifies the interface to attach
this NIC to, in routed mode it's intended to differentiate between
different routing tables/instance groups (but the meaning is
dependent on the network script in use, see **gnt-cluster**(8) for
dependent on the network script in use, see **gnt-cluster**\(8) for
more details)
Of these ``mode`` and ``link`` are nic parameters, and inherit their
......@@ -210,7 +210,7 @@ value matches the current cluster default and mark it as such
affect the hypervisor, backend and NIC parameters, both read from
the export file and passed in via the command line.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example for identical instance import::
......
......@@ -33,7 +33,7 @@ COMMAND
**command** [-n *node*] [-g *group*] [-M] {*command*}
Executes a command on all nodes. This command is designed for simple
usage. For more complex use cases the commands **dsh(1)** or **cssh(1)**
usage. For more complex use cases the commands **dsh**\(1) or **cssh**\(1)
should be used instead.
If the option ``-n`` is not given, the command will be executed on all
......@@ -293,7 +293,7 @@ The ``-H (--hypervisor-parameters)`` option allows you to set default
hypervisor specific parameters for the cluster. The format of this
option is the name of the hypervisor, followed by a colon and a
comma-separated list of key=value pairs. The keys available for each
hypervisors are detailed in the gnt-instance(8) man page, in the
hypervisors are detailed in the **gnt-instance**\(8) man page, in the
**add** command plus the following parameters which are only
configurable globally (at cluster level):
......@@ -369,7 +369,7 @@ must be specified first, followed by a colon and by a comma-separated
list of key-value pairs. These parameters can only be specified at
cluster and node group level; the cluster-level parameter are inherited
by the node group at the moment of its creation, and can be further
modified at node group level using the **gnt-group**(8) command.
modified at node group level using the **gnt-group**\(8) command.
The following is the list of disk parameters available for the **drbd**
template, with measurement units specified in square brackets at the end
......@@ -470,7 +470,7 @@ htools was not enabled at build time, the default instance allocator
will be blank, which means that relevant operations will require the
administrator to manually specify either an instance allocator, or a
set of nodes. If the option is not specified but htools was enabled,
the default iallocator will be **hail**(1) (assuming it can be found
the default iallocator will be **hail**\(1) (assuming it can be found
on disk). The default iallocator can be changed later using the
**modify** command.
......@@ -480,13 +480,13 @@ IPv6, respectively. This option is used when resolving node names
and the cluster name.
The ``--node-parameters`` option allows you to set default node
parameters for the cluster. Please see **ganeti**(7) for more
parameters for the cluster. Please see **ganeti**\(7) for more
information about supported key=value pairs.
The ``-C (--candidate-pool-size)`` option specifies the
``candidate_pool_size`` cluster parameter. This is the number of nodes
that the master will try to keep as master\_candidates. For more
details about this role and other node roles, see the ganeti(7).
details about this role and other node roles, see the **ganeti**\(7).
The ``--specs-...`` and ``--ipolicy-disk-templates`` options specify
instance policy on the cluster. For the ``--specs-...`` options, each
......@@ -506,7 +506,7 @@ comma-separated list of disk templates.
- ``--ipolicy-disk-templates`` limits the allowed disk templates
For details about how to use ``--hypervisor-state`` and ``--disk-state``
have a look at **ganeti**(7).
have a look at **ganeti**\(7).
MASTER-FAILOVER
~~~~~~~~~~~~~~~
......@@ -588,7 +588,7 @@ The ``--vg-name``, ``--no-lvm-storage``, ``--enabled-hypervisors``,
command.
The ``--hypervisor-state`` and ``--disk-state`` options are described in
detail in **ganeti(7)**.
detail in **ganeti**\(7).
The ``--add-uids`` and ``--remove-uids`` options can be used to
modify the user-id pool by adding/removing a list of user-ids or
......@@ -613,7 +613,7 @@ command. To clear the default iallocator, just pass an empty string
The ``--specs-...`` and ``--ipolicy-disk-templates`` options are
described in the **init** command.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
QUEUE
......@@ -656,7 +656,7 @@ master node to the other nodes in the cluster. This is normally not
needed, but can be run if the **verify** complains about
configuration mismatches.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
RENAME
......@@ -687,10 +687,10 @@ This command will stop all Ganeti daemons in the cluster and start
them again once the new certificates and keys are replicated. The
options ``--new-cluster-certificate`` and ``--new-confd-hmac-key``
can be used to regenerate the cluster-internal SSL certificate
respective the HMAC key used by ganeti-confd(8).
respective the HMAC key used by **ganeti-confd**\(8).
To generate a new self-signed RAPI certificate (used by
ganeti-rapi(8)) specify ``--new-rapi-certificate``. If you want to
**ganeti-rapi**\(8)) specify ``--new-rapi-certificate``. If you want to
use your own certificate, e.g. one signed by a certificate
authority (CA), pass its filename to ``--rapi-certificate``.
......
......@@ -107,7 +107,7 @@ used between the output fields. Both these options are to help
scripting.
The ``-v`` option activates verbose mode, which changes the display of
special field states (see **ganeti(7)**).
special field states (see **ganeti**\(7)).
The ``-o`` option takes a comma-separated list of output fields.
The available fields and their meaning are:
......
......@@ -41,7 +41,7 @@ Creates a new group with the given name. The node group will be
initially empty; to add nodes to it, use ``gnt-group assign-nodes``.
The ``--node-parameters`` option allows you to set default node
parameters for nodes in the group. Please see **ganeti**(7) for more
parameters for nodes in the group. Please see **ganeti**\(7) for more
information about supported key=value pairs and their corresponding
options.
......@@ -64,14 +64,14 @@ preferred
The ``-D (--disk-parameters)`` option allows you to set the disk
parameters for the node group; please see the section about
**gnt-cluster add** in **gnt-cluster**(8) for more information about
**gnt-cluster add** in **gnt-cluster**\(8) for more information about
disk parameters
The ``--specs-...`` and ``--ipol-disk-templates`` options specify
instance policies on the node group, and are documented in the
**gnt-cluster**(8) man page.
**gnt-cluster**\(8) man page.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
ASSIGN-NODES
......@@ -90,7 +90,7 @@ instance is an instance with a mirrored disk template, e.g. DRBD, that
has the primary and secondary nodes in different node groups). You can
force the operation with ``--force``.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
MODIFY
......@@ -114,7 +114,7 @@ Modifies some parameters from the node group.
The ``--node-parameters`` and ``--alloc-policy`` options are documented
in the **add** command above. ``--hypervisor-state`` as well as
``--disk-state`` are documented in detail in **ganeti**(7).
``--disk-state`` are documented in detail in **ganeti**\(7).
The ``--node-parameters``, ``--alloc-policy``, ``-D
(--disk-parameters)`` options are documented in the **add** command
......@@ -122,9 +122,9 @@ above.
The ``--specs-...`` and ``--ipol-disk-templates`` options specify
instance policies on the node group, and are documented in the
**gnt-cluster**(8) man page.
**gnt-cluster**\(8) man page.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
REMOVE
......@@ -135,7 +135,7 @@ REMOVE
Deletes the indicated node group, which must be empty. There must always be at
least one group, so the last group cannot be removed.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
LIST
......@@ -152,7 +152,7 @@ used between the output fields. Both these options are to help
scripting.
The ``-v`` option activates verbose mode, which changes the display of
special field states (see **ganeti(7)**).
special field states (see **ganeti**\(7)).
The ``-o`` option takes a comma-separated list of output fields.
If the value of the option starts with the character ``+``, the new
......@@ -165,7 +165,7 @@ The available fields and their meaning are:
@QUERY_FIELDS_GROUP@
If exactly one argument is given and it appears to be a query filter
(see **ganeti(7)**), the query result is filtered accordingly. For
(see **ganeti**\(7)), the query result is filtered accordingly. For
ambiguous cases (e.g. a single field name as a filter) the ``--filter``
(``-F``) option forces the argument to be treated as a filter.
......@@ -186,7 +186,7 @@ RENAME
Renames a given group from *oldname* to *newname*.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
......@@ -202,7 +202,7 @@ the command line or as a cluster default.
If no specific destination groups are specified using ``--to``, all
groups except the evacuated group are considered.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
......
......@@ -110,7 +110,7 @@ link
in bridged or openvswitch mode specifies the interface to attach
this NIC to, in routed mode it's intended to differentiate between
different routing tables/instance groups (but the meaning is
dependent on the network script, see gnt-cluster(8) for more
dependent on the network script, see **gnt-cluster**\(8) for more
details). Note that openvswitch support is also hypervisor
dependent.
......@@ -383,7 +383,7 @@ spice\_tls\_ciphers
Valid for the KVM hypervisor.
Specifies a list of comma-separated ciphers that SPICE should use
for TLS connections. For the format, see man cipher(1).
for TLS connections. For the format, see man **cipher**\(1).
spice\_use\_vdagent
Valid for the KVM hypervisor.
......@@ -699,7 +699,7 @@ blktap
If ``--ignore-ipolicy`` is given any instance policy violations occuring
during this operation are ignored.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
......@@ -829,7 +829,7 @@ instance to stop.
The ``--force`` option is used to skip the interactive confirmation.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
......@@ -860,7 +860,7 @@ scripts. In both cases, the ``--units`` option can be used to enforce
a given output unit.
The ``-v`` option activates verbose mode, which changes the display of
special field states (see **ganeti(7)**).
special field states (see **ganeti**\(7)).
The ``-o (--output)`` option takes a comma-separated list of output
fields. The available fields and their meaning are:
......@@ -882,7 +882,7 @@ you only want some data and it makes sense to specify a reduced set of
output fields.
If exactly one argument is given and it appears to be a query filter
(see **ganeti(7)**), the query result is filtered accordingly. For
(see **ganeti**\(7)), the query result is filtered accordingly. For
ambiguous cases (e.g. a single field name as a filter) the ``--filter``
(``-F``) option forces the argument to be treated as a filter (e.g.
``gnt-instance list -F admin_state``).
......@@ -995,7 +995,7 @@ immediately.
If ``--ignore-ipolicy`` is given any instance policy violations occuring
during this operation are ignored.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Most of the changes take effect at the next restart. If the instance is
......@@ -1026,7 +1026,7 @@ arguments or by using the ``--node``, ``--primary``, ``--secondary``
or ``--all`` options), the user must pass the ``--force-multiple``
options to skip the interactive confirmation.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
RENAME
......@@ -1052,7 +1052,7 @@ that the resolved name matches the provided name. Since the name check
is used to compute the IP address, if you pass this option you must also
pass the ``--no-ip-check`` option.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Starting/stopping/connecting to console
......@@ -1148,7 +1148,7 @@ pauses the instance at the start of bootup, awaiting ``gnt-instance
console`` to unpause it, allowing the entire boot process to be
monitored for debugging.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
......@@ -1201,7 +1201,7 @@ you just need to disable the watcher, shutdown all instances with
``--no-remember``, and when the watcher is activated again it will
restore the correct runtime state for all instances.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
......@@ -1246,7 +1246,7 @@ to stop.
The ``--force-multiple`` will skip the interactive confirmation in the
case the more than one instance will be affected.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
......@@ -1336,7 +1336,7 @@ The ``--ignore-ipolicy`` let the command ignore instance policy
violations if replace-disks changes groups and the instance would
violate the new groups instance policy.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
ACTIVATE-DISKS
......@@ -1374,7 +1374,7 @@ parse the disk information.
Note that it is safe to run this command while the instance is already
running.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
DEACTIVATE-DISKS
......@@ -1395,7 +1395,7 @@ option passed it will skip this check and directly try to deactivate
the disks. This can still fail due to the instance actually running or
other issues.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
GROW-DISK
......@@ -1415,9 +1415,9 @@ disk. Usually, you will need to:
#. reboot the instance (later, at a convenient time)
#. use a filesystem resizer, such as ext2online(8) or
xfs\_growfs(8) to resize the filesystem, or use fdisk(8) to change
the partition table on the disk
#. use a filesystem resizer, such as **ext2online**\(8) or
**xfs\_growfs**\(8) to resize the filesystem, or use **fdisk**\(8) to
change the partition table on the disk
The *disk* argument is the index of the instance disk to grow. The
*amount* argument is given as a number which can have a suffix (like the
......@@ -1438,7 +1438,7 @@ create problems (except for unused space).
If you do not want gnt-instance to wait for the new disk region to be
synced, use the ``--no-wait-for-sync`` option.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example (increase the first disk for instance1 by 16GiB)::
......@@ -1488,7 +1488,7 @@ using the specified iallocator, passing the ``--iallocator`` option.
The primary and secondary nodes will be chosen by the specified
iallocator plugin, or by the default allocator if ``.`` is specified.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Recovery/moving
......@@ -1532,7 +1532,7 @@ to stop.
If ``--ignore-ipolicy`` is given any instance policy violations occuring
during this operation are ignored.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
......@@ -1603,7 +1603,7 @@ down because the target node doesn't have enough available memory).
If an instance has the backend parameter ``always_failover`` set to
true, then the migration is automatically converted into a failover.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example (and expected output)::
......@@ -1656,7 +1656,7 @@ hypervisor is broken and you want to recover the data.
If ``--ignore-ipolicy`` is given any instance policy violations occuring
during this operation are ignored.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
......@@ -1677,7 +1677,7 @@ cluster default.
If no specific destination groups are specified using ``--to``, all
groups except the one containing the instance are considered.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
......
......@@ -111,7 +111,7 @@ The following options can be used to show only specific jobs:
Show finished jobs only.
If exactly one argument is given and it appears to be a query filter
(see **ganeti(7)**), the query result is filtered accordingly. For
(see **ganeti**\(7)), the query result is filtered accordingly. For
ambiguous cases (e.g. a single field name as a filter) the ``--filter``
(``-F``) option forces the argument to be treated as a filter.
......
......@@ -50,7 +50,7 @@ IPv6 semantics can be assigned to the network via the ``--network6`` and
``--gateway6`` options. IP pool is meaningless for IPV6 so those two
values can be used for EUI64 generation from a NIC's MAC address.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
MODIFY
......@@ -73,7 +73,7 @@ Unable to modify network (IP address range). Create a new network if you
want to do so. All other options are documented in the **add** command
above.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
REMOVE
......@@ -83,7 +83,7 @@ REMOVE
Deletes the indicated network, which must be not connected to any node group.
See **ganeti(7)** for a description of ``--submit`` and other common options.
See **ganeti**\(7) for a description of ``--submit`` and other common options.
LIST
~~~~
......@@ -100,7 +100,7 @@ The ``--no-headers`` option will skip the initial header line. The
between the output fields. Both these options are to help scripting.
The ``-v`` option activates verbose mode, which changes the display of
special field states (see **ganeti(7)**).
special field states (see **ganeti**\(7)).
The ``-o`` option takes a comma-separated list of output fields. If the
value of the option starts with the character ``+``, the new fields will
......
......@@ -44,7 +44,7 @@ to its current status (it could be already in a cluster, etc.)
The ``-s (--secondary-ip)`` is used in dual-home clusters and
specifies the new node's IP in the secondary network. See the
discussion in **gnt-cluster**(8) for more information.
discussion in **gnt-cluster**\(8) for more information.
In case you're readding a node after hardware failure, you can use
the ``--readd`` parameter. In this case, you don't need to pass the
......@@ -57,7 +57,7 @@ specific node group, specified by UUID or name. If only one node group
exists you can skip this option, otherwise it's mandatory.
The ``vm_capable``, ``master_capable``, ``ndparams``, ``diskstate`` and
``hvstate`` options are described in **ganeti**(7), and are used to set
``hvstate`` options are described in **ganeti**\(7), and are used to set
the properties of the new node.
The command performs some operations that change the state of the master
......@@ -124,7 +124,7 @@ each affected instance individually:
in the secondary node change mode (only valid for DRBD instances)
- when neither of the above is done a combination of the two cases is run
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
......@@ -187,7 +187,7 @@ Queries of nodes will be done in parallel with any running jobs. This might
give inconsistent results for the free disk/memory.
The ``-v`` option activates verbose mode, which changes the display of
special field states (see **ganeti(7)**).
special field states (see **ganeti**\(7)).
The ``-o (--output)`` option takes a comma-separated list of output
fields. The available fields and their meaning are:
......@@ -212,7 +212,7 @@ pool of memory used for instances (KVM), whereas others have separate
memory for the node and for the instances (Xen).
If exactly one argument is given and it appears to be a query filter
(see **ganeti(7)**), the query result is filtered accordingly. For
(see **ganeti**\(7)), the query result is filtered accordingly. For
ambiguous cases (e.g. a single field name as a filter) the ``--filter``
(``-F``) option forces the argument to be treated as a filter (e.g.
``gnt-node list -F master_candidate``).
......@@ -247,7 +247,7 @@ list of fields (it doesn't accept the ``--output`` option), as follows:
This command can be used as a reverse lookup (from node and minor) to a
given instance, which can be useful when debugging DRBD issues.
Note that this command queries Ganeti via :manpage:`ganeti-confd(8)`, so
Note that this command queries Ganeti via **ganeti-confd**\(8), so
it won't be available if support for ``confd`` has not been enabled at
build time; furthermore, in Ganeti 2.6 this is only available via the
Haskell version of confd (again selected at build time).
......@@ -277,7 +277,7 @@ can be given to influence the migration type.
If ``--ignore-ipolicy`` is given any instance policy violations
occurring during this operation are ignored.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
......@@ -302,7 +302,7 @@ MODIFY
This command changes the role of the node. Each options takes
either a literal yes or no, and only one option should be given as
yes. The meaning of the roles and flags are described in the
manpage **ganeti(7)**.
manpage **ganeti**\(7).
The option ``--node-powered`` can be used to modify state-of-record if
it doesn't reflect the reality anymore.
......@@ -330,7 +330,7 @@ convert a cluster from single homed to multi-homed or vice versa
``--force`` is needed as well, and the target node for the first change
must be the master.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example (setting the node back to online and master candidate)::
......@@ -534,7 +534,7 @@ The ``--yes`` option can be used to skip confirmation, while the
``--force`` option is needed if the target node is the master
node.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
POWER
......
......@@ -78,7 +78,7 @@ Note: The given operating system doesn't have to exist. This allows
preseeding the settings for operating systems not yet known to
**gnt-os**.
See **ganeti(7)** for a description of ``--submit`` and other common
See **ganeti**\(7) for a description of ``--submit`` and other common
options.
.. vim: set textwidth=72 :
......
......@@ -17,7 +17,7 @@ DESCRIPTION
-----------
hail is a Ganeti IAllocator plugin that implements the instance
placement and movement using the same algorithm as **hbal**(1).
placement and movement using the same algorithm as **hbal**\(1).
The program takes input via a JSON-file containing current cluster
state and the request details, and output (on stdout) a JSON-formatted
......@@ -68,17 +68,17 @@ The options that can be passed to the program are as follows:
-p, \--print-nodes
Prints the before and after node status, in a format designed to allow
the user to understand the node's most important parameters. See the
man page **htools**(1) for more details about this option.
man page **htools**\(1) for more details about this option.
-t *datafile*, \--text-data=*datafile*
The name of the file holding cluster information, to override the data
in the JSON request itself. This is mostly used for debugging. The
format of the file is described in the man page **htools**(1).
format of the file is described in the man page **htools**\(1).
\--simulate *description*
Backend specification: similar to the **-t** option, this allows
overriding the cluster data with a simulated cluster. For details
about the description, see the man page **htools**(1).
about the description, see the man page **htools**\(1).
-S *filename*, \--save-cluster=*filename*
If given, the state of the cluster before and the iallocator run is
......
......@@ -220,7 +220,7 @@ The options that can be passed to the program are as follows:
-p, \--print-nodes
Prints the before and after node status, in a format designed to allow
the user to understand the node's most important parameters. See the
man page **htools**(1) for more details about this option.
man page **htools**\(1) for more details about this option.
\--print-instances
Prints the before and after instance map. This is less useful as the
......@@ -326,17 +326,17 @@ The options that can be passed to the program are as follows: