From 88f1294f74cd5f67fbcec2150e4d80226a057dd2 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Thu, 27 Sep 2012 21:43:37 -0400 Subject: [PATCH] Add ini file RST --- rst/modules/ini_file.rst | 78 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 rst/modules/ini_file.rst diff --git a/rst/modules/ini_file.rst b/rst/modules/ini_file.rst new file mode 100644 index 00000000000..6379948ef62 --- /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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
parameterrequireddefaultchoicescomments
optionFalseNone
    		if set (required for changing a value), this is the name of the option.May be omitted if adding/removing a whole section.
    othersFalse
      		all arguments accepted by the file module also work here
      destTrueNone
        		Path to the INI-style file; this file is created if required
        sectionTrueNone
          		Section name in INI file. This is added if state=present automatically when a single value is being set.
          backupFalseFalse
          • yes
          • no
          		Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
          valueFalseNone
            		the string value to be associated with an option. May be omitted when removing an option.
            + + +.. raw:: html + + +
            +