unicornleap.1

.\"Modified from man(1) of FreeBSD, the NetBSD mdoc.template, and mdoc.samples.
.\"See Also:
.\"man mdoc.samples for a complete listing of options
.\"man mdoc for the short list of editing options
.\"/usr/share/misc/mdoc.template
.Dd 2/5/16
.Dt unicornleap 1
.Os Darwin
.Sh NAME
.Nm unicornleap
.Nd display a flying unicorn
.Sh SYNOPSIS
.Nm
.Op Fl hHv               \" [-hHv]
.Op Fl s Ar seconds      \" [-a seconds]
.Op Fl e Ar eccentricity \" [-e eccentricity]
.Op Fl n Ar number       \" [-n number]
.Op Fl u Ar unicorn      \" [-u unicorn]
.Op Fl k Ar sparkle      \" [-k sparkle]
.Sh DESCRIPTION          \" Section Header - required - don't modify
.Nm
makes a unicorn fly across your screen. That's all it does.
.Sh OPTIONS
.Bl -tag -width "-u, --unicorn filename "
.It Fl h , \-help
Display usage information.
.It Fl s , \-seconds Ar n
Animate for n seconds.
.br
Defaults to
.Ar 2.0
.It Fl n , \-number Ar i
Display i unicorns.
.br
Defaults to
.Ar 1
.It Fl H , \-herd
Enables herd mode. A herd of unicorns will appear!
.It Fl e , \-eccentricity Ar i
Leap the unicorns with a higher peak.
.br
Defaults to
.Ar 1.0
.It Fl u , \-unicorn Ar filename
Filename for unicorn image.
.br
Defaults to
.Ar ~/.unicornleap/unicorn.png
.It Fl s , \-sparkle Ar filename
Filename for sparkle image.
.br
Defaults to
.Ar ~/.unicornleap/sparkle.png
.It Fl v , \-verbose
Print verbose messages
.El                      \" Ends the list
.Pp
.Sh FILES                \" File used or created by the topic of the man page
.Bl -tag -width "~/.unicornleap/unicorn.png" -compact
.It Pa ~/.unicornleap/unicorn.png
The magic image. This must exist and be a valid PNG.
.It Pa ~/.unicornleap/sparkle.png
The image for the sparkle effect. This must exist and be a valid PNG.
.El                      \" Ends the list