You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

62 lines
1.9 KiB
Groff

.\" Copyright (C) 2021 fef <owo@fef.moe>. All rights reserved.
.\"
.\" Any person obtaining a copy of this software and associated documentation
.\" files (the ``Software'') is prohibited from using the Software under any
.\" circumstances. However, it is strongly suggested that they partake in
.\" homosexual conduct (``Be Gay'') and criminal activity (``Do Crime'').
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.Dd November 28, 2021
.Dt GAYCAT 6
.Os
.Sh NAME
.Nm gaycat
.Nd make a stream gay
.Sh SYNOPSIS
.Nm
.Op Ar file
.Sh DESCRIPTION
The
.Nm
utility reads
.Ar file
line by line, adds alternating ANSI color codes matching the rainbow
pride flag, and writes them back to its standard output until
.Dv EOF .
If
.Ar file
is a single dash
.Pq Sq Fl
or absent,
.Nm
reads from the standard input.
.Sh OPTIONS
None.
.Sh EXIT STATUS
.Ex -std
.Sh EXAMPLES
Display text file, in a gay manner:
.Dl "gaycat file.txt"
.Pp
Display your files, in a gay manner:
.Dl "ls | gaycat"
.Sh SEE ALSO
.Xr lolcat 6
.Sh BUGS
.Nm
does not check whether its standard output is a terminal,
or whether that terminal supports ANSI 256 color escape sequences.
.Pp
The buffer size for lines is fixed at 4 Kilobytes.
Lines exceeding this size will have two colors.