User:Riviera/Go fish

From XPUB & Lens-Based wiki

In the shell I find a marvelous mess of constellations, nebulae, interstellar gaps, awesome gullies, that provokes in me an indescribable sense of vertigo, as if I am hanging from earth upside down on the brink of infinite space, with terrestrial gravity still holding me by the heels but about to release me any moment.


Nancy Mauro-Flude, 2008

The shell is a computer programme which launches other programmes. This efficient, textual method of interacting with a computer raises practical and ethical questions. On a practical level the question arises as to which shell to choose from. bash is the default login shell on Linux distributions such as Debian and Rasbian. However, it is possible to choose a different shell. This choice leads to a discussion of the ethical issue of accessibility. A feature of this discussion involves unpacking the relationship between norms and defaults. In this wiki page I outline some implications of switching to a shell other than bash by way of several examples. I describe why I have chosen to use one shell, rather than another shell and argue in favour of fish as a default shell. Overall I argue that shell scripting (with fish or bash) could be an effective way in which to activate Radio Worm's sonic archive.

fish in practice

fish (https://fishshell.com/) has many features that other shells do not have. This includes enhanced autocompletion, a different way of scripting, improved syntax highlighting and idiosyncratic configuration. Three quarters of these features make it easier to get started with using the command line to interface with the computer. In implementing a different scripting language to bash, fish scripts pose a hurdle relating to interoperability. One must have access to a working installation of the software to run the script and often this is not the case by default.

fish departs from it's normative counterpart bash in both helpful and obscure ways. Firstly, there is no file such as .fishrc. Instead fish keeps configuration data in various user-specific and site-wide configuration files. Extending the functional capabilities of the shell involves adding scripts under ~/.config/fish/functions/. Command expansion is written differently. For more examples, see fish for bash users.

Going Fishing: A Syntax Highlighter

Below are two fish scripts, the second works in tandem with the first. The first function, highlight, utilises the sed command to edit HTML snippets generated by Emacs' Org Mode's HTML export backend. The second script works by calling the highlight function several times on the same file. Really this should be a single script, but I cannot figure out how to execute sed this many times in a row...

higlight.fish

#! /usr/bin/fish

function highlight -d "Highlight HTML code" -a file

   argparse --name='highlight' 'h/help' -- $argv;
   sed -i 's/<pre/<div/' $argv;
   sed -i 's/<\/pre>/<\/div>/' $argv;
   sed -i 's/class=/style=/' $argv;
   sed -i -E 's/"src src-[[:alpha:]]*"/"font-family: Monospace; background-color: #dbe6f0;"/' $argv;
   sed -i 's/"color:teal"/"color:teal"/' $argv;
   sed -i 's/"color:teal"/"color:teal"/' $argv;
   sed -i 's/"color:green"/"color:green"/' $argv;
   sed -i 's/"color:yellow"/"color:yellow"/' $argv;
   sed -i 's/"color:orange"/"color:orange"/' $argv;
   sed -i 's/"color:olive"/"color:olive"/' $argv;
   sed -i 's/"color:gray"/"color:gray"/' $argv;
   sed -i 's/"color:purple"/"color:purple"/' $argv;

end

The s command in sed language is a shorthand for substitute. s commands are of the form

's/find/replace/'

With the s command, sed queries a text file for the presence of a particular string, or regular expression, and replaces what is found with user defined text. In the above example, classes of HTML elements are restyled with colour to highlight different parts of the script. Represented as a table, the changes are:

find replace
<pre <div
</pre> </div>
class= style=
"src src-[[:alpha:]]*" "font-family: Monospace; background-color: #dbe6f0"
"org-comment-delimiter" "color:teal"
"org-comment" "color:teal"
"org-keyword" "color:green"
"org-function-name" "color:yellow"
"org-variable-name" "color:orange"
"org-string" "color:olive"
"org-constant" "color:gray"
"org-builtin" "color:purple"


higlight_all.fish

#! /usr/bin/fish

function highlight_all -d "Call the highlight command several times" -a file

   set -l options (fish_opt -s h -l help)
   argparse --name='highlight_all' 'h/help' -- $argv;
   for n in (seq 1 5);
       highlight $argv;
   end

end

This command calls highlight multiple times to ensure the script runs to completion. I could improve this such that only one script is required.