mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
65 lines
1.3 KiB
Text
65 lines
1.3 KiB
Text
|
.TH ANSIBLE.@{ module | upper }@ 5 "@{ now_date }@" "@{ ansible_version }@" "ANSIBLE MODULES"
|
||
|
|
." generated from @{ filename }@
|
||
|
|
.SH NAME
|
||
|
|
@{ module }@ \- @{ short_description }@
|
||
|
|
." ------ DESCRIPTION
|
||
|
|
.SH DESCRIPTION
|
||
|
|
{% for desc in description -%}
|
||
|
|
.PP
|
||
|
|
@{ desc | jpfunc }@
|
||
|
|
{% endfor %}
|
||
|
|
." ------ OPTIONS
|
||
|
|
."
|
||
|
|
."
|
||
|
|
{% if options is defined -%}
|
||
|
|
.SH OPTIONS
|
||
|
|
{% for o in options -%}{% for opt, v in o.iteritems() -%}
|
||
|
|
.IP @{opt}@
|
||
|
|
{% for desc in v.description -%}
|
||
|
|
@{ desc | jpfunc }@
|
||
|
|
{% endfor -%}
|
||
|
|
{% if v['required'] %}(required){% endif -%}
|
||
|
|
{% if v['choices'] -%}
|
||
|
|
." .SS Choices
|
||
|
|
.IR Choices :
|
||
|
|
{% for choice in v['choices'] -%}@{ choice }@{% if not loop.last %},{% else %}.{% endif -%}
|
||
|
|
{% endfor -%}
|
||
|
|
{% endif %}
|
||
|
|
{#---------------------------------------------- #}
|
||
|
|
{% if v['version_added'] is defined -%}
|
||
|
|
(Added in Ansible version @{ v['version_added'] }@.)
|
||
|
|
{% endif -%}
|
||
|
|
{% endfor -%}
|
||
|
|
{% endfor -%}
|
||
|
|
{% endif %}
|
||
|
|
."
|
||
|
|
."
|
||
|
|
." ------ NOTES
|
||
|
|
{% if notes is defined -%}
|
||
|
|
.SH NOTES
|
||
|
|
{% for note in notes -%}
|
||
|
|
.PP
|
||
|
|
@{ note | jpfunc }@
|
||
|
|
{% endfor -%}
|
||
|
|
{% endif -%}
|
||
|
|
."
|
||
|
|
."
|
||
|
|
." ------ EXAMPLES
|
||
|
|
{% if examples is defined -%}
|
||
|
|
.SH EXAMPLES
|
||
|
|
{% for e in examples -%}
|
||
|
|
.PP
|
||
|
|
.nf
|
||
|
|
@{ e['code'] }@
|
||
|
|
.fi
|
||
|
|
{% endfor -%}
|
||
|
|
{% endif -%}
|
||
|
|
." ------- AUTHOR
|
||
|
|
{% if author is defined -%}
|
||
|
|
.SH AUTHOR
|
||
|
|
@{ author }@
|
||
|
|
{% endif -%}
|
||
|
|
.SH SEE ALSO
|
||
|
|
.IR ansible (1),
|
||
|
|
.I http://ansible.github.com/modules.html#@{docuri}@
|