manpage rendering issue

Open
#10,255 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
cli, documentation

Research direction

Start by running ./target/debug/uudoc manpage for chown and echo, then inspect the manpage-generation path responsible for SYNOPSIS, OPTIONS, and EXTRA output. Compare the generated groff with the issue examples across the listed commands; done means positional parameters, option spacing, and list formatting render correctly.

Written by the indexing model from the issue text.

Description

450e7cfee996d26ccf516e5bd11f9bd673a5b3c6

SYNOPSIS

  • [file] can be multiple, i.e. [file...]
    • b2sum
    • cat
    • chmod
    • cksum, etc
  • positional parameters are missed, e.g. [file...]
    • chown, etc
  • space after short only options, e.g. [-e ] in cat
    • cat
    • chmod
    • chown, etc

./target/debug/uudoc manpage chown:

.SH SYNOPSIS
\fBchown\fR [\fB\-\-help\fR] [\fB\-c\fR|\fB\-\-changes\fR] [\fB\-\-from\fR] [\fB\-\-preserve\-root\fR] [\fB\-\-no\-preserve\-root\fR] [\fB\-\-quiet\fR] [\fB\-R\fR|\fB\-\-recursive\fR] [\fB\-\-reference\fR] [\fB\-f\fR|\fB\-\-silent\fR] [\fB\-v\fR|\fB\-\-verbose\fR] [\fB\-H \fR] [\fB\-L \fR] [\fB\-P \fR] [\fB\-\-dereference\fR] [\fB\-h\fR|\fB\-\-no\-dereference\fR] [\fB\-V\fR|\fB\-\-version\fR]

OPTIONS

  • stray positional parameters, e.g. [file] in
    • b2sum
    • base32
    • base64
    • chmod, etc

EXTRA

  • list is malformed
    • cksum
    • dd
    • echo, etc

./target/debug/uudoc manpage echo:

.SH EXTRA
Echo the STRING(s) to standard output.

If \-e is in effect, the following sequences are recognized:

\- \\ backslash
\- \\a alert (BEL)
\- \\b backspace
\- \\c produce no further output
\- \\e escape
\- \\f form feed
\- \\n new line
\- \\r carriage return
\- \\t horizontal tab
\- \\v vertical tab
\- \\0NNN byte with octal value NNN (1 to 3 digits)
\- \\xHH byte with hexadecimal value HH (1 to 2 digits)
Dominant language
Rust
Stars
24.1k
Forks
2k
Avg merge
1d 5h
Merged PRs (30d)
365

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from uutils/coreutils

All issues in uutils/coreutils

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.