From cecfbf75e8b1cc930de4ac347496be9ebce88a84 Mon Sep 17 00:00:00 2001 From: Erkin Batu Altunbaş Date: Thu, 12 Jul 2012 16:46:17 +0200 Subject: A tiny bit of tweaking in documents.See issue 22 to discuss. --- manpage.6 | 96 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 manpage.6 (limited to 'manpage.6') diff --git a/manpage.6 b/manpage.6 new file mode 100644 index 0000000..4b76a69 --- /dev/null +++ b/manpage.6 @@ -0,0 +1,96 @@ +.\" +.\" 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 6 "July 12, 2012" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +ponysay \- A cowsay wrapper with ponies +.SH SYNOPSIS +.B ponysay +.RI [ options ] +.RI [ message ] +.br +.B ponythink +.RI [ options ] +.RI [ message ] +.br +.SH DESCRIPTION +.PP +.\" TeX users may be more comfortable with the \fB\fP and +.\" \fI\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 \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.) +.PP +\fBponythink\fP is to \fIponysay\fP as \fIcowthink\fP is to \fIcowsay\fP. +.SH OPTIONS +A summary of options is included below. +.TP +.B \-h +Show summary of options. +.TP +.B \-v +Show version of program. +.TP +.B \-l +List pony files. +.TP +.B \-f \fIname\fP +Select a pony (either a file name or a pony name.) +.TP +.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 two blank lines. If you want the buttom to be printed rather the the beginning +you can export \fIPONYSAY_BOTTOM\fP with the value \fIyes\fP, \fIy\fP or \fI1\fP. +.TP +.B PONYSAY_SHELL_LINES +Under TTY (Linux VT), if the output is larger the the screen's height, two lines are left blank. +If you want more, or less, blank lines you can export \fIPONYSAY_SHELL_LINES\fP with the value +of how many blank lines you want. Naturally this takes effect if the output is not actually larger +than the screen. +.TP +.B PONYSAY_FULL_WIDTH +You can export \fIPONYSAY_FULL_WIDTH\fP with the value \fIno\fP, \fIn\fP or \fI0\fP, if you +do not want the output to be truncated on the width to fit the terminal. +.TP +.B PONYSAY_TRUNCATE_HEIGHT +Export \fIPONYSAY_TRUNCATE_HEIGHT\fP with the value \fIyes\fP, \fIy\fP or \fI1\fP, if you +want to truncate the output on the height even if you are not running \fIponysay\fP under TTY. +.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ş +with major contributions from Mattias Andrée, Sven-Hendrik Haase, Jan Alexander Steffens et al. +.\" See file CREDITS for full list. +.PP +This manual page was written by Louis Taylor +for the Debian project (and may be used by others), and edited +by Mattias Andrée . +.br +.PP +This program is licensed under WTFPL. +.\" See file COPYING to see the license. -- cgit From c8c0aa155d6a90d3be2efc88a0224d8496acb0f0 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Thu, 12 Jul 2012 16:58:05 +0300 Subject: Update master --- manpage.6 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'manpage.6') diff --git a/manpage.6 b/manpage.6 index 4b76a69..e25a560 100644 --- a/manpage.6 +++ b/manpage.6 @@ -80,7 +80,7 @@ want to truncate the output on the height even if you are not running \fIponysay Bugs can be reported in <\fBhttps://github.com/erkin/ponysay/issues\fP>. .SH SEE ALSO .BR cowsay (1), -.BR fortune (1). +.BR fortune (6). .br .SH AUTHOR ponysay was written by Erkin Batu Altunbaş -- cgit