#Generate manpage from command's output. Invoke with "sh", -h for help. #Program name. NAME="" #The binary, (relative path to this script). Invoked with "-h" for help text (stdout or stderr) BINARY=../src/ #Description: brief string for the start of the man page. DESCRIPTION="" #Synopsis text, or leave blank to omit. Add leading spaces to avoid automatic paragraph formatting. SYNOPSIS=`cat <<-EOT EOT` #Section of manual. SECTION=1 #Program group/source SOURCE="" #Time when the manual was written (string). DATE="September 2013" #See also. Array, Each manpage with its section. SEE_ALSO=( "man (1)" "man (7)" "help2man (1)" "undocumented (7)" "bash (1)" ) #Prefix each line with a leading space? Prevent paragraphs from being line-wrapped. true/false LEADING_SPACE=true #Author and copyright (optional string). LICENSE="GPL v3+" AUTHOR="The author of $NAME and this manual page is , <>"$'\n.br\n'"Copyright $DATE; this is Free Software ($LICENSE), see the source for copying conditions." # ---- END CONFIGURATION ----- BZIP2_FILE=`dirname $0`/$NAME.$SECTION.bz2 COMPRESS=bzip2 if [ "$1" == -h ]; then echo "This generates the man page for $NAME. Run with no args to create $BZIP2_FILE, use '-' for uncompressed stdout, or specify a filename."; exit 1; fi if [ "$1" == - ] ;then COMPRESS=cat; BZIP2_FILE=/dev/stdout; elif [ -n "$1" ] ;then BZIP2_FILE=$1; fi #Generate title and name text. TITLE=$(echo $NAME | tr '[A-Z]' '[a-z]')" - $DESCRIPTION" NAME=$(echo $NAME | tr '[a-z]' '[A-Z]') #Look up section name title. SECTION_NAMES=( "zero" "User Commands" "System calls" "Library calls" "Special files (devices)" "File formats and conventions" "Games" "Conventions and miscellaneous" "System management commands" ) SECTION_NAME=${SECTION_NAMES[$SECTION]} #Optional sections Synopsis. Author [ -n "$SYNOPSIS" ] && SYNOPSIS=".SH SYNOPSIS"$'\n'"$SYNOPSIS" [ -n "$AUTHOR" ] && AUTHOR=".SH AUTHOR"$'\n'"$AUTHOR" #Get the help from the binary with -h. It may be on stdout or stderr. #Double backslashes to prevent groff interpreting eg: "\fIformattedtext\fR" #For any line that begins with a dot or single-quote, prefix with the non-printing character '\&'. Otherwise, eg ".I formattedtext" gets interpreted. #If necessary, prefix each line with " ": prevent groff from wrapping paragraphs. (double-newlines are safe; multiple blank-lines are converted to a single blankline) [ "$LEADING_SPACE" == true ] && SPACE=" " || SPACE=''; HELPTEXT=$(`dirname $0`/$BINARY -h 2>&1 | sed -e 's/\\/\\\\/g' -e 's/$^\(\.\|'"'"'$.*\)/\\\&\1/g' -e "s/$.*$/$SPACE\1/g") #Build up the see-also list. ".BR" macro means bold, then roman. Y=''; for X in "${SEE_ALSO[@]}"; do Y="$Y.BR $X,"$'\n'; done; SEE_ALSO=${Y%,$'\n'} #Now write out the manual, in nroff format. Bzip. cat <<-END_OF_MANUAL | $COMPRESS > $BZIP2_FILE .TH "$NAME" "$SECTION" "$DATE" "$SOURCE" "$SECTION_NAME" .SH NAME $TITLE $SYNOPSIS .SH DESCRIPTION $HELPTEXT $AUTHOR .SH "SEE ALSO" $SEE_ALSO END_OF_MANUAL #Also create the HTML version,fixing spacing, and munging email addresses. [ "$1" != "-" ] && cat $BZIP2_FILE | $COMPRESS -d | man2html -r - | tail -n +3 | sed -e 's//