Programming guidelines and style Post: 303001684

Sponsored Content

Top Forums Shell Programming and Scripting Programming guidelines and style Post 303001684 by drl on Wednesday 9th of August 2017 11:38:33 AM

08-09-2017

Registered User

Hi.

This is a meta-answer for shell coding.

1) Write however you want, then run your code through a semantic and syntax checker:

Code:

shellcheck      analyse shell scripts (man)
Path    : /usr/bin/shellcheck
Version : ShellCheck - shell script analysis tool
Type    : ELF 64-bit LSB executable, x86-64, version 1 (SYSV ...)
Help    : probably available with -h
Repo    : Debian 8.8 (jessie) 
Home    : http://hackage.haskell.org/package/ShellCheck (pm)

As you progress, you can skip this as the first step, and go right to testing, coming back if your code fails.

then through a beautifier (which could easily apply to all languages):

Code:

beautysh        Tidy bash scripts, written in python3. (what)
Path    : ~/bin/beautysh
Version : - ( local: RepRev 1.4, ~/bin/beautysh, 2016-03-31 )
Length  : 174 lines
Type    : Python script, ASCII text executable
Shebang : #!/usr/bin/env python3
Home    : https://github.com/bemeurer/beautysh (doc)
Modules : (for python codes)
  re
  sys

2) Shell (as a programming language for more than trivial scripting) is dead. Perl rules in its place (though it is now being strongly challenged by Python). -- Basic Linux and Unix bibliography , especailly parts:

a) Books on Shell, Script, and Web Development

b) Good Programming Style

Best wishes ... cheers, drl

drl

View Public Profile for drl

Find all posts by drl

4 More Discussions You Might Find Interesting

1. Forum Support Area for Unregistered Users & Account Problems

Guidelines For Posting Here

This area is not for technical questions. It is reserved for unregistered users who have a question or registered users who have trouble with their account. Other posts will be deleted by the moderators.

2. What is on Your Mind?

Guidelines for Posting Here

This area is not for forum specific technical questions. Please post forum specific technical questions in the best forum, not in the lounge. However, if your idea or question is not covered clearly in a forum, please post it here. Discuss whatever is on your mind. Technical topics welcome...

3. Shell Programming and Scripting

Unix Shell Scripting Guidelines

Hi, I was wondering if any of you guys have developed shell scripting guidelines for writing unix shell scripts effectively. This includes naming standards, comments, indentation, error handing after unix comands, use of exported variables, sending notifications, functions, logging etc... ...

4. Programming

Building Block style programming Book

Hello to all, Here is my situation. Some time in the mid-80's I stumbled across a small white programming book - can't remember the name but it was unique in that it started right out giving instructions on creating building blocks in code as a foundation for a complete system. The book was...

LEARN ABOUT OPENSOLARIS

shells

shells(4)							   File Formats 							 shells(4)

NAME

       shells - shell database

SYNOPSIS

       /etc/shells

DESCRIPTION

       The shells file contains a list of the shells on the system. Applications use this file to determine whether a shell is valid. See getuser-
       shell(3C). For each shell a single line should be present, consisting of the shell's path, relative to root.

       A hash mark (#) indicates the beginning of a comment; subsequent characters up to the end of the line are not interpreted by  the  routines
       which search the file. Blank lines are also ignored.

       The following default shells are used by utilities: /bin/bash, /bin/csh, /bin/jsh, /bin/ksh, /bin/ksh93, /bin/pfcsh, /bin/pfksh, /bin/pfsh,
       /bin/sh, /bin/tcsh, /bin/zsh, /sbin/jsh, /sbin/sh, /usr/bin/bash, /usr/bin/csh, /usr/bin/jsh, /usr/bin/ksh, /usr/bin/ksh93, /usr/bin/pfcsh,
       /usr/bin/pfksh, /usr/bin/pfsh, and /usr/bin/sh, /usr/bin/tcsh, /usr/bin/zsh, and /usr/sfw/bin/zsh. /etc/shells overrides the default list.

       Invalid shells in /etc/shells could cause unexpected behavior, such as being unable to log in by way of ftp(1).

FILES

       /etc/shells    list of shells on system

SEE ALSO

       vipw(1B), ftpd(1M), sendmail(1M), getusershell(3C), aliases(4)

SunOS 5.11							    20 Nov 2007 							 shells(4)