Plan 9 from Bell Labs’s /usr/web/sources/patch/applied/doc-man-8-newuser-usefossil/notes

Copyright © 2021 Plan 9 Foundation.
Distributed under the MIT License.
Download the Plan 9 distribution.


Fri Apr 1 08:25:23 EST 2005 rsc
    I applied most of the patch.  Some small notes about writing man pages:
    
    - .B means everything after this in fixed-width font"
    - .BR means alternating fixed-width and roman for successive args
    - so .BR foo looks like a typo (use .B foo)
    - and .B foo, looks bad (put the punctuation in roman with .BR foo ,)
    
    - if the man page isn't true but is simpler than the current story,
      think about (or ask about) making it true.  in this case, 
      mail -c is supposed to create new mail boxes.  you're not supposed
      to need the console.  and it does, if /mail/box is mode 777 like
      it should be.  i just fixed the proto file on sources so mail -c
      should start working again.
    
      now that mail -c works again the example is not really necessary
      anymore.
    
    - if there's only one example use .SH EXAMPLE not EXAMPLES.
    
    - in general i err on the side of leaving the original author's
      voice (usually rob's) in the man page, so for example the parens
      around "There is no need to reboot." stay.
    
    I appreciate your effort.  I'm pointing this stuff out just so
    that future submissions require less work on my part to apply.
    
    Thanks again.
    Russ


Bell Labs OSI certified Powered by Plan 9

(Return to Plan 9 Home Page)

Copyright © 2021 Plan 9 Foundation. All Rights Reserved.
Comments to [email protected].