mirror of
https://github.com/ascii-boxes/boxes.git
synced 2025-01-19 12:28:11 +01:00
Minor update of manual page
This commit is contained in:
parent
b6a2f5d82f
commit
7690ea8565
@ -1,9 +1,9 @@
|
|||||||
.\" @(#)boxes.1 1.3 10/19/12
|
.\" @(#)boxes.1 1.3 04/04/2019
|
||||||
.\"
|
.\"
|
||||||
.\" boxes.1.in
|
.\" boxes.1.in
|
||||||
.\" Thomas Jensen
|
.\" Thomas Jensen
|
||||||
.\"
|
.\"
|
||||||
.TH boxes 1 "March 16 2017"
|
.TH boxes 1 "April 04 2019"
|
||||||
.UC 4
|
.UC 4
|
||||||
.SH NAME
|
.SH NAME
|
||||||
boxes \- text mode box and comment drawing filter
|
boxes \- text mode box and comment drawing filter
|
||||||
@ -20,13 +20,16 @@ text inside. Since boxes may be open on any side,
|
|||||||
.I boxes
|
.I boxes
|
||||||
can also be used to create regional comments in any programming language.
|
can also be used to create regional comments in any programming language.
|
||||||
New box designs of all sorts can easily be added and shared by appending to
|
New box designs of all sorts can easily be added and shared by appending to
|
||||||
a free format configuration file.
|
a configuration file.
|
||||||
.br
|
.LP
|
||||||
.I boxes
|
.I boxes
|
||||||
was originally intended to be used with the
|
is a command line tool, but also integrates with any text editor that
|
||||||
.I vim(1)
|
supports filters. The
|
||||||
text editor, but it can be tied to any text editor which supports filters,
|
.I boxes
|
||||||
as well as called from the command line as a standalone tool.
|
website has examples on how to configure editor integration for various
|
||||||
|
text editors:
|
||||||
|
.br
|
||||||
|
<URL:https://boxes.thomasjensen.com/docs/install.html>
|
||||||
.\" =======================================================================
|
.\" =======================================================================
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
Options offered by
|
Options offered by
|
||||||
@ -300,27 +303,28 @@ will try to read the system\-wide config file (see FILES).
|
|||||||
.PP
|
.PP
|
||||||
The syntax of
|
The syntax of
|
||||||
.I boxes
|
.I boxes
|
||||||
config files is described on the website (see below). They are quite
|
config files is described on the website.
|
||||||
self\-explanatory, though.
|
|
||||||
.\" =======================================================================
|
.\" =======================================================================
|
||||||
.SH AVAILABILITY
|
.SH AVAILABILITY
|
||||||
.I Boxes
|
The
|
||||||
is available from its website at
|
.I boxes
|
||||||
<URL:https://boxes.thomasjensen.com/>. The website also features a number
|
website is <URL:https://boxes.thomasjensen.com/>. It contains a number
|
||||||
of examples illustrating this manual page as well as more in\-depth
|
of examples illustrating this manual page as well as more in\-depth
|
||||||
documentation.
|
documentation.
|
||||||
.PP
|
|
||||||
Check out
|
|
||||||
.I vim(1)
|
|
||||||
at <URL:http://www.vim.org/>!
|
|
||||||
.\" =======================================================================
|
.\" =======================================================================
|
||||||
.SH AUTHOR
|
.SH AUTHOR
|
||||||
.I Boxes
|
.I Boxes
|
||||||
was made by Thomas Jensen <boxes@thomasjensen.com>.
|
was made by Thomas Jensen and many great contributors.
|
||||||
.br
|
.br
|
||||||
Please see the
|
For a full list, see
|
||||||
|
.br
|
||||||
|
<URL:https://boxes.thomasjensen.com/contributing.html#contributors>
|
||||||
|
.br
|
||||||
|
and <URL:https://github.com/ascii-boxes/boxes/graphs/contributors>.
|
||||||
|
.br
|
||||||
|
Please refer to the
|
||||||
.I boxes
|
.I boxes
|
||||||
website for a current email address.
|
website for the maintainer's current email address.
|
||||||
.\" =======================================================================
|
.\" =======================================================================
|
||||||
.SH VERSION
|
.SH VERSION
|
||||||
This is
|
This is
|
||||||
@ -328,10 +332,8 @@ This is
|
|||||||
version --BVERSION--.
|
version --BVERSION--.
|
||||||
.\" =======================================================================
|
.\" =======================================================================
|
||||||
.SH BUGS
|
.SH BUGS
|
||||||
Although it is doing fine in most cases, imho the design autodetector
|
Any currently known bugs, and also any current feature requests are tracked
|
||||||
needs some more work.
|
on GitHub: <URL:https://github.com/ascii-boxes/boxes/issues>
|
||||||
.br
|
|
||||||
Should you notice any other unspecified behavior, please tell the author!
|
|
||||||
.\" =======================================================================
|
.\" =======================================================================
|
||||||
.SH ENVIRONMENT
|
.SH ENVIRONMENT
|
||||||
.I Boxes
|
.I Boxes
|
||||||
@ -349,12 +351,10 @@ configuration file, if different from ~/.boxes.
|
|||||||
.TP 1.0i
|
.TP 1.0i
|
||||||
$HOME/.boxes
|
$HOME/.boxes
|
||||||
.I boxes
|
.I boxes
|
||||||
configuration file
|
configuration file (takes precedence over system-wide configuration file)
|
||||||
.TP 1.0i
|
.TP 1.0i
|
||||||
--GLOBALCONF--
|
--GLOBALCONF--
|
||||||
system\-wide configuration file
|
system\-wide configuration file
|
||||||
.\" =======================================================================
|
.\" =======================================================================
|
||||||
.SH "SEE ALSO"
|
.SH "SEE ALSO"
|
||||||
.I tal(1)
|
.I figlet(6)
|
||||||
,
|
|
||||||
.I vim(1)
|
|
||||||
|
Loading…
Reference in New Issue
Block a user