diff --git a/rst/modules/ini_file.rst b/rst/modules/ini_file.rst new file mode 100644 index 0000000000..6379948ef6 --- /dev/null +++ b/rst/modules/ini_file.rst @@ -0,0 +1,78 @@ +.. _ini_file: + +ini_file +```````` + +.. versionadded:: 0.9 + + +Manage (add, remove, change) individual settings in an INI-style file without having to manage the file as a whole with, say, ``template`` or ``assemble``. Adds missing sections if they don't exist. + + +.. raw:: html + +
parameter | +required | +default | +choices | +comments | +
option | +False | +None | +if set (required for changing a value), this is the name of the option.May be omitted if adding/removing a whole section. | +|
others | +False | ++ | all arguments accepted by the file module also work here | +|
dest | +True | +None | +Path to the INI-style file; this file is created if required | +|
section | +True | +None | +Section name in INI file. This is added if state=present automatically when a single value is being set. |
+ |
backup | +False | +False | +
|
+ Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. | +
value | +False | +None | +the string value to be associated with an option. May be omitted when removing an option. | +