Page MenuHomeFreeBSD

sh.1: Provide references to editline(7)
ClosedPublic

Authored by tembun_bk.ru on Jan 18 2026, 9:00 PM.
Referenced Files
Unknown Object (File)
Thu, Feb 26, 8:31 AM
Unknown Object (File)
Wed, Feb 18, 6:00 PM
Unknown Object (File)
Wed, Feb 18, 6:00 PM
Unknown Object (File)
Wed, Feb 18, 3:47 PM
Unknown Object (File)
Wed, Feb 18, 7:58 AM
Unknown Object (File)
Tue, Feb 17, 10:36 AM
Unknown Object (File)
Tue, Feb 17, 6:24 AM
Unknown Object (File)
Sun, Feb 15, 10:41 PM
Subscribers

Details

Summary

Now the man page does not document anywhere that editline(7) is used by the sh(1) for the command line editing. There is a reference to editrc(5), but it's not very obvious and mentioned only once, in the bind command description. Meanwhile, editline(7) does a good job on documenting editor commands and modes, which are mentioned in the sh(1) page several times.

Also, I believe that most users, if want to find more information about, say, keybindings for searching through the shell history, would expect to find that in the sh(1) page, since shell is the program, where they use these keybindings. It would be easier for them to come across editline(7) if this man page will be mentioned in several places.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

One apparent mistake, looks OK otherwise.

bin/sh/sh.1
2072

The section number is in an unexpected position.

bin/sh/sh.1
232

I wonder if these should actually be something like:

See
.Sx Command Line Editing

2071–2072
3017

The first sentence of a paragraph or section is very important. It tells the reader if they're reading the right paragraph, or if they need to skip to the next one.

The existing introductory sentence is a good explanation of this section. This one is not. I would suggest putting it this line in a new paragraph at the bottom of this section.

tembun_bk.ru marked 4 inline comments as done.

Address jilles and ziaee comments.

This revision is now accepted and ready to land.Feb 1 2026, 4:10 PM
This revision now requires review to proceed.Fri, Feb 6, 8:54 AM

Rebase the patch.

@ziaee I think it can be landed now.

This revision was not accepted when it landed; it landed in state Needs Review.Wed, Feb 18, 6:21 PM
Closed by commit rG009be0917234: sh.1: Reference editline(7) (authored by tembun_bk.ru, committed by ziaee). · Explain Why
This revision was automatically updated to reflect the committed changes.