From 7a452794b1aa960c3aad2d74bf5f80625131648b Mon Sep 17 00:00:00 2001 From: emma Date: Wed, 26 Jun 2024 18:54:43 -0600 Subject: [PATCH] pg.1: updates documentation --- docs/pg.1 | 51 +++++++++++++++++++++++++++++++-------------------- 1 file changed, 31 insertions(+), 20 deletions(-) diff --git a/docs/pg.1 b/docs/pg.1 index 72f09c1..724d957 100644 --- a/docs/pg.1 +++ b/docs/pg.1 @@ -1,41 +1,52 @@ .\" Copyright (c) 2024 DTB +.\" Copyright (c) 2024 Emma Tebibyte .\" .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license, .\" visit . - -.TH PG 1 - +.\" +.TH PG 1 2024-06-26 "Harakit X.X.X" .SH NAME - pg \(en paginate - +.\" .SH SYNOPSIS pg .RB ( -p .RB [ prompt ]) - +.\" .SH DESCRIPTION -Pg prints standard input to standard output, accepting commands between pages. - +Print standard input to standard output, accepting commands between pages. +.\" .SH OPTIONS -.B -p -.RS -Replaces the default prompt (": ") with the next argument. -.RE - +.IP -p +Replace the default prompt (\(lq: \(rq) with the option argument. +.\" .SH DIAGNOSTICS -Pg returns an unsuccessful exit code if the tty couldn't be opened or if pg was -invoked incorrectly (with any arguments). - +In the event of an error, a debug message will be printed and the program will +exit with the appropriate +.BR sysexits.h (3) +error code. +.\" .SH RATIONALE -Plan 9 from Bell Labs had p(1), a similar "cooked"-mode paginator (as opposed -to "raw" mode, which a vast majority of paginators use). +Plan 9 from Bell Labs had +.BR p (1), +a similar \(lqcooked\(rq-mode paginator (as opposed to \(lqraw\(rq mode, which a +vast majority of paginators use). +.\" +.SH AUTHOR +Written by DTB +.MT trinity@trinity.moe +.ME . +.\" +.SH COPYRIGHT + +Copyright \(co 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later +. +.\" .SH SEE ALSO - -more(1) +.BR more (1p)