Skip to content

Commit 779d91a

Browse files
author
David Noble
committed
Documentation update
Signed-off-by: David Noble <[email protected]>
1 parent 8a66998 commit 779d91a

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

examples/searchcommands_app/README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,28 +19,31 @@ The app is tested on Splunk 5 and 6. Here is its manifest:
1919
│ ├── simulate.py .............. SimulateCommand implementation
2020
│ ├── sum.py ................... SumCommand implementation
2121
│   └── countmatches.py .......... CountMatchesCommand implementation
22-
└── default
23-
├── data
24-
│   └── ui
25-
│   └── nav
26-
│   └── default.xml ..
27-
├── app.conf ................. Used by Splunk to maintain app state [1]
28-
├── commands.conf ............ Search command configuration [2]
29-
└── logging.conf ............. Python logging[3] configuration in ConfigParser[4] format
22+
├── default
23+
│ ├── data
24+
│ │   └── ui
25+
│ │   └── nav
26+
│ │   └── default.xml ..
27+
│ ├── app.conf ................. Used by Splunk to maintain app state [1]
28+
│ ├── commands.conf ............ Search command configuration [2]
29+
│ ├── logging.conf ............. Python logging[3] configuration in ConfigParser[4] format
30+
│ └── searchbnf.conf ........... Search assistant configuration [5]
31+
└── metadata
32+
└── local.meta ............... Permits the search assistant to use searchbnf.conf[6]
3033
```
3134
**References**
3235
[1] [app.conf](http://docs.splunk.com/Documentation/Splunk/6.0.1/Admin/Appconf app.conf)
3336
[2] [commands.conf](http://docs.splunk.com/Documentation/Splunk/6.0.1/Admin/Commandsconf)
3437
[3] [Python Logging HOWTO](http://docs.python.org/2/howto/logging.html)
3538
[4] [ConfigParser—Configuration file parser](http://docs.python.org/2/library/configparser.html)
39+
[5] [searchbnf.conf](http://docs.splunk.com/Documentation/Splunk/6.0.1/admin/Searchbnfconf)
40+
[6] [Set permissions in the file system](http://goo.gl/1oDT7r)
3641

3742
## Installation
3843

39-
+ Install the app by copying the `searchcommands_app` directory to
40-
`$SPLUNK_HOME/etc/apps/searchcommands_app`.
44+
+ Install the app by copying the `searchcommands_app` directory to `$SPLUNK_HOME/etc/apps/searchcommands_app`.
4145

42-
+ Recursively copy `splunklib/searchcommands/*` to
43-
`$SPLUNK_HOME/etc/apps/searchcommands_app/splunklib/searchcommands`
46+
+ Recursively copy `splunklib` to `$SPLUNK_HOME/etc/apps/searchcommands_app/bin`
4447

4548
+ (Re)start Splunk so that the app is recognized.
4649

0 commit comments

Comments
 (0)