/contrib/groff/contrib/mom/examples/README.txt

https://bitbucket.org/freebsd/freebsd-head/ · Plain Text · 115 lines · 76 code · 39 blank · 0 comment · 0 complexity · 1129c23afad239f0ea7853dc74567e7b MD5 · raw file

  1. The files in this directory show mom in action.
  2. If you have downloaded and untarrred a version of mom from her
  3. homepage, you'll see that none of the example files come with
  4. corresponding PostScript (.ps) files, as they do with pre-compiled
  5. versions of groff, or groff built from source.
  6. I haven't included the PostScript output because I want to
  7. keep the mom archive as lean as possible. To view the PostScript
  8. output, process the files with groff and either
  9. a) send the output to a separate file for previewing with a
  10. PostScript viewer such as gv (ghostview), or
  11. b) to your printer.
  12. Using the file sample_docs.mom as an example, you would
  13. accomplish a) like this:
  14. groff -mom -Tps sample_docs.mom > sample_docs.ps
  15. gv sample_docs.ps
  16. Accomplishing b) depends on your printer setup, but a fairly
  17. standard way to do it would be
  18. groff -mom -Tps sample_docs.mom | lpr
  19. or
  20. groff -mom -Tps -l sample_docs.mom
  21. Note: I don't recommend previewing with gxditview because it doesn't
  22. render some of mom's effects properly.
  23. The files themselves
  24. --------------------
  25. All are set up for 8.5x11 inch paper (US letter).
  26. ***typesetting.mom**
  27. The file, typesetting.mom, demonstrates the use of typesetting tabs,
  28. string tabs, line padding, multi-columns and various indent styles,
  29. as well as some of the refinements and fine-tuning available via
  30. macros and inline escapes.
  31. Because the file also demonstrates a "cutaround" using a small
  32. picture (of everybody's favourite mascot, Tux), the PostScript file,
  33. penguin.ps has been included in the directory.
  34. ***sample_docs.mom***
  35. The file, sample_docs.mom, shows examples of three of the document
  36. styles available with the mom's document processing macros, as well
  37. as demonstrating the use of COLLATE.
  38. The PRINTSTYLE of this file is TYPESET, to give you an idea of mom's
  39. default behaviour when typesetting a document.
  40. The last sample, set in 2 columns, shows off mom's flexibility
  41. when it comes to designing documents.
  42. If you'd like to see how mom handles exactly the same file when the
  43. PRINTSTYLE is TYPEWRITE (i.e. typewritten, double-spaced), simply
  44. change
  45. .PRINTSTYLE TYPESET
  46. to
  47. .PRINTSTYLE TYPEWRITE
  48. near the top of the file.
  49. ***letter.mom***
  50. This is just the tutorial example from the momdocs, ready for
  51. previewing.
  52. ***elvis_syntax.new***
  53. For those who use the vi clone, elvis, you can paste this file into
  54. your elvis.syn. Provided your mom documents have the extension
  55. .mom, they'll come out with colorized syntax highlighting. The
  56. rules in elvis_syntax aren't exhaustive, but they go a LONG way to
  57. making mom files more readable.
  58. The file elvis_syntax (for pre-2.2h versions of elvis) is no longer
  59. being maintained. Users are encouraged to update to elvis 2.2h or
  60. higher, and to use elvis_syntax.new for mom highlighting.
  61. I'll be very happy if someone decides to send me syntax highlighting
  62. rules for emacs. :)
  63. ***mom.vim***
  64. Christian V. J. Brüssow has kindly contributed a set of mom syntax
  65. highlighting rules for use with vim. Copy the file to your
  66. ~/.vim/syntax directory, then, if your vim isn't already set up to
  67. do so, enable mom syntax highlighting with
  68. :syntax enable
  69. or
  70. :syntax on
  71. Please note: I don't use vim, so I won't be making changes to this
  72. file myself. Christian Brüssow is the maintainer of the ruleset,
  73. which is available on the Web at
  74. http://www.cvjb.de/comp/vim/mom.vim
  75. Contact Christian (cvjb@cvjb.de) if you have any suggestions or
  76. requests.