ansible/docs/man/man3/ansible.lineinfile.3

.TH ANSIBLE.LINEINFILE 5 "2012-10-03" "0.8" "ANSIBLE MODULES"
." generated from library/lineinfile
.SH NAME
lineinfile \- Ensure a particular line is in a file
." ------ DESCRIPTION
.SH DESCRIPTION
.PP
This module will search a file for a line, and ensure that it is present or absent. 
.PP
This is primarily useful when you want to change a single line in a file only. For other cases, see the \fIcopy\fR or \fItemplate\fR modules. 
." ------ OPTIONS
."
."
.SH OPTIONS

.IP state
Whether the line should be there or not.
.IR Choices :
present,absent. (default: present)
.IP name
The file to modify(required)
.IP insertafter
Used with \fCstate=present\fR. If specified, the line will be inserted after the specified regular expression. Two special values are available; \fCBOF\fR for inserting the line at the beginning of the file, and \fCEOF\fR for inserting the line at the end of the file.
.IR Choices :
BOF,EOF. (default: EOF)
.IP regexp
The regular expression to look for in the file. For \fCstate=present\fR, the pattern to replace. For \fCstate=absent\fR, the pattern of the line to remove.(required)
.IP line
Required for \fCstate=present\fR. The line to insert/replace into the file. Must match the value given to \fCregexp\fR.
.IP backup
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.."
."
." ------ NOTES
."
."
." ------ EXAMPLES
.SH EXAMPLES
.PP
.nf
lineinfile name=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled
.fi
.PP
.nf
lineinfile name=/etc/sudoers state=absent regexp="^%wheel"
.fi
." ------- AUTHOR
.SH AUTHOR
Daniel Hokka Zakrisson
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#lineinfile
Fix module formatter indexing 2012-10-04 05:31:50 +02:00			`.TH ANSIBLE.LINEINFILE 5 "2012-10-03" "0.8" "ANSIBLE MODULES"`
module_formatter in hacking/ 2012-09-26 20:41:44 +02:00			`." generated from library/lineinfile`
			`.SH NAME`
			`lineinfile \- Ensure a particular line is in a file`
			`." ------ DESCRIPTION`
			`.SH DESCRIPTION`
			`.PP`
			`This module will search a file for a line, and ensure that it is present or absent.`
			`.PP`
			`This is primarily useful when you want to change a single line in a file only. For other cases, see the \fIcopy\fR or \fItemplate\fR modules.`
			`." ------ OPTIONS`
			`."`
			`."`
			`.SH OPTIONS`
Complain when modules do not have documentation. 2012-10-01 03:10:07 +02:00
module_formatter in hacking/ 2012-09-26 20:41:44 +02:00			`.IP state`
Complain when modules do not have documentation. 2012-10-01 03:10:07 +02:00			`Whether the line should be there or not.`
module_formatter in hacking/ 2012-09-26 20:41:44 +02:00			`.IR Choices :`
Complain when modules do not have documentation. 2012-10-01 03:10:07 +02:00			`present,absent. (default: present)`
			`.IP name`
			`The file to modify(required)`
module_formatter in hacking/ 2012-09-26 20:41:44 +02:00			`.IP insertafter`
Check in generated manpage documentation from modules 2012-10-03 04:46:49 +02:00			`Used with \fCstate=present\fR. If specified, the line will be inserted after the specified regular expression. Two special values are available; \fCBOF\fR for inserting the line at the beginning of the file, and \fCEOF\fR for inserting the line at the end of the file.`
module_formatter in hacking/ 2012-09-26 20:41:44 +02:00			`.IR Choices :`
Complain when modules do not have documentation. 2012-10-01 03:10:07 +02:00			`BOF,EOF. (default: EOF)`
			`.IP regexp`
Check in generated manpage documentation from modules 2012-10-03 04:46:49 +02:00			`The regular expression to look for in the file. For \fCstate=present\fR, the pattern to replace. For \fCstate=absent\fR, the pattern of the line to remove.(required)`
Complain when modules do not have documentation. 2012-10-01 03:10:07 +02:00			`.IP line`
Check in generated manpage documentation from modules 2012-10-03 04:46:49 +02:00			`Required for \fCstate=present\fR. The line to insert/replace into the file. Must match the value given to \fCregexp\fR.`
module_formatter in hacking/ 2012-09-26 20:41:44 +02:00			`.IP backup`
Complain when modules do not have documentation. 2012-10-01 03:10:07 +02:00			`Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.."`
module_formatter in hacking/ 2012-09-26 20:41:44 +02:00			`."`
			`." ------ NOTES`
			`."`
			`."`
			`." ------ EXAMPLES`
			`.SH EXAMPLES`
			`.PP`
			`.nf`
			`lineinfile name=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled`
			`.fi`
			`.PP`
			`.nf`
			`lineinfile name=/etc/sudoers state=absent regexp="^%wheel"`
			`.fi`
			`." ------- AUTHOR`
Check in generated manpage documentation from modules 2012-10-03 04:46:49 +02:00			`.SH AUTHOR`
			`Daniel Hokka Zakrisson`
module_formatter in hacking/ 2012-09-26 20:41:44 +02:00			`.SH SEE ALSO`
			`.IR ansible (1),`
			`.I http://ansible.github.com/modules.html#lineinfile`