Bug 32676

Summary: file(1) formatting nit
Product: Documentation Reporter: rdm <rdm>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description rdm 2001-12-10 17:40:00 UTC
	In the file(1) man page (just above the HISTORY section, the
        following line runs off the right-hand margin:

          file: application/x-executable, dynamically linked (uses
            shared libs), not stripped

Fix: 

Fold the example text.
How-To-Repeat: 
	% man file
Comment 1 hiten pandya 2001-12-10 18:04:31 UTC
here is that patch for it...

--- file.1 Tue Oct 9 08:31:02 2001
+++ file.1.new Mon Dec 10 17:51:20 2001
@@ -340,7 +340,8 @@

$ file -i file.c file /dev/hda
file.c: text/x-c
-file: application/x-executable, dynamically linked
(uses shared libs), not stripped
+file: application/x-executable, dynamically linked
(uses shared libs), 
+ not stripped
/dev/hda: application/x-not-regular-file
.Ed
.Sh HISTORY

=Hiten Pandya
=<hiten@uk.freebsd.org>

__________________________________________________
Do You Yahoo!?
Send your FREE holiday greetings online!
http://greetings.yahoo.com
Comment 2 phantom 2001-12-10 18:59:34 UTC
hi,

Please submit this change to file's maintainer <christos@netbsd.org>.
Per David's note he's very responsive to external submissions and
this change should come with next contrib/file import.

On Mon, Dec 10, 2001 at 10:04:31AM -0800, Hiten Pandya wrote:
> here is that patch for it...
> 
> --- file.1 Tue Oct 9 08:31:02 2001
> +++ file.1.new Mon Dec 10 17:51:20 2001
> @@ -340,7 +340,8 @@
> 
> $ file -i file.c file /dev/hda
> file.c: text/x-c
> -file: application/x-executable, dynamically linked
> (uses shared libs), not stripped
> +file: application/x-executable, dynamically linked
> (uses shared libs), 
> + not stripped
> /dev/hda: application/x-not-regular-file
> .Ed
> .Sh HISTORY
> 
> =Hiten Pandya
> =<hiten@uk.freebsd.org>
> 
> __________________________________________________
> Do You Yahoo!?
> Send your FREE holiday greetings online!
> http://greetings.yahoo.com
> 
> To Unsubscribe: send mail to majordomo@FreeBSD.org
> with "unsubscribe freebsd-doc" in the body of the message
Comment 3 ru freebsd_committer freebsd_triage 2001-12-12 07:59:35 UTC
On Mon, Dec 10, 2001 at 10:04:31AM -0800, Hiten Pandya wrote:
> here is that patch for it...
> 
> --- file.1 Tue Oct 9 08:31:02 2001
> +++ file.1.new Mon Dec 10 17:51:20 2001
> @@ -340,7 +340,8 @@
> 
> $ file -i file.c file /dev/hda
> file.c: text/x-c
> -file: application/x-executable, dynamically linked
> (uses shared libs), not stripped
> +file: application/x-executable, dynamically linked
> (uses shared libs), 
> + not stripped
> /dev/hda: application/x-not-regular-file
> .Ed
> .Sh HISTORY
> 
Starting lines with a space is bogus, and causes groff(1)
to stop formatting the current line.  There's nothing wrong
with some text running of a right margin; manpages display
"literal" text exactly as it is shown by a program, and the
output of man(1) could be controlled by a pager utility
like more(1) or less(1).


Cheers,
-- 
Ruslan Ermilov		Oracle Developer/DBA,
ru@sunbay.com		Sunbay Software AG,
ru@FreeBSD.org		FreeBSD committer,
+380.652.512.251	Simferopol, Ukraine

http://www.FreeBSD.org	The Power To Serve
http://www.oracle.com	Enabling The Information Age
Comment 4 ru freebsd_committer freebsd_triage 2001-12-12 07:59:52 UTC
State Changed
From-To: open->closed

It's normal for literal text to be displayed exactly as 
shown by a corresponding utility, thus causing wraps.
Comment 5 rdm 2001-12-12 17:39:00 UTC
At 9:59 AM +0200 12/12/01, Ruslan Ermilov wrote:
>Starting lines with a space is bogus, and causes groff(1)
>to stop formatting the current line.  There's nothing wrong
>with some text running of a right margin; manpages display
>"literal" text exactly as it is shown by a program, and the
>output of man(1) could be controlled by a pager utility
>like more(1) or less(1).

Actually, my concern has more to do with the printed form of
the man page, where part of this line runs off the right-hand
edge of the page and disappears.  Although you could make a
weak (IMHO) argument that this is more accurate than folding
the line, it still looks unprofessional.

-r
-- 
email: rdm@cfcl.com; phone: +1 650-873-7841
http://www.cfcl.com/rdm    - my home page, resume, etc.
http://www.cfcl.com/Meta   - The FreeBSD Browser, Meta Project, etc.
http://www.ptf.com/dossier - Prime Time Freeware's DOSSIER series
http://www.ptf.com/tdc     - Prime Time Freeware's Darwin Collectiontion
Comment 6 ru freebsd_committer freebsd_triage 2001-12-13 09:16:32 UTC
On Wed, Dec 12, 2001 at 09:39:00AM -0800, Rich Morin wrote:
> At 9:59 AM +0200 12/12/01, Ruslan Ermilov wrote:
> >Starting lines with a space is bogus, and causes groff(1)
> >to stop formatting the current line.  There's nothing wrong
> >with some text running of a right margin; manpages display
> >"literal" text exactly as it is shown by a program, and the
> >output of man(1) could be controlled by a pager utility
> >like more(1) or less(1).
> 
> Actually, my concern has more to do with the printed form of
> the man page, where part of this line runs off the right-hand
> edge of the page and disappears.  Although you could make a
> weak (IMHO) argument that this is more accurate than folding
> the line, it still looks unprofessional.
> 
Hmm, that sounds reasonable.  I'll see how many manpages
break if I change mdoc(7) literal displays to do filling.


Cheers,
-- 
Ruslan Ermilov		Oracle Developer/DBA,
ru@sunbay.com		Sunbay Software AG,
ru@FreeBSD.org		FreeBSD committer,
+380.652.512.251	Simferopol, Ukraine

http://www.FreeBSD.org	The Power To Serve
http://www.oracle.com	Enabling The Information Age