| 1 |
.\" vim: set ft=nroff .\" |
| 2 |
.\" # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # |
| 3 |
.\" # |
| 4 |
.\" # C E D A R |
| 5 |
.\" # S O L U T I O N S "Software done right." |
| 6 |
.\" # S O F T W A R E |
| 7 |
.\" # |
| 8 |
.\" # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # |
| 9 |
.\" # |
| 10 |
.\" # Author : Kenneth J. Pronovici <[email protected]> |
| 11 |
.\" # Project : banner |
| 12 |
.\" # Purpose : Manpage for the banner program |
| 13 |
.\" # |
| 14 |
.\" # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # |
| 15 |
.TH banner "1" "Mar 2024" "Banner" "Kenneth J. Pronovici" |
| 16 |
.SH NAME |
| 17 |
banner \- prints a short string to the console in very large letters |
| 18 |
.SH SYNOPSIS |
| 19 |
.B banner |
| 20 |
\fIstring\fR |
| 21 |
.SH DESCRIPTION |
| 22 |
.PP |
| 23 |
This is a classic-style banner program similar to the one found in Solaris or |
| 24 |
AIX in the late 1990s. It prints a short string to the console in very large |
| 25 |
letters. |
| 26 |
.PP |
| 27 |
Banners that do not fit in the terminal will be truncated. If $COLUMNS is |
| 28 |
exported in the environment, it is taken to be the width of the terminal. If |
| 29 |
$COLUMNS is not exported, and TIOCGWINSZ is available on the platform, then its |
| 30 |
idea of the terminal size is used. Otherwise, a terminal width of 80 |
| 31 |
characters is assumed. |
| 32 |
.PP |
| 33 |
Usage is straightforward. For instance, a single word is printed like this: |
| 34 |
.PP |
| 35 |
> banner ken |
| 36 |
|
| 37 |
# # ####### # # |
| 38 |
# # # ## # |
| 39 |
# # # # # # |
| 40 |
### ##### # # # |
| 41 |
# # # # # # |
| 42 |
# # # # ## |
| 43 |
# # ####### # # |
| 44 |
.PP |
| 45 |
Multiple arguments are printed on separate lines: |
| 46 |
.PP |
| 47 |
> banner one two |
| 48 |
|
| 49 |
####### # # ####### |
| 50 |
# # ## # # |
| 51 |
# # # # # # |
| 52 |
# # # # # ##### |
| 53 |
# # # # # # |
| 54 |
# # # ## # |
| 55 |
####### # # ####### |
| 56 |
|
| 57 |
|
| 58 |
####### # # ####### |
| 59 |
# # # # # # |
| 60 |
# # # # # # |
| 61 |
# # # # # # |
| 62 |
# # # # # # |
| 63 |
# # # # # # |
| 64 |
# ## ## ####### |
| 65 |
.PP |
| 66 |
To get a single long line containing whitespace, you must quote the string: |
| 67 |
.PP |
| 68 |
> banner "one two" |
| 69 |
|
| 70 |
####### # # ####### ####### # # ####### |
| 71 |
# # ## # # # # # # # # |
| 72 |
# # # # # # # # # # # # |
| 73 |
# # # # # ##### # # # # # # |
| 74 |
# # # # # # # # # # # # |
| 75 |
# # # ## # # # # # # # |
| 76 |
####### # # ####### # ## ## ####### |
| 77 |
|
| 78 |
.SH COMPATIBILITY |
| 79 |
.PP |
| 80 |
From time to time, people assert that this program is buggy because it |
| 81 |
doesn't do something that some other banner implementation does. The |
| 82 |
behavior of the program is based on what I saw on Solaris and AIX systems |
| 83 |
at the time I wrote it in the late 1990s. I make no claims that the |
| 84 |
behavior is identical to that of any other contemporary system, especially |
| 85 |
any non-free system that I may or may not have access to. |
| 86 |
.PP |
| 87 |
If you don't like the behavior, you can either submit a patch, or you can |
| 88 |
use an alternative program such as figlet. I am always happy to accept |
| 89 |
patches, and I promise to integrate patches promptly if provided. So far, |
| 90 |
no one who's complained has bothered to provide any patches, so the |
| 91 |
behavior remains the same. |
| 92 |
.SH AUTHOR |
| 93 |
Written by Kenneth J. Pronovici <[email protected]>. |
| 94 |
.SH COPYRIGHT |
| 95 |
Copyright (c) 2000\-2004,2007,2013,2014,2020,2024 Kenneth J. Pronovici |
| 96 |
.br |
| 97 |
This is free software; see the source for copying conditions. There is |
| 98 |
NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR |
| 99 |
PURPOSE. |