M4.9
上传用户:jnzhq888
上传日期:2007-01-18
资源大小:51694k
文件大小:8k
源码类别:

操作系统开发

开发平台:

WINDOWS

  1. .CD "m4 (en macro processor"
  2. .SX "m4fR [fB(enD fInamefR = fIvaluefR]fR [fB(enU fInamefR] 
  3. .FL "(enD" "Define a symbol"
  4. .FL "(enU" "Undefine a symbol"
  5. .EY "m4 <m4test" "Run M4"
  6. .PP
  7. fIM4fR is a macro processor intended as a front end
  8. for Ratfor, Pascal, and other languages that do not have a built-in macro 
  9. processing capability.  M4 reads standard input, the processed text is 
  10. written on the standard output.
  11. .PP
  12. The options and their effects are as follows:
  13. .in +0.5i
  14. .ta 1.25i
  15. (enD name[=val] Defines name to val, or to null in val's absence.
  16. .br
  17. (enU name Undefines name.
  18. .in -0.5i
  19. .PP
  20. Macro calls have the form: name(arg1,arg2, ..., argn)
  21. The *(OQ(*(CQ must immediately follow the name of the macro.  
  22. If the name of a 
  23. defined macro is not followed by a ( it is taken to be a call of that macro 
  24. with no arguments, i.e. name().  Potential macro names consist of alphabetic 
  25. letters and digits.
  26. .PP
  27. Leading unquoted blanks, tabs and newlines are ignored while collecting 
  28. arguments.  Left and right single quotes are used to quote strings.  The value 
  29. of a quoted string is the string stripped of the quotes.
  30. .PP
  31. When a macro name is recognized, its arguments are collected by searching 
  32. for a matching ).  If fewer arguments are supplied than are in the macro 
  33. definition, the trailing arguments are taken to be null.  Macro evaluation 
  34. proceeds normally during the collection of the arguments, and any commas or 
  35. right parentheses which happen to turn up within the value of a nested call 
  36. are as effective as those in the original input text.  (This is typically 
  37. referred as  inside-out macro expansion.)  After argument collection, the 
  38. value of the macro is pushed back onto the input stream and rescanned.  
  39. .PP
  40. M4 makes available the following built-in macros.  They may be 
  41. redefined, but once this is done the original meaning is lost.  Their values 
  42. are null unless otherwise stated.
  43. .PP
  44. fBdefine "(name [, val])"fR the second argument is installed as the value of 
  45. the macro whose name is the first argument.  If there is no second argument, 
  46. the value is null.  Each occurrence of $ n in the replacement text, where n is 
  47. a digit, is replaced by the n -th argument.  Argument 0 is the name of the 
  48. macro; missing arguments are replaced by the null string.
  49. .PP
  50. fBdefn "(name [, name ...])"fR returns the quoted definition of its 
  51. argument(s). Useful in renaming macros.
  52. .PP
  53. fBundefine "(name [, name ...])"fR removes the definition of the macro(s) 
  54. named. If there is more than one definition for the named macro, (due to 
  55. previous use of pushdef) all definitions are removed.
  56. .PP
  57. fBpushdef "(name [, val])"fR like define, but saves any previous definition 
  58. by stacking the current definition.
  59. .PP
  60. fBpopdef "(name [, name ...])"fR removes current definition of its 
  61. argument(s), exposing the previous one if any.
  62. .PP
  63. fBifdef "(name, if-def [, ifnot-def])"fR if the first argument is defined, 
  64. the value is the second argument, otherwise the third.  If there is no third 
  65. argument, the value is null.  A word indicating the current operating system 
  66. is predefined.  (e.g. unix or vms).
  67. .PP
  68. fBshift "(arg, arg, arg, ...)"fR returns all but its first argument.  The 
  69. other arguments are quoted and pushed back with commas in between.  The 
  70. quoting nullifies the effect of the extra scan that will subsequently be 
  71. performed.
  72. .PP
  73. fBchangequote "(lqchar, rqchar)"fR change quote symbols to the first and 
  74. second arguments.  With no arguments, the quotes are reset back to the default 
  75. characters. (i.e., `').
  76. .PP
  77. fBchangecom "(lcchar, rcchar)"fR change left and right comment markers from 
  78. the default # and newline.  With no arguments, the comment mechanism is reset 
  79. back to the default characters.  With one argument, the left marker becomes 
  80. the argument and the right marker becomes newline.  With two arguments, both 
  81. markers are affected.
  82. .PP
  83. fBdivert "(divnum)"fR maintains 10 output streams, numbered 0-9.  Initially 
  84. stream 0 is the current stream. The divert macro changes the current output 
  85. stream to its (digit-string) argument.  Output diverted to a stream other than 
  86. 0 through 9 is lost.
  87. .PP
  88. fBundivert "([divnum [, divnum ...]])"fR causes immediate output of text from 
  89. diversions named as argument(s), or all diversions if no argument.  Text may 
  90. be undiverted into another diversion.  Undiverting discards the diverted text. 
  91. At the end of input processing, M4 forces an automatic undivert unless is 
  92. defined.
  93. .PP
  94. fBdivnum "()"fR returns the value of the current output stream.
  95. .PP
  96. fBdnl "()"fR reads and discards characters up to and including the next 
  97. newline.
  98. .PP
  99. fBifelse "(arg, arg, if-same [, ifnot-same | arg, arg ...])"fR has three or 
  100. more arguments.  If the first argument is the same string as the second, then 
  101. the value is the third argument.  If not, and if there are more than four 
  102. arguments, the process is repeated with arguments 4, 5, 6 and 7.  Otherwise, 
  103. the value is either the fourth string, or, if it is not present, null.
  104. .PP
  105. fBincr "(num)"fR returns the value of its argument incremented by 1.  The 
  106. value of the argument is calculated by interpreting an initial digit-string as 
  107. a decimal number.
  108. .PP
  109. fBdecr "(num)"fR returns the value of its argument decremented by 1.
  110. .PP
  111. fBeval "(expression)"fR evaluates its argument as a constant expression, 
  112. using integer arithmetic.  The evaluation mechanism is very similar to that of 
  113. cpp (#if expression).  The expression can involve only integer constants and 
  114. character constants, possibly connected by the binary operators
  115. .HS
  116. .in +0.5i
  117. *    /    %    +    -    >>   <<    <    >   <=   >=   ==   !=   &    ^    |     &&   ||
  118. .in -0.5i
  119. .HS
  120. or the unary operators - ! or tilde or by the ternary operator ? : .  
  121. Parentheses may be used for grouping. Octal numbers may be specified as in C.
  122. .PP
  123. fBlen "(string)"fR returns the number of characters in its argument.
  124. .PP
  125. fBindex "(search-string, string)"fR returns the position in its first 
  126. argument where the second argument begins (zero origin), or 1 if the second 
  127. argument does not occur.
  128. .PP
  129. fBsubstr "(string, index [, length])"fR returns a substring of its first 
  130. argument. The second argument is a zero origin number selecting the first 
  131. character (internally treated as an expression); the third argument indicates 
  132. the length of the substring.  A missing third argument is taken to be large 
  133. enough to extend to the end of the first string. 
  134. .PP
  135. fBtranslit  "(source, from [, to])"fR transliterates the characters in its 
  136. first argument from the set given by the second argument to the set given by 
  137. the third.  If the third argument is shorter than the second, all extra 
  138. characters in the second argument are deleted from the first argument. If the 
  139. third argument is missing altogether, all characters in the second argument 
  140. are deleted from the first argument.
  141. .PP
  142. fBinclude "(filename)"fR returns the contents of the file that is 
  143. named in the argument.
  144. .PP
  145. fBsinclude "(filename)"fRis identical to include, except that it says nothing 
  146. if the file is inaccessable.
  147. .PP
  148. fBpaste "(filename)"fR returns the contents of the file named in the argument
  149. without any processing, unlike include.
  150. .PP
  151. fBspaste "(filename)"fR is identical to paste, except that it says nothing if
  152. the file is inaccessibl[De.
  153. .PP
  154. fBsyscmd "(command)"fR executes the 
  155. .Ux
  156. command given in the first argument.  
  157. No value is returned.
  158. .PP
  159. fBsysval "()"fR is the return code from the last call to syscmd.
  160.  .PP
  161. fBmaketemp *(OQ(string)"fR fills in a string of XXXXXX in its argument with the 
  162. current process ID.
  163. .PP
  164. fBm4exit "([exitcode])"fR causes immediate exit from M4.  Argument 1, if 
  165. given, is the exit code; the default is 0.
  166. .PP
  167. fBm4wrap "(m4-macro-or-built-n)"fR argument 1 will be pushed back at final 
  168. EOF; example: m4wrap(`dumptable()').
  169. .PP
  170. fBerrprint "(str [, str, str, ...])"fR prints its argument(s) on stderr. If 
  171. there is more than one argument, each argument is separated by a space during 
  172. the output.  An arbitrary number of arguments may be supplied.
  173. .PP
  174. fBdumpdef "([name, name, ...])"fR prints current names and definitions, for 
  175. the named items, or for all if no arguments are given.
  176. .SP 1
  177. .SS "Author"
  178. .SP 1
  179. .PP
  180. fIM4fR was written by Ozan S. Yigif.