[Python-checkins] CVS: python/dist/src/Doc/doc doc.tex,1.17,1.18

[Fred Drake]

Update of /projects/cvsroot/python/dist/src/Doc/doc
In directory seahag.cnri.reston.va.us:/home/fdrake/projects/python/Doc/doc

Modified Files:
	doc.tex 
Log Message:

Revise the description of \programopt, document \longprogramopt.


Index: doc.tex
===================================================================
RCS file: /projects/cvsroot/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.17
retrieving revision 1.18
diff -C2 -r1.17 -r1.18
*** doc.tex	2000/04/03 15:00:28	1.17
--- doc.tex	2000/04/11 18:52:52	1.18
***************
*** 507,513 ****
  
      \begin{macrodesc}{programopt}{\p{option}}
!       A command-line option to an executable program.
      \end{macrodesc}
  
      \begin{macrodesc}{refmodule}{\op{key}\p{name}}
        Like \macro{module}, but create a hyperlink to the documentation 
--- 507,521 ----
  
      \begin{macrodesc}{programopt}{\p{option}}
!       A command-line option to an executable program.  Use this only
!       for ``shot'' options, and include the leading hyphen.
      \end{macrodesc}
  
+     \begin{macrodesc}{longprogramopt}{\p{option}}
+       A long command-line option to an executable program.  This
+       should only be used for long option names which will be prefixed
+       by two hyphens; the hyphens should not be provided as part of
+       \var{option}.
+     \end{macrodesc}
+ 
      \begin{macrodesc}{refmodule}{\op{key}\p{name}}
        Like \macro{module}, but create a hyperlink to the documentation 
***************
*** 988,992 ****
  	must be stored as part of the documentation source tree,
  	though it may be used to format documents outside the
! 	tree.  Use \program{mkhowto} \programopt{-}\programopt{-help}
          for a list of
          command line options.
--- 996,1000 ----
  	must be stored as part of the documentation source tree,
  	though it may be used to format documents outside the
! 	tree.  Use \program{mkhowto} \longprogramopt{help}
          for a list of
          command line options.