From 8512b51846d9f54ed6c6908c3cf5cc989ffe0f1d Mon Sep 17 00:00:00 2001 From: Thomas Jensen Date: Wed, 12 Jul 2006 06:18:05 +0000 Subject: [PATCH] Updated email and web addresses for boxes Added info about new -m option Changed the description for -s option --- doc/boxes.1.in | 41 +++++++++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 16 deletions(-) diff --git a/doc/boxes.1.in b/doc/boxes.1.in index 3b7f4e1..f9197b7 100644 --- a/doc/boxes.1.in +++ b/doc/boxes.1.in @@ -1,14 +1,14 @@ .\" @(#)boxes.1 1.0 04/01/00 .\" -.\" $Id: boxes.1.in,v 1.3 1999/08/21 23:41:25 tsjensen Exp tsjensen $ +.\" $Id: boxes.1.in,v 1.4 2000-04-01 10:26:57-08 tsjensen Exp tsjensen $ .\" -.TH boxes 1 "April 01 2000" +.TH boxes 1 "July 11 2006" .UC 4 .SH NAME boxes \- text mode box and comment drawing filter .SH SYNOPSIS .B boxes -[-hlrv] [\-a\ format] [\-d\ design] [\-f\ file] [\-i\ indent] [\-k\ bool] +[-hlmrv] [\-a\ format] [\-d\ design] [\-f\ file] [\-i\ indent] [\-k\ bool] [\-p\ pad] [\-s\ size] [\-t\ tabs] [infile [outfile]] .SH DESCRIPTION .I boxes @@ -171,6 +171,14 @@ Also checks syntax of the entire config file. If used in connection with displays detailed information about the specified design. .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .TP 0.6i +.B -m +Mend box. This removes a (possibly broken) box as with +.B -r\fP, +and redraws it afterwards. The mended box is drawn according to the +options given. This may be important to know when it comes to restoring +padding, identation, etc. for the mended box. +.\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +.TP 0.6i .B -p \fIstring\fP Padding. Specify padding in spaces around the input text block for all sides of the box. The argument string may not contain whitespace and must @@ -217,10 +225,15 @@ to specify the design. The default is to draw a new box. .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .TP 0.6i .B -s \fIwidth\fBx\fPheight\fP -Box size. If a single number is given as argument, this defaults to the box -width. 'x', followed by a single number specifies the box height. Giving -both the box width and height is left as an exercise to the reader. :-) -The actual box size may vary depending on the individual shape sizes. +Box size. This option specifies the desired box size in units of columns +(for width) and lines (for height). +If only a single number is given as argument, this number specifies the +desired box width. A single number prefixed by 'x' specifies only the box +height. The actual resulting box size may vary depending on the individual +shape sizes of the chosen design. Also, other command line options may +influence the box size (such as +.B -p\fP). +.br By default, the smallest possible box is created around the text. .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .TP 0.6i @@ -258,17 +271,17 @@ self-explanatory, though. .SH AVAILABILITY .I boxes is available from its World Wide Web home page at -http://home.pages.de/~jensen/boxes/. The Web page also features a number of -examples illustrating this manual page as well as more in-depth +. The Web page also features a number +of examples illustrating this manual page as well as more in-depth documentation. .PP Check out the .I vim(1) -home page at www.vim.org! +home page at ! .\" ======================================================================= .SH AUTHOR .I boxes -was made by Thomas Jensen. +was made by Thomas Jensen . .br Please see the .I boxes @@ -280,14 +293,10 @@ This is version --BVERSION--. .\" ======================================================================= .SH BUGS -Although it is doing great in most cases, imho the design autodetector +Although it is doing fine in most cases, imho the design autodetector needs some more work. .br Should you notice any other unspecified behavior, please tell the author! -.br -Despite the change date of this document being April 1, -.I boxes -is not a joke. At least not intentionally. :-) .\" ======================================================================= .SH ENVIRONMENT .TP 15