source: iovar-bash/README @ 0:15ffd1df08ea

Last change on this file since 0:15ffd1df08ea was 0:15ffd1df08ea, checked in by Shawn Wilson <shawn@…>, 19 months ago

saw_031117_1 - Initial commit for iovar-bash.

File size: 1.2 KB
Line 
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
13
14Installation
15------------
16
17You can install it system-wide by simply copying the script into one of your $PATH directories, e.g.::
18
19    $ sudo cp iosh /bin/
20
21
22Configuration
23-------------
24
25Adjust the IOSH variable in the script to reflect the location of the running IOVAR instance.
26
27
28Using
29-----
30
31You can call the script from the terminal to interact with IOVAR like any other shell::
32
33    $ iosh
34    iosh $ echo Now testing the IOVAR shell.
35    iosh $ echo IOVAR version is $IOVAR_VERSION.
36
37You may also write scripts in the IOVAR shell language.
38
39Manually execute a script using IOVAR::
40
41    $ iosh my_script.sh
42
43Automatically execute IOVAR shell with hash-bang in script...::
44
45    my_script.sh
46    ------------
47    #!/bin/iosh
48    echo This is an example IOVAR shell script.
49    echo IOVAR version is $IOVAR_VERSION.
50
51...then simply call the script (but first make sure execute permission is set)::
52
53    $ chmod +x my_script.sh
54    $ ./my_script.sh
55
Note: See TracBrowser for help on using the repository browser.