Addcomment

Go back to top

ADDCOMMENT

FUNCTION

AddComment rewrites a text file with every line commented out.

DESCRIPTION

AddComment makes each line of a text file into a GCG style comment. Blank lines are unchanged. All other lines have a "!" inserted at the beginning.

The program is intended as a utility for including text files as part of data files.

AUTHOR

This program was written by Peter Rice (E-mail: pmr@sanger.ac.uk Post: Informatics Division, The Sanger Centre, Hinxton Hall, Cambridge, CB10 1RQ, UK).

All EGCG programs are supported by the EGCG Support Team, who can be contacted by E-mail (egcg@embnet.org).

EXAMPLE

Here is a sample session with AddComment 

  
  
  % addcomment
  
   ADDCOMMENT of what file ?  EGenRunDoc:addcomment.cmd
  
   What should I call the output file (* addcomment.add *) ?
  
  %

OUTPUT

The output from AddComment is a new text file with all lines commented out. 

  
  
  !Minimum syntax: ^|$|%\| addcomment [^|/|-\|INfile=]GenRunDoc:addcomment.cmd
   ^|/|-\|Default
  
  !.tp 3
  !Prompted Parameters:
  
  ![^|/|-\|OUTfile=]addcomment.add   Output file
  
  !Local Data Files: None
  
  !.tp 5
  !Optional Parameters: None

COMMAND-LINE SUMMARY

All parameters for this program may be put on the command line. Use the option -CHEck to see the summary below and to have a chance to add things to the command line before the program executes. In the summary below, the capitalized letters in the qualifier names are the letters that you must type in order to use the parameter. Square brackets ([ and ]) enclose qualifiers or parameter values that are optional. For more information, see "Using Program Parameters" in Chapter 3, Basic Concepts: Using Programs in the GCG User's Guide. 

  
  
  Minimum syntax: % addcomment [-INfile=]EGenRunDoc:addcomment.cmd -Default
  
  Prompted Parameters:
  
  [-OUTfile=]addcomment.add   Output file
  
  Local Data Files: None
  
  Optional Parameters: None

Printed: April 22, 1996 15:52 (1162)