Wrote man page

This commit is contained in:
Nox Sluijtman 2022-07-29 12:41:02 +02:00
parent 0810a69103
commit c836a898fc

View file

@ -2,62 +2,37 @@
.SH NAME .SH NAME
dice-roller \- Dice roller utility written in GO dice-roller \- Dice roller utility written in GO
.SH SYNOPSIS .SH SYNOPSIS
.B dragon .B dice-roller
.OP -surfaces .OP -a
.OP -throws .OP -s
.OP -modifier .OP -c
.OP -attacks .OP -m
.OP -advantage
.OP -disatvantage
.PP .PP
.B dragon .B dice-roller
.OP --help .OP --advantage
.PP .PP
.B dragon .B dice-roller
.OP --version .OP --disadvantage
.SH DESCRIPTION .SH DESCRIPTION
.B dragon .B dice-roller
is a source/sink for drag-and-drop operations. Many programs, particularly is a little dice roller I wrote because I'm hopelessly bad at basic arithmetic equations.
web applications, expect files to be dragged into them now. If you don't Written with D&D 5e in mind, can undoubtedly be used for other purposes as well.
habitually use a file manager that is a problem. Dragon creates a small window
to drag out or drop files into, instead.
.SH OPTIONS .SH OPTIONS
.TP .TP
.B -x --and-exit .B -a --attacks
exit after a single completed drop. Roll a set rules multiple times, does not apply to advantage and disadvantage, defaults to 1.
.TP .TP
.B -t --target .B -s --surfaces
act as a target instead of source. Use to specify die surfaces, does not apply to advantage and disadvantage, defaults to 20.
.TP .TP
.B -k --keep .B -c --throws
with --target, keep files to drag out. Specify amount of dice to cast
.TP .TP
.B -p --print-path .B -m --modifier
with --target, print file paths instead of URIs. Add modifier to result of rolls
.TP .TP
.B -a --all .B --advantage
drag all files at once. Roll two 2d20 and take the highest number, accepts modifiers
.TP .TP
.B -A --all-compact .B --disadvantage
drag all files at once, only displaying the number of files. Roll two 2d20 and take the lowest number, accepts modifiers
.TP
.B -i --icon-only
only show icons in drag-and-drop windows.
.TP
.B -T --on-top
make window always-on-top.
.TP
.B -I --stdin
read filenames from stdin.
.TP
.B -s --thumb-size
set thumbnail size (default 96)
.TP
.B -v --verbose
be verbose.
.TP
.B --help
show help.
.TP
.B --version
show version details.