ansible/hacking/templates/man.j2

67 lines
1.4 KiB
Text
Raw Normal View History

2012-10-05 09:09:49 +02:00
.TH ANSIBLE.@{ module | upper }@ 3 "@{ now_date }@" "@{ ansible_version }@" "ANSIBLE MODULES"
2012-09-26 20:41:44 +02:00
." generated from @{ filename }@
.SH NAME
@{ module }@ \- @{ short_description }@
." ------ DESCRIPTION
.SH DESCRIPTION
{% for desc in description %}
2012-09-26 20:41:44 +02:00
.PP
@{ desc | jpfunc }@
{% endfor %}
." ------ OPTIONS
."
."
{% if options %}
2012-09-26 20:41:44 +02:00
.SH OPTIONS
{% for k in option_keys %}
{% set v = options[k] %}
2012-09-28 09:59:43 +02:00
.IP @{ k }@
{% for desc in v.description %}@{ desc | jpfunc }@{% endfor %}
2012-09-28 09:59:43 +02:00
{% if v.get('choices') %}
2012-09-26 20:41:44 +02:00
.IR Choices :
{% for choice in v.get('choices',[]) %}@{ choice }@{% if not loop.last %},{%else%}.{%endif%}{% endfor %}{% endif %}
{% if v.get('required') %}(required){% endif %}
{% if v.get('default') %} (default: @{ v.get('default') }@){% endif %}
2012-09-26 20:41:44 +02:00
{#---------------------------------------------- #}
{% if v.get('version_added') %}
2012-09-28 09:59:43 +02:00
(Added in Ansible version @{ v.get('version_added') }@.)
{% endif %}
2012-09-28 09:59:43 +02:00
{% endfor %}
2012-09-26 20:41:44 +02:00
{% endif %}
."
."
." ------ NOTES
{% if notes %}
2012-09-26 20:41:44 +02:00
.SH NOTES
{% for note in notes %}
2012-09-26 20:41:44 +02:00
.PP
@{ note | jpfunc }@
{% endfor %}
{% endif %}
2012-09-26 20:41:44 +02:00
."
."
." ------ EXAMPLES
{% if examples is defined %}
2012-09-26 20:41:44 +02:00
.SH EXAMPLES
{% for e in examples %}
2012-09-26 20:41:44 +02:00
.PP
{% if e['description'] %}
@{ e['description'] | jpfunc }@
{% endif %}
2012-09-26 20:41:44 +02:00
.nf
@{ e['code'] }@
.fi
{% endfor %}
{% endif %}
2012-09-26 20:41:44 +02:00
." ------- AUTHOR
{% if author is defined %}
2012-09-26 20:41:44 +02:00
.SH AUTHOR
@{ author }@
{% endif %}
2012-09-26 20:41:44 +02:00
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#@{docuri}@