OctothorpShriek #!/bin/sh

example.sh

#!/bin/sh
#
# Copyright (c) YYYY NAME <EMAIL>
#
# Permission to use, copy, modify, and distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#

set -e

readonly PROGNAME="$(basename $0)"
readonly VERSION='v1.0'

usage() {
	echo "usage: $PROGNAME [-a] [-b arg] cmd"
}

aflag=false
bflag=""
cmd=""

while getopts ":ab:" opt;do
	case $opt in
		a) aflag=true;;
		b) bflag="$OPTARG";;
		:) echo "$PROGNAME: option requires an argument -- $OPTARG";
		   usage; exit 1;;
		\?) echo "$PROGNAME: unknown option -- $OPTARG";
		   usage; exit 1;;
		*) usage; exit 1;;
	esac
done
shift $(( $OPTIND - 1 ))

if [ -z "$1" ]; then
	echo "$PROGNAME: cmd expected"
	usage
	exit 1
else
	cmd="$1"
	shift
fi

if [ $# -ge 1 ]; then
	echo "$PROGNAME: invalid trailing chars -- $@"
	usage
	exit 1
fi

set -u

# More checks on options here

# Your code here

example.1

.\" Copyright (c) YYYY NAME <EMAIL>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.\" The following requests are required for all man pages.
.\"
.Dd $Mdocdate$
.Dt UTILITY NAME 1
.Os
.Sh NAME
.Nm utility name
.Nd short description
.Sh SYNOPSIS
.Nm
.Op Fl a
.Op Fl b Ar arg
.Ar cmd
.Sh DESCRIPTION
The
.Nm
utility do some interesting stuff.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl a
Turn a knob on.
.It Fl b
Use the optional stuff named
.Ar arg
.El
.Sh SEE ALSO
.Xr stuff 1