@@ -9,12 +9,12 @@ The `SetProgramOptions` package extends [`ConfigParserEnhanced`][5] to enable th
99processing of ** .ini** files that specify ** command line program options** .
1010
1111As a subclass of ConfigParserEnhanced, SetProgramOptions supports all
12- the _ operations_ that [ ` ConfigParserEnhanced ` ] [ 2 ] supports and adds some of its
12+ the _ operations_ that [ ` ConfigParserEnhanced ` ] [ 5 ] supports and adds some of its
1313own. The following table notes the new ** operations** that SetProgramOptions adds:
1414
1515| Operation | Format | Defined By |
1616| ------------ | --------------------------------------------- | --------------------------- |
17- | ` use ` | ` use <section> ` | [ ` ConfigParserEnhanced ` ] [ 2 ] |
17+ | ` use ` | ` use <section> ` | [ ` ConfigParserEnhanced ` ] [ 5 ] |
1818| ` opt-set ` | ` opt-set Param1 [Param2..ParamN] [: <VALUE>] ` | ` SetProgramOptions ` |
1919| ` opt-remove ` | ` opt-remove Param [SUBSTR] ` | ` SetProgramOptions ` |
2020
@@ -36,27 +36,32 @@ Supported Operations
3636--------------------
3737
3838### ` use `
39- The ` use ` operation is inherited from [ ` ConfigParserEnhanced ` ] [ 2 ] . Please see its documentation on this command and its use.
39+ The ` use ` operation is inherited from [ ` ConfigParserEnhanced ` ] [ 5 ] . Please see its documentation
40+ on this command and its use.
4041
4142### ` opt-set `
4243Sets a generic _ command line_ style option.
4344
4445The format of this is ` opt-set Param1 [Param2] [Param3] ... [ParamN] : [VALUE] `
4546
46- In a _ bash_ context, this operation attempts to generate an option for some command that will be executed.
47- ` SetProgramOptions ` will concactenate the _ Params_ together and then append ` =VALUE ` if a VALUE field is present.
47+ In a _ bash_ context, this operation attempts to generate an option for some command
48+ that will be executed.
49+ ` SetProgramOptions ` will concactenate the _ Params_ together and then append ` =VALUE `
50+ if a VALUE field is present.
4851For example, ` opt-set Foo Bar : Baz ` will become ` FooBar=Baz ` .
4952
5053
5154### ` opt-remove `
52- _ Removes_ existing entries that have been processed up to the point the ` opt-remove ` is encountered that match a pattern.
55+ _ Removes_ existing entries that have been processed up to the point the ` opt-remove ` is
56+ encountered that match a pattern.
5357
5458The format of this is ` opt-remove Param [SUBSTR] `
5559
56- When a _ remove_ is encountered, ` SetProgramOptions ` will search through all processed options and will delete any
57- that contain any _ Param-i_ that matches ` Param ` . By default the parameters much be an _ exact match_ of ` Param ` , but
58- if the optional ` SUBSTR ` parameter is provided then ` SetProgramOptions ` will treat ` Param ` as a substring and will
59- remove all existing options if _ any parameter contains Param_ .
60+ When a _ remove_ is encountered, ` SetProgramOptions ` will search through all processed
61+ options and will delete any that contain any _ Param-i_ that matches ` Param ` .
62+ By default the parameters much be an _ exact match_ of ` Param ` , but if the optional
63+ ` SUBSTR ` parameter is provided then ` SetProgramOptions ` will treat ` Param ` as a
64+ substring and will remove all existing options if _ any parameter contains Param_ .
6065
6166
6267SetProgramOptions Config Files
447452[ 1 ] : https://cmake.org/cmake/help/latest/command/set.html
448453[ 2 ] : https://github.com/sandialabs/ConfigParserEnhanced
449454[ 3 ] : https://github.com/sandialabs/SetProgramOptions/blob/master/CHANGELOG.md
450- [ 4 ] : https://setprogramoptions.readthedocs.io/en/latest
455+ [ 4 ] : https://setprogramoptions.readthedocs.io/
451456[ 5 ] : https://pypi.org/project/configparserenhanced/
452457[ 6 ] : https://www.cmake.org/
458+ [ 7 ] : https://configparserenhanced.readthedocs.io/
0 commit comments