GNU bug report logs - #78628
Typo in cat synopsis?

Previous Next

Package: coreutils;

Reported by: A Kiloev <kiloev.akram <at> gmail.com>

Date: Thu, 29 May 2025 14:38:02 UTC

Severity: normal

Done: Pádraig Brady <P <at> draigBrady.com>

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Pádraig Brady <P <at> draigBrady.com>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#78628: closed (Typo in cat synopsis?)
Date: Thu, 29 May 2025 14:51:02 +0000
[Message part 1 (text/plain, inline)]
Your message dated Thu, 29 May 2025 15:50:44 +0100
with message-id <bf6ec845-892d-48d3-b1e9-cbcd6afffae0 <at> draigBrady.com>
and subject line Re: bug#78628: Typo in cat synopsis?
has caused the debbugs.gnu.org bug report #78628,
regarding Typo in cat synopsis?
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
78628: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=78628
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: A Kiloev <kiloev.akram <at> gmail.com>
To: bug-coreutils <at> gnu.org
Subject: Typo in cat synopsis?
Date: Thu, 29 May 2025 16:39:53 +0300
[Message part 3 (text/plain, inline)]
Hi, i am not sure is it a typo, but shouldn't be ellipsis after OPTION in
cat synopsis* https://www.gnu.org/software/coreutils/manual/coreutils.html#cat-invocation
<https://www.gnu.org/software/coreutils/manual/coreutils.html#cat-invocation> ?*
I asked before on (
https://unix.stackexchange.com/questions/796402/should-my-cat-utility-support-multiple-keys-simultaneously#
)
and they say :
* "The synopsis in the GNU manual feels like an oversight — the man page
synopsis comes from GNU cat’s --help option, maintained by the same people,
and most other commands in the GNU coreutils manual (tac etc.) do include
an ellipsis. – *
*Stephen Kitt* <https://unix.stackexchange.com/users/86440/stephen-kitt>
* ". *
So is it a type or not?
[Message part 4 (text/html, inline)]
[Message part 5 (message/rfc822, inline)]
From: Pádraig Brady <P <at> draigBrady.com>
To: A Kiloev <kiloev.akram <at> gmail.com>, 78628-done <at> debbugs.gnu.org
Subject: Re: bug#78628: Typo in cat synopsis?
Date: Thu, 29 May 2025 15:50:44 +0100
On 29/05/2025 14:39, A Kiloev wrote:
> Hi, i am not sure is it a typo, but shouldn't be ellipsis after OPTION in
> cat synopsis* https://www.gnu.org/software/coreutils/manual/coreutils.html#cat-invocation
> <https://www.gnu.org/software/coreutils/manual/coreutils.html#cat-invocation> ?*
> I asked before on (
> https://unix.stackexchange.com/questions/796402/should-my-cat-utility-support-multiple-keys-simultaneously#
> )
> and they say :
> * "The synopsis in the GNU manual feels like an oversight — the man page
> synopsis comes from GNU cat’s --help option, maintained by the same people,
> and most other commands in the GNU coreutils manual (tac etc.) do include
> an ellipsis. – *
> *Stephen Kitt* <https://unix.stackexchange.com/users/86440/stephen-kitt>
> * ". *
> So is it a type or not?
Indeed, there are a few inconsistencies in the manual:

$ grep '\[@var{option}\] ' doc/coreutils.texi
cat [@var{option}] [@var{file}]@dots{}
split [@var{option}] [@var{input} [@var{prefix}]]
tsort [@var{option}] [@var{file}]
mkfifo [@var{option}] @var{name}@dots{}
sync [@var{option}] [@var{file}]@dots{}
dirname [@var{option}] @var{name}@dots{}
stty [@var{option}] [@var{setting}]@dots{}
printenv [@var{option}] [@var{variable}]@dots{}
@command{who} [@var{option}] [@var{file}] [am i]
@command{pinky} [@var{option}] [@var{username}]@dots{}
timeout [@var{option}] @var{duration} @var{command} [@var{arg}]@dots{}

I'll fix these up.

Marking this as done.

thanks!

Padraig


This bug report was last modified 17 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.