home *** CD-ROM | disk | FTP | other *** search
/ Oakland CPM Archive / oakcpm.iso / cpm / cug / softt-7.lbr / MCOL.DQC / MCOL.DOC
Text File  |  1984-07-05  |  3KB  |  118 lines
  1. .bp 1
  2. .in 0
  3. .he 'MCOL (1)'10/1/78'MCOL (1)'
  4. .sp 2
  5. .in +3
  6. .fi
  7. .ti -3
  8. NAME
  9. .br
  10. mcol - multicolumn formatting
  11. .nf
  12. .sp
  13. .ti -3
  14. SYNOPSIS
  15. .br
  16. mcol [-cn] [-ln] [-wn] [-gn] [-dn] [file ...]
  17. .fi
  18. .sp
  19. .ti -3
  20. DESCRIPTION
  21. .br
  22. Mcol reads the named files and formats them into multicolumn
  23. output on the standard output.
  24. If the filename "-" is given, or no files are specified, the
  25. standard input is read.
  26.  
  27. The options are as follows.
  28. .sp
  29. .in +5
  30. .ti -5
  31. -cn  Format the output into "n" columns.  Default is 2.
  32. .sp
  33. .ti -5
  34. -ln  Set the output page size to "n".  Mcol produces its output
  35. in pages, but does not place separators between the pages on
  36. the assumption that some subsequent processor will do that.
  37. (The default page length is 55.)
  38. .sp
  39. .ti -5
  40. -wn  Set the column width to "n" characters.  Lines longer than "n"
  41. characters are truncated.
  42. (The default column width is 60.)
  43. .sp
  44. .ti -5
  45. -gn  Set the "gutter" width to "n".  The gutter is the white space
  46. between columns.
  47. (The default gutter width is 8.)
  48. .sp
  49. .ti -5
  50. -dn  Assume output is to be printed on a display terminal.  The
  51. column size is set to "n" characters and the page size is set to
  52. 24 lines.  The number of columns and gutter width are computed
  53. to maximize the amount of information on a single screen.
  54. If "n" is omitted, 10 is used, which is useful for displaying
  55. lists of file names.
  56. .sp
  57. .in -5
  58. .fi
  59. .sp
  60. .ti -3
  61. FILES
  62. .br
  63. None
  64. .sp
  65. .ti -3
  66. SEE ALSO
  67. .br
  68. .sp
  69. .ne 2
  70. .ti -3
  71. DIAGNOSTICS
  72. .br
  73. .nf
  74. invalid column count
  75. invalid page size
  76. invalid column width
  77. invalid gutter width
  78. .br
  79. .fi
  80. .in +3
  81. The value of one of the option flags is invalid or exceeds
  82. the limitations of mcol.
  83. .sp
  84. .ti -3
  85. ignoring invalid flag
  86. .br
  87. A command argument option flag was given which mcol didn't recognize.
  88. .in -3
  89. .sp
  90. insufficient buffer space
  91. .br
  92. .in +3
  93. Mcol could not buffer an entire page.  This is usually the result
  94. of options that specify a large page size or many columns.
  95. The buffer size is set by the MAXBUF definition in the source code.
  96. .in -3
  97. .sp
  98. too many lines
  99. .in +3
  100. .br
  101. The number of lines per page times the number of columns
  102. exceeded mcol's line buffer space.
  103. The maximum number of lines allowed is set by the MAXPTR definition
  104. in the source code.
  105. .in -3
  106. .fi
  107. .sp
  108. .ne 2
  109. .ti -3
  110. BUGS/DEFICIENCIES
  111. .br
  112. .sp
  113. .ti -3
  114. AUTHORS
  115. .br
  116. Original by David Hanson and friends (U. of Arizona), with
  117. modifications by Debbie Scherrer (LBL).
  118.