aboutsummaryrefslogtreecommitdiffstats
path: root/USAGE
blob: 75e92a39e575902a79de9d2a0f27bd89775a7ae4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
ariketa: bash example code quickloader for presentations
========================================================

usage
-----
    To load ariketa, source it into the bash session you wish to use for the
    presentation.  If no array name or filename is provided to source the
    _examples array from, ariketa will attempt to load 'config/examples.sh'
    from the ariketa directory:
      source ariketa
      source ariketa [-a|--array EXAMPLES_ARRAYNAME]
      source ariketa [EXAMPLES_FILENAME]

    When an example is displayed, it may be edited like any command line and
    executed normally by pressing enter.  Use the following key bindings to
    navigate through your examples:

        alt-H:     display this USAGE text

        alt-w:     load previous example
        alt-e:     load next example
        alt-a:     reload current example
        alt-h:     display current example with syntax highlighting

        alt-W:     load previous example without clearing the screen
        alt-E:     load next example without clearing the screen
        alt-A:     reload current example without clearing the screen

        alt-s:     side by side diff of previous and current example
        alt-S:     side by side diff of prev/cur examples with highlighting
        alt-P:     toggle between ariketa PS2 header and original setting

configuration
-------------
    To load examples into ariketa, edit the 'examples.sh' file in the
    'config' directory.  This file should be a sourceable bash script which
    creates an indexed array named '_examples'. An sample config is located in
    'config/examples.sh.sample'.