• General Notes About sh Mode
• Specific Notes About sh Mode
  • Keywords
  • Shift-Command-Double-Click
  • File Marking
  • Functions Parsing
  • Adding a sh Prefs file
• Unix Commands Help
• The sh Scripts Menu
• Future Versions
• Known problems
• License and Disclaimer

General Notes About sh Mode

1. This mode serves primarily to make it easier to write unix environment shell scripts -- it colorizes keywords, and sets some indentation, electric, word break, and commenting preferences.
2. sh mode contains a full set of electric completions, as well as a Completions Tutorial via the Alpha ↣ Shell Scripts Mode Setup menu item.
3. The sh mode allows for user customization of keyword dictionaries via the Alpha ↣ Shell Scripts Mode Setup ↣ Mode Preferences… dialog. New keywords and color changes will take effect immediately, without the need for a restart or changing windows.
4. Instructions for editing a shPrefs.tcl file are given below. Any keywords added will not only be colorized, but included in the completions routines as well.
5. sh mode has Mark File and Parse Function capabilities. See the Marks popup (📖) and the Parse popup (⚙).
6. Finally, on-line help is available for the sh mode through Shift-Command-Double-Clicking. The URL to which the keywords are sent can be configured in the Mode Preferences dialog.

Specific Notes About sh Mode

Keywords

Shift-Command-Double-Click

    spss
    stata
    emacs

File Marking

• the section headers, i-e lines that start with '### ' or '#### '.
• the case|for|if|until|while blocks.

Functions Parsing

    foo () {...}

    function foo {...}

Adding a sh Prefs file

    set shUserCommands {
    	blah bladdity
    }
    
    set shUserPrograms {
    	blah2 bladdity2
    }
    
    set shUserFlags {
    	blah3 bladdity3
    }
    
    sh::colorizesh

Unix Commands Help

• https://unixhelp.ed.ac.uk/CGI/man-cgi?ls
• https://campuscgi.princeton.edu/man?ls
• https://www.freebsd.org/cgi/man.cgi?query=ls

• University of Edinburgh, Scotland: https://unixhelp.ed.ac.uk/cgi-bin/unixhelp_search?search_term=rmdir&max_hits=20
• De Montfort University, East Midlands United Kingdom: https://www.dmu.ac.uk/cgi-bin/unixhelp_search?search_term=rmdir&max_hits=20
• József Attila University, Szeged Hungary: https://www.cab.u-szeged.hu/cgi-bin/unixhelp_search?search_term=rmdir&max_hits=20
• Swiss Federal Institute of Technology, Lausanne Switzerland: https://dgrwww.epfl.ch/cgi-bin/unixhelp_search?search_term=rmdir&max_hits=20

The sh Scripts Menu

sh Scripts Home Page

Opens the url specified in the sh Scripts Home Page url preference.

Www Command Help

Opens a dialog like this allowing you to enter a unix command to send to the various unix help urls. See the section above on Unix Commands Help for more information.

sh Mode Options

This is a submenu allowing you to set some sh mode flag preferences, or to open this file.

New Comment

Inserts a new paragraph style comment just prior to the current block of commands, such as this

      ## 
       # 
       ##

The template can be customized using the Comment Template menu item.
Note that if the Navigate Blocks preference is set, then the new comment will be inserted at the beginning of the current block, as defined by an empty line.

    ## 
     # 
     ##
    •	rm -f    ../data-temp
    	ln -s    /var/scratch/benefits-cps/  ../data-temp/

Comment Template

Creates (or changes) the sh Custom Template preference. Simply type in the custom template, highlight it, and then use this menu item to save the selected text as the template. To create bullets that you can navigate with the tab key, be sure to insert two bullets for each stop.

Next Block/Command

Jump to the next block of commands, as defined by being separated by at least one empty line, or to the next command as determined by indentation.

Prev Block/Command

Jump to the previous block of commands, or the previous command as determined by indentation.

Select Block/Command

Select the entire block/command in which the cursor currently resides.

Reformat Block

Reformat the entire block/command in which the cursor currently resides. This is essentially a shortcut for the menu items Edit ↣ Select Paragraph and Text ↣ Indent Selection.

Future Versions

Known problems

License and Disclaimer

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Craig Barton Upright nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.