boxesSection: User Commands (1)
Updated: October 19 2012
boxes was originally intended to be used with the vim(1) text editor, but it can be tied to any text editor which supports filters, as well as called from the command line as a standalone tool.
- -a string
Alignment/positioning of text inside box. This option takes a format string
argument which is read from left to right. The format string may not
contain whitespace and must consist of one or more of the following
hx - horizontal alignment of the input text block inside a potentially larger box. Possible values for x are l (ell, for left alignment), c (center), or r (right). This does not affect the justification of text lines within the input text block (use the j argument instead).
vx - vertical alignment of the input text block inside a potentially larger box. Possible values for x are t (for top alignment), c (center), or b (bottom).
jx - justification of lines within the input text block. Possible values for x are l (ell, for left justification), c (center), or r (right). This does not affect the alignment of the input text block itself within the box. Use the h and v arguments for input text block positioning.
Short hand notations (can be combined with the above arguments):
l (ell) - short for hlvcjl
c - short for hcvcjc
r - short for hrvcjr
The factory default setting for -a is hlvt.
- -d string
- Design selection. The one argument of this option is the name of the design to use.
- -f string
- Use alternate config file. The one argument of this option is the name of a valid boxes config file, containing new and exciting designs!
- Print usage information.
- -i string
- Indentation mode. Possible arguments are "text" (indent text inside of box), "box" (indent box, not text inside of box), or "none" (throw away indentation). Arguments may be abbreviated. The default is to indent the box, but not the text.
- -k bool
- Kill leading/trailing blank lines on removal. The value of bool can be specified as on, yes, true, 1, or t, all meaning yes, or off, no, false, 0, or f, which mean no. This is case-insensitive. This option only takes effect in connection with -r. If set to yes, leading and trailing blank lines will be removed from the output. If set to no, the entire content of the former box is returned. The default is no, if both the top and the bottom part of the box are open, as is the case with most regional comments. If the box's design defines a top part or a bottom part, the default is yes.
- (ell) List designs. Produces a listing of all available box designs in the config file, along with a sample box and information about it's creator. Also checks syntax of the entire config file. If used in connection with -d, displays detailed information about the specified design.
- -p string
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
consist of a combination of the following characters, each followed by a
number indicating the padding in spaces:
a - (all) give padding for all sides at once
h - (horiz) give padding for both horizontal sides
v - (vertical) give padding for both vertical sides
b - (bottom) give padding for bottom (south) side
l - (left) give padding for left (west) side
t - (top) give padding for top (north) side
r - (right) give padding for right (east) side
Example: -p a4t2 would define the padding to be 4 characters on all sides, except for the top of the box, where the input text block will be only 2 lines away from the box.
By default, unless specified otherwise in the config file, no padding is used.
- Remove box. Removes an existing box instead of drawing it. Which design to use is detected automatically. In order to save time or in case the detection does not decide correctly, combine with -d to specify the design. The default is to draw a new box.
- -s widthxheight
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
By default, the smallest possible box is created around the text.
- -t uint
- Distance between tab stops. It is important that this value is set correctly, or tabulator characters will upset your input text. The correct value for -t depends on the settings used for the text you are processing. Usually, a value of 8 should be okay. The factory default for -t is 8.
- Print out current version number.
The syntax of boxes config files is described on the website (see below). They are quite self-explanatory, though.https://boxes.thomasjensen.com/. The website also features a number of examples illustrating this manual page as well as more in-depth documentation.
Check out vim(1) at vim.org!
Please see the boxes website for the most current email address.
Should you notice any other unspecified behavior, please tell the author!
- The user's home directory.
- Name of boxes configuration file, if different from ~/.boxes.
- boxes configuration file
- system-wide configuration file
This document was created by man2html, using the manual pages.