diff options
| -rw-r--r-- | CREDITS | 2 | ||||
| -rw-r--r-- | manpage.1 | 58 | ||||
| -rwxr-xr-x | ponysay | 14 |
3 files changed, 54 insertions, 20 deletions
@@ -2,9 +2,9 @@ # Active developers Erkin Batu Altunbaş -Jan Alexander Steffens Mattias Andrée Sven-Hendrik Haase +Jan Alexander Steffens # Patchers and other contributors Duane Bekaert @@ -2,7 +2,7 @@ .\" First parameter, NAME, should be all caps .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection .\" other parameters are allowed: see man(7), man(1) -.TH PONYSAY SECTION "April 10, 2012" +.TH PONYSAY SECTION "July 4, 2012" .\" Please adjust this date whenever revising the manpage. .\" .\" Some roff macros, for reference: @@ -19,17 +19,20 @@ ponysay \- A cowsay wrapper with ponies .SH SYNOPSIS .B ponysay -.RI [ options ] [ message ] +.RI [ options ] +.RI [ message ] .br .SH DESCRIPTION .PP .\" TeX users may be more comfortable with the \fB<whatever>\fP and .\" \fI<whatever>\fP escape sequences to invode bold face and italics, .\" respectively. -\fBponysay\fP displays an image of a pony saying some text provided by the user -in a terminal. It is a wrapper for \fIcowsay\fP. If run with no arguments, it -accepts standard input, word-wraps the message given at about 40 columns, and -prints the pony saying the given message on standard output. +\fBponysay\fP displays an image of a pony saying some text provided by the user in a terminal. +It is a wrapper for \fIcowsay\fP. If \fImessage\fP is not provided, it accepts standard input, +word-wraps the message given at about 40 columns, and prints the pony saying the given message on standard output. +.PP +If no arguments are provided, the program only accepts standard input piped from another program, a file or +either here documents or here strings (see man bash(1) for details on here document/string.) .SH OPTIONS A summary of options is included below. .TP @@ -40,18 +43,47 @@ Show summary of options. Show version of program. .TP .B \-l -List ponyfiles +List pony files. .TP -.B \-f [ name ] -Select a pony (Either a filename or a pony name) +.B \-f \fIname\fP +Select a pony (either a file name or a pony name.) .TP -.B \-W [ column ] +.B \-W \fIcolumn\fP The screen column where the message should be wrapped +.SH ENVIRONMENT +.TP +.B PONYSAY_BOTTOM +Under TTY (Linux VT), if the output is larger the the screen's height, only the beginning is +printed, leaving 2 blank lines. If you want the buttom to be printed rather the the beginning +you can export \fBPONYSAY_BOTTOM\fP with the value \fIyes\fP, \fIy\fP or \fI1\fP. +.SH BUG +Bugs can be reported in <\fBhttps://github.com/erkin/ponysay/issues\fP>. .SH SEE ALSO .BR cowsay (1). +.BR fortune (1). .br .SH AUTHOR -ponysay was written by Erkin Batu Altunbaş <erkinbatu@gmail.com>. +ponysay was written by Erkin Batu Altunbaş <erkinbatu@gmail.com> +with contributions from Mattias Andrée, Sven-Hendrik Haase, Jan Alexander Steffens &a. +.\" See file CREDITS for full list +.PP +This manual page was written by Louis Taylor <kragniz@gmail.com> +for the Debian project (and may be used by others), and edited +by Mattias Andrée <maandree@kth.se>. +.br +.SH COPYRIGHT +DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE +.br +Version 2, December 2004 +.PP +Copyright (C) 2012 Erkin Batu Altunbaş +.PP +Everyone is permitted to copy and distribute verbatim or modified +copies of this license document, and changing it is allowed as long +as the name is changed. +.PP +DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE +.br +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION .PP -This manual page was written by Louis Taylor <kragniz@gmail.com>, -for the Debian project (and may be used by others). + 0. You just DO WHAT THE FUCK YOU WANT TO. @@ -34,14 +34,16 @@ usage() { Usage: ${0##*/} [options] [message] -If [message] is not provided, reads the message from STDIN +If [message] is not provided, reads the message from STDIN. Options: - -v Show version and exit - -h Show this help and exit - -l List ponyfiles. - -f[name] Select a pony (Either a filename or a pony name) - -W[column] The screen column where the message should be wrapped + -v Show version and exit. + -h Show this help and exit. + -l List pony files. + -f[name] Select a pony (either a file name or a pony name.) + -W[column] The screen column where the message should be wrapped. + +See man ponysay(1) for more information. EOF } |