mirror of https://github.com/ansible/ansible.git
draft to generate man pages
parent
7b197d823e
commit
b4c47ebf68
@ -0,0 +1,104 @@
|
||||
ansible{% if cli != 'adhoc' %}-{{cli}}{% endif %}(1)
|
||||
==================
|
||||
:doctype:manpage
|
||||
:man source: Ansible
|
||||
:man version: %VERSION%
|
||||
:man manual: System administration commands
|
||||
|
||||
NAME
|
||||
----
|
||||
ansible{% if cli != 'adhoc' %}-{{cli}}{% endif %} - {{short_desc|default('')}}
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
{{ usage }}
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
{{ long_desc }}
|
||||
|
||||
|
||||
{% if arguments %}
|
||||
ARGUMENTS
|
||||
---------
|
||||
|
||||
{% for arg in arguments %}
|
||||
{{ arg['name'] }}
|
||||
|
||||
{{ arg['desc'] }}
|
||||
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
|
||||
{% for option in options|sort(attribute='options') %}
|
||||
{% for switch in option['options'] %}*{{switch}}* {% if option['arg'] %}'{{option['arg']}}'{% endif %}{% if not loop.last %}, {% endif %}{% endfor %}::
|
||||
|
||||
{{ option['desc'] }}
|
||||
{% endfor %}
|
||||
|
||||
{% if inv_opts %}
|
||||
INVENTORY
|
||||
---------
|
||||
|
||||
Ansible stores the hosts it can potentially operate on in an inventory.
|
||||
This can be an YAML file, ini-like file, a script, directory, list, etc.
|
||||
For additional options, see the documentation on http://docs.ansible.com/.
|
||||
|
||||
{% endif %}
|
||||
ENVIRONMENT
|
||||
-----------
|
||||
|
||||
The following environment variables may be specified.
|
||||
|
||||
{% if inv_opts %}
|
||||
ANSIBLE_INVENTORY -- Override the default ansible inventory file
|
||||
|
||||
{% endif %}
|
||||
{% if run_opts %}
|
||||
ANSIBLE_LIBRARY -- Override the default ansible module library path
|
||||
|
||||
{% endif %}
|
||||
ANSIBLE_CONFIG -- Override the default ansible config file
|
||||
|
||||
Many more are available for most options in ansible.cfg
|
||||
|
||||
|
||||
FILES
|
||||
-----
|
||||
|
||||
{% if inv_opts %}
|
||||
/etc/ansible/hosts -- Default inventory file
|
||||
|
||||
{% endif %}
|
||||
/etc/ansible/ansible.cfg -- Config file, used if present
|
||||
|
||||
~/.ansible.cfg -- User config file, overrides the default config if present
|
||||
|
||||
|
||||
AUTHOR
|
||||
------
|
||||
|
||||
Ansible was originally written by Michael DeHaan.
|
||||
See the AUTHORS file for a complete list of contributors.
|
||||
|
||||
|
||||
COPYRIGHT
|
||||
---------
|
||||
|
||||
Copyright © 2017 Red Hat, Inc.
|
||||
Ansible is released under the terms of the GPLv3 License.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
|
||||
{% for other in cli_list|sort %}{% if other != cli %}*ansible{% if other != 'adhoc' %}-{{other}}{% endif %}*(1){% if not loop.last %}, {% endif %}{% endif %}{% endfor %}
|
||||
|
||||
Extensive documentation is available in the documentation site:
|
||||
<http://docs.ansible.com>. IRC and mailing list info can be found
|
||||
in file CONTRIBUTING.md, available in: <https://github.com/ansible/ansible>
|
Loading…
Reference in New Issue