.TH ANSIBLE.@{ module | upper }@ 3 "@{ now_date }@" "@{ ansible_version }@" "ANSIBLE MODULES" .\" generated from @{ filename }@ .SH NAME @{ module }@ \- @{ short_description }@ .\" ------ DESCRIPTION .SH DESCRIPTION {% for desc in description %} .PP @{ desc | convert_symbols_to_format }@ {% endfor %} .\" ------ OPTIONS .\" .\" {% if options %} .SH OPTIONS {% for k in option_keys %} {% set v = options[k] %} .IP @{ k }@ {% for desc in v.description %}@{ desc | convert_symbols_to_format }@{% endfor %} {% if v.get('choices') %} .IR Choices : {% for choice in v.get('choices',[]) %}{% if choice == True %}yes{%elif choice == False %}no{% else %}@{ choice }@{% endif %}{% if not loop.last %},{%else%}.{%endif%}{% endfor %}{% endif %} {% if v.get('required') %}(required){% endif %} {% if v.get('default') %} (default: {% if v.get('default') == True %}yes{%elif v.get('default') == False %}no{% else %}@{ v.get('default') }@){% endif %}{% endif %} {#---------------------------------------------- #} {% if v.get('version_added') %} (Added in Ansible version @{ v.get('version_added') }@.) {% endif %} {% endfor %} {% endif %} .\" .\" .\" ------ NOTES {% if notes %} .SH NOTES {% for note in notes %} .PP @{ note | convert_symbols_to_format }@ {% endfor %} {% endif %} .\" .\" .\" ------ EXAMPLES {% if examples is defined %} .SH EXAMPLES {% for e in examples %} .PP {% if e['description'] %} @{ e['description'] | convert_symbols_to_format }@ {% endif %} .nf @{ e['code'] }@ .fi {% endfor %} {% endif %} .\" ------ PLAINEXAMPLES {% if plainexamples is defined %} .SH EXAMPLES .nf @{ plainexamples }@ .fi {% endif %} .\" ------- AUTHOR {% if author is defined %} .SH AUTHOR @{ author }@ {% endif %} .SH SEE ALSO .IR ansible (1), .I http://ansible.github.com/modules.html#@{docuri}@