Re: [PATCH v2 6/6] intro.1: Revise paragraph documenting GNU texinfo

[Alejandro Colomar <alx@kernel.org>]

[-- Attachment #1: Type: text/plain, Size: 1601 bytes --]

Hi Jeremy,

On Sun, Mar 17, 2024 at 09:08:34PM +1300, Jeremy Baxter wrote:
> ---
>  man1/intro.1 | 18 ++++++++++--------
>  1 file changed, 10 insertions(+), 8 deletions(-)
> 
> diff --git a/man1/intro.1 b/man1/intro.1
> index 72f28bc2e..5aad9d4e7 100644
> --- a/man1/intro.1
> +++ b/man1/intro.1
> @@ -314,15 +314,17 @@ the previous page, and "q" to quit.
>  In documentation it is customary to refer to man pages
>  by using the name followed by the section number in brackets, as in
>  .BR man (1).
> -Man pages are terse, and allow you to find quickly some forgotten
> -detail.
> -For newcomers an introductory text with more examples
> -and explanations is useful.
>  .P
> -A lot of GNU/FSF software is provided with info files.
> -Type "info info"
> -for an introduction on the use of the program
> -.IR info .
> +Man pages are concise, and allow you to quickly find a forgotten detail.
> +They're designed to be a complete reference manual for a program.
> +Usually you'd want a guide/tutorial when learning how to use software,
> +rather than a long exhaustive reference manual.
> +For this purpose a lot of GNU software comes with
> +.I info
> +manuals, which are designed to be more of an introduction for newcomers.
> +Use the command "info info" for a first introduction on using the

Redundant: introductions are first, of course.  :)

Have a lovely day!
Alex

> +.I info
> +program.
>  .P
>  Some topics can be documented in HOWTO files.
>  To find these, look for HTML files in
> -- 
> 2.44.0
> 

-- 
<https://www.alejandro-colomar.es/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]