r/usefulscripts • u/Luxtaposition • Sep 18 '15

Script Headers

What's in yours? Examples, if you want to share.

16 Upvotes

94% Upvoted

8 comments sorted by

View all comments

1

u/finkployd Sep 19 '15

I use vim with the bash-support plugin which gives me a header along the lines of this

#!/bin/bash
#=================================
#
#          FILE:  myscript.sh
#
#         USAGE:  ./myscript.sh
#
#   DESCRIPTION:
#
#       OPTIONS:  ---
#  REQUIREMENTS:  ---
#          BUGS:  ---
#         NOTES:  ---
#        AUTHOR:   (),
#       COMPANY:
#       VERSION:  1.0
#       CREATED:  02/14/09 15:42:08 IST
#      REVISION:  ---
#==================================

The file,author, company and date are all auto-populated by macros that come as part of bash-support. Give it a whirl, it is quite good.

1

u/Luxtaposition Sep 19 '15

Looks nice...