source: iovar-bash/README

tip
Last change on this file was 1:d9880b0b57ef, checked in by Shawn Wilson <shawn@…>, 19 months ago

saw_031117_2 - Add example reference to the "help" command.

File size: 1.2 KB
RevLine 
[0]1Copyright (C) 2017 Virgo Venture, Inc.
2@%@~LICENSE~@%@
3
4==========
5iovar-bash
6==========
7
8The included BASH script allows you to easily interact with an IOVAR instance from the terminal.
9
10Read further to install the shell, or you can try it out locally::
11
12    $ ./iosh
[1]13    iosh $ help
[0]14
15Installation
16------------
17
18You can install it system-wide by simply copying the script into one of your $PATH directories, e.g.::
19
20    $ sudo cp iosh /bin/
21
22
23Configuration
24-------------
25
26Adjust the IOSH variable in the script to reflect the location of the running IOVAR instance.
27
28
29Using
30-----
31
32You can call the script from the terminal to interact with IOVAR like any other shell::
33
34    $ iosh
35    iosh $ echo Now testing the IOVAR shell.
36    iosh $ echo IOVAR version is $IOVAR_VERSION.
37
38You may also write scripts in the IOVAR shell language.
39
40Manually execute a script using IOVAR::
41
42    $ iosh my_script.sh
43
44Automatically execute IOVAR shell with hash-bang in script...::
45
46    my_script.sh
47    ------------
48    #!/bin/iosh
49    echo This is an example IOVAR shell script.
50    echo IOVAR version is $IOVAR_VERSION.
51
52...then simply call the script (but first make sure execute permission is set)::
53
54    $ chmod +x my_script.sh
55    $ ./my_script.sh
56
Note: See TracBrowser for help on using the repository browser.