1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Basic docsite formatting fixups

This commit is contained in:
Michael DeHaan 2014-01-02 17:36:52 -05:00
parent 86719ce77f
commit 2f811c40d7
4 changed files with 30 additions and 10 deletions

View file

@ -1,13 +1,22 @@
'\" t '\" t
.\" Title: ansible .\" Title: ansible
.\" Author: [see the "AUTHOR" section] .\" Author: :doctype:manpage
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 11/27/2013 .\" Date: 01/02/2014
.\" Manual: System administration commands .\" Manual: System administration commands
.\" Source: Ansible 1.4.1 .\" Source: Ansible 1.5
.\" Language: English .\" Language: English
.\" .\"
.TH "ANSIBLE" "1" "11/27/2013" "Ansible 1\&.4\&.1" "System administration commands" .TH "ANSIBLE" "1" "01/02/2014" "Ansible 1\&.5" "System administration commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * set default formatting .\" * set default formatting
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
@ -25,7 +34,7 @@ ansible-pull \- set up a remote copy of ansible on each managed node
ansible \-d DEST \-U URL [options] [ <filename\&.yml> ] ansible \-d DEST \-U URL [options] [ <filename\&.yml> ]
.SH "DESCRIPTION" .SH "DESCRIPTION"
.sp .sp
\fBAnsible\fR is an extra\-simple tool/framework/API for doing \'remote things\' over SSH\&. \fBAnsible\fR is an extra\-simple tool/framework/API for doing \*(Aqremote things\*(Aq over SSH\&.
.sp .sp
Use ansible\-pull to set up a remote copy of ansible on each managed node, each set to run via cron and update playbook source via a source repository\&. This inverts the default \fBpush\fR architecture of ansible into a \fBpull\fR architecture, which has near\-limitless scaling potential\&. Use ansible\-pull to set up a remote copy of ansible on each managed node, each set to run via cron and update playbook source via a source repository\&. This inverts the default \fBpush\fR architecture of ansible into a \fBpull\fR architecture, which has near\-limitless scaling potential\&.
.sp .sp
@ -77,6 +86,11 @@ Purge the checkout after the playbook is run\&.
.RS 4 .RS 4
Module used to checkout playbook repository\&. Defaults to git\&. Module used to checkout playbook repository\&. Defaults to git\&.
.RE .RE
.PP
\fB\-o\fR, \fB\-\-only\-if\-changed\fR
.RS 4
Run the playbook only if the repository has changed
.RE
.SH "AUTHOR" .SH "AUTHOR"
.sp .sp
Ansible was originally written by Michael DeHaan\&. See the AUTHORS file for a complete list of contributors\&. Ansible was originally written by Michael DeHaan\&. See the AUTHORS file for a complete list of contributors\&.
@ -90,3 +104,9 @@ Ansible is released under the terms of the GPLv3 License\&.
\fBansible\fR(1), \fBansible\-playbook\fR(1), \fBansible\-doc\fR(1) \fBansible\fR(1), \fBansible\-playbook\fR(1), \fBansible\-doc\fR(1)
.sp .sp
Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/ Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/
.SH "AUTHOR"
.PP
\fB:doctype:manpage\fR
.RS 4
Author.
.RE

View file

@ -71,7 +71,7 @@ Variables defined from included files and roles
It turns out we've already talked about variables in another place too. It turns out we've already talked about variables in another place too.
As described in :doc:`intro_roles`, variables can also be included in the playbook via include files, which may or may As described in :doc:`playbooks_roles`, variables can also be included in the playbook via include files, which may or may
not be part of an "Ansible Role". Usage of roles is preferred as it provides a nice organizational system. not be part of an "Ansible Role". Usage of roles is preferred as it provides a nice organizational system.
.. _about_jinja2: .. _about_jinja2:

View file

@ -95,7 +95,7 @@ Examples
:: ::
@{ plainexamples | escape | indent(4, True) }@ @{ plainexamples | indent(4, True) }@
{% endif %} {% endif %}
{% endif %} {% endif %}

View file

@ -47,11 +47,11 @@ options:
- all arguments accepted by the M(file) module also work here - all arguments accepted by the M(file) module also work here
required: false required: false
notes: notes:
- Since Ansible version 0.9, templates are loaded with C(trim_blocks=True). - "Since Ansible version 0.9, templates are loaded with C(trim_blocks=True)."
- "Also, you can override jinja2 settings by adding a special header to template file. - "Also, you can override jinja2 settings by adding a special header to template file.
i.e. C(#jinja2:variable_start_string:'[%' , variable_end_string:'%]') i.e. C(#jinja2:variable_start_string:'[%' , variable_end_string:'%]')
which changes the variable interpolation markers to [% var %] instead of {{ var }}." This is the best way to prevent evaluation of things that look like, but should not be Jinja2. raw/endraw in Jinja2 will not work as you expect because templates in Ansible are recursively evaluated. which changes the variable interpolation markers to [% var %] instead of {{ var }}. This is the best way to prevent evaluation of things that look like, but should not be Jinja2. raw/endraw in Jinja2 will not work as you expect because templates in Ansible are recursively evaluated."
requirements: [] requirements: []
author: Michael DeHaan author: Michael DeHaan