Project

General

Profile

Actions

Bug #13181

closed

Cleanup cat(1) man page

Added by Nan Xiao over 2 years ago. Updated over 2 years ago.

Status:
Closed
Priority:
Low
Assignee:
Category:
manpage - manual pages
Start date:
Due date:
% Done:

100%

Estimated time:
Difficulty:
Bite-size
Tags:
Gerrit CR:
External Bug:
Actions #1

Updated by Nan Xiao over 2 years ago

The changes are as following:
(1) Remove unnecessary macros: e.g., .LP after .SS;
(2) Revamp Example 3:

a)

       When standard input is a terminal, the following command gets two
       arbitrary pieces of input from the terminal with a single invocation of
       cat:

         example% cat start - middle - end > file

       when standard input is a terminal, gets two arbitrary pieces of input
       from the terminal with a single invocation of cat.

Remove the second duplicated "when standard input ....":
       when standard input is a terminal, gets two arbitrary pieces of input
       from the terminal with a single invocation of cat.

b)

       If standard input is a regular file,

         example% cat start - middle - end > file

       would be equivalent to the following command:

         cat start - middle /dev/null end > file

Add "example% " for second cat command:

       ......

       would be equivalent to the following command:

         example% cat start - middle /dev/null end > file

c)

       because the entire contents of the file would be consumed by cat the
       first time - was used as a file operand and an end-of-file condition
       would be detected immediately when -was referenced the second time.

There should be space between "-" and "was" in last sentence:

       ......
       would be detected immediately when - was referenced the second time.
Actions #2

Updated by Robert Mustacchi over 2 years ago

  • Subject changed from Revamp cat(1) man page to Cleanup cat(1) man page
Actions #3

Updated by Electric Monk over 2 years ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100

git commit ae41a23c315570b85d6bf190d7cc51e1bcb161c8

commit  ae41a23c315570b85d6bf190d7cc51e1bcb161c8
Author: Nan Xiao <nan@chinadtrace.org>
Date:   2020-09-22T14:35:04.000Z

    13181 Cleanup cat(1) man page
    Reviewed by: Peter Tribble <peter.tribble@gmail.com>
    Approved by: Robert Mustacchi <rm@fingolfin.org>

Actions

Also available in: Atom PDF