ENH: Added usage notes to header of foamTags script

This commit is contained in:
andy 2012-06-01 09:46:44 +01:00
parent e1ebafee22
commit 74d6e813ca

View File

@ -3,7 +3,7 @@
# ========= | # ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox # \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration | # \\ / O peration |
# \\ / A nd | Copyright (C) 2011 OpenFOAM Foundation # \\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
# \\/ M anipulation | # \\/ M anipulation |
#------------------------------------------------------------------------------- #-------------------------------------------------------------------------------
# License # License
@ -28,6 +28,13 @@
# Description # Description
# Build the tags files for all the .C and .H files # Build the tags files for all the .C and .H files
# #
# This script is designed for use with emacs
#
# For use, download/install 'exuberant ctags'. The executable for this
# package is called ctags, which conflicts with the 'standard' version
# of ctags found on most *nix systems. Rename the exuberant ctags
# executable to ectags.
#
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------
if [ $# -ne 0 ] if [ $# -ne 0 ]