sh(9)

SYNOPSIS

*sh - UNIX shell files

FILES

hkshell.emf - UNIX shell file hook definition
shell.eaf - UNIX shell abbreviation file
shell.etf - UNIX shell programming language template file

EXTENSIONS

.sh - Bourne shell file
.ksh - Korn shell file
.csh - C-Shell file
.zsh - Z-Shell file
.login - Shell user login file
.profile - Shell user profile
.tcshrc - T-Shell start up file

MAGIC STRINGS

#![ \t]*/.*sh


MicroEmacs recognizes the magic string on the first line of the file used to locate the executable. The shell files may be extension less and are still recognized. Note that this is the typical method of identifying shell files and will recognize other files not mentioned above i.e. bash shells.

DESCRIPTION

The shell file type template provides simple hilighting of the shell files. It offers as well folding and support for displaying an outline of the functions of the shell script for easy navigation using the item-list(3) command. Further is is possible to expand abbreviations either via short strings using the expand-abbrev-handle(3) command and visual inserting abbreviations using the mouse by the abbrev-list(3) macro.

Folding and Information Hiding


Generic folding is enabled within the Shell files. The folds occur about the function keyword and the closing braces function...{...} located on the left-hand margin at the beginning of the line. The following commands are supported to show and hide the function bodies. collapse-all(3) (un)folds all regions in the file, collapse-current(3) (un)folds the current region.

List Items


Item listing is available and the key constructs of the file may be listed in the item-list.

Abbreviations


The installation comes with a default abbreviation file for shell editing which can be used by writing short abbreviations like "for", "if" or "fun" - for a Bourne shell or Z-shell function - and then pressing the key-binding for the expand-abbrev-handle(3) command. The list of abbreviations can be used interactively in the GUI version of MicroEmacs using the abbrev-list(3) command.

Short Cuts


The short cut keys used within the buffer are:-

C-c C-c - Comment out the current line.
C-c C-d - Uncomment the current line.
C-c C-e - Comment to the end of the line with stars (*).
A-C-i - Restyle the current region.
f2 - (un)fold the current region
f3 - (un)fold all regions
f6 - list items
esc f6 - close list items

NOTES

The file hook is implemented in the hkshell.emf file, the abbreviations are placed within the shell.eaf file, the template for the initialization of the new file is defined in the shell.etf file. To add your own abbreviations or your own template copy the files to your config folder and edit them within this folder.

BUGS

Functions defined without using the function keyword can't currenly folded and as well do not appear in the item-list outline.

There is a heavy bias towards Bourne, Korn and Zsh shells. The authors are not csh shell users so have probably missed a lot of csh features.

SEE ALSO

fvwm(9).

Supported File Types

(c) Copyright JASSPA 2025
Last Modified: 2025/08/28
Generated On: 2025/09/29