update manual with new options
This commit is contained in:
parent
f147a29a97
commit
6549dd4e22
1 changed files with 51 additions and 7 deletions
58
banter.1
58
banter.1
|
@ -1,4 +1,4 @@
|
||||||
.Dd December 25, 2020
|
.Dd January 2, 2021
|
||||||
.Dt banter 1
|
.Dt banter 1
|
||||||
.Os
|
.Os
|
||||||
.
|
.
|
||||||
|
@ -8,16 +8,60 @@
|
||||||
.
|
.
|
||||||
.Sh SYNOPSIS
|
.Sh SYNOPSIS
|
||||||
.Nm
|
.Nm
|
||||||
.Ar file
|
.Op Fl d Ar delay
|
||||||
.Op Ar delay
|
.Op Fl w Ar width
|
||||||
|
.Op Fl Fl colorfmt Ar format
|
||||||
|
.Op Fl Fl filler Ar filler
|
||||||
|
.Pa file
|
||||||
.
|
.
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
.Nm
|
.Nm
|
||||||
is a image to irc color codes converter.
|
is a image to irc color codes converter.
|
||||||
|
.
|
||||||
.Pp
|
.Pp
|
||||||
note that if the color changes too rapidly and
|
note that
|
||||||
other factors like a long channel name and short
|
.Nm
|
||||||
line length may cause one line of pixels to continue
|
does not check if the line is too long for irc, additional
|
||||||
to the next line, ruining the image
|
filtering may be needed if you do not want
|
||||||
|
accidental wrapping.
|
||||||
.
|
.
|
||||||
.Sh OPTIONS
|
.Sh OPTIONS
|
||||||
|
.Bl -tag -width Ds
|
||||||
|
.It Fl d Ar delay
|
||||||
|
set the
|
||||||
|
.Ar delay
|
||||||
|
in seconds between output lines. this does
|
||||||
|
not factor in computation time.
|
||||||
|
.
|
||||||
|
.It Fl w Ar width
|
||||||
|
the
|
||||||
|
.Ar width
|
||||||
|
of filler characters. the actual line will almost certainly
|
||||||
|
be longer because of color codes.
|
||||||
|
.
|
||||||
|
.It Fl Fl colorfmt Ar format
|
||||||
|
the unicode-escaped format of the colorcodes. you probably
|
||||||
|
do not want to change it, the default of
|
||||||
|
.Cm '\ex03{},{}'
|
||||||
|
is usually fine for all irc-related use.
|
||||||
|
.
|
||||||
|
.It Fl Fl filler Ar filler
|
||||||
|
what to fill the actual contents of the text with.
|
||||||
|
you could use it to hide messages if you want.
|
||||||
|
the default value is
|
||||||
|
.Cm '.' .
|
||||||
|
.El
|
||||||
|
.
|
||||||
|
.Sh BUGS
|
||||||
|
please report any bugs found to
|
||||||
|
.Lk https://github.com/xfnw/banter/issues .
|
||||||
|
.
|
||||||
|
.Pp
|
||||||
|
note that
|
||||||
|
.Nm
|
||||||
|
does not support non-rgb[a] color palettes, and an
|
||||||
|
exception on other palettes like grayscale
|
||||||
|
is to be expected and not a bug.
|
||||||
|
.
|
||||||
|
.Sh AUTHORS
|
||||||
|
.An xfnw Aq Mt xfnw@riseup.net
|
||||||
|
|
Loading…
Reference in a new issue