Page MenuHomeFreeBSD

col(1): Add EXAMPLES section
ClosedPublic

Authored by fernape on Oct 19 2020, 4:47 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sep 24 2024, 4:30 PM
Unknown Object (File)
Sep 18 2024, 2:41 AM
Unknown Object (File)
Sep 17 2024, 3:26 AM
Unknown Object (File)
Sep 5 2024, 4:29 PM
Unknown Object (File)
Sep 3 2024, 1:40 AM
Unknown Object (File)
Aug 26 2024, 10:48 PM
Unknown Object (File)
Aug 12 2024, 4:31 AM
Unknown Object (File)
Aug 7 2024, 12:19 PM

Details

Reviewers
gbe
Group Reviewers
manpages
Commits
rS366913: col(1): Add EXAMPLES section
Summary

Add a small example.
Cross reference clean up for colcrt, nroff and tbl.

Test Plan
  • mandoc -Tlint clean
  • igor clean
  • aspell happy
  • man ./col.1 renders the page properly

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 34287
Build 31426: arc lint + arc unit

Event Timeline

Some small nits, otherwise LGTM. Thanks for working on the EXAMPLE sections. :)

usr.bin/col/col.1
155

I would use vi here, since it is included in FreeBSD's base.

157

See above.

usr.bin/col/col.1
155

I don't think vi can read from standard input:

fernape@beastie:~/FreeBSD-repos/base/head$ man ls | col -b | view
ex/vi: Vi's standard input and output must be a terminal
fernape@beastie:~/FreeBSD-repos/base/head$ man ls | col -b | vi -R -
vi: -s option is only applicable to ex.

@bcr would it be okay to use a ports application in a manual page from base?

I think it is OK, since vim is popular enough, even though it is not in the base system. If we can't find an example that uses a base system utility, that is.

Reformulate example to avoid referencing utilities not in base.

Use grep(1) to search for text that would not be found if the output of man(1)
were not filtered previously.

With this, all three utilities are in base and it is simple enough to remove
col(1) from the job in the example and see that the text is not found.

LGTM.

You could also include the vim example after @bcr comment states that it would be okay.

This revision is now accepted and ready to land.Oct 21 2020, 8:21 AM
This revision was automatically updated to reflect the committed changes.
In D26864#599542, @gbe wrote:

LGTM.

You could also include the vim example after @bcr comment states that it would be okay.

I finally landed the approved version as it is now.

Thanks for reviewing this!