docs/66265: [patch] Document what -f and LD_TRACE_LOADED_OBJECTS_FMT[12] are for in ldd/rtld

[Michel Lavondes]

>Number:         66265
>Category:       docs
>Synopsis:       [patch] Document what -f and LD_TRACE_LOADED_OBJECTS_FMT[12] are for in ldd/rtld
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Tue May 04 11:10:17 PDT 2004
>Closed-Date:
>Last-Modified:
>Originator:     Michel Lavondes
>Release:        4.8-RELEASE-p18
>Organization:
Ah! I wish!
>Environment:
>Description:
ldd(1) and rtld(1) are vague about the effect of repeated -f options, or the difference between LD_TRACE_LOADED_OBJECTS_FMT1 and LD_TRACE_LOADED_OBJECTS_FMT2. This makes clear that one is for libraries, the other for shared objects.
>How-To-Repeat:
man ldd
man rtld
(not tested on -current, but I looked at the CVS repo and didn't see anything along those lines.)
>Fix:
--- usr.bin/ldd/ldd.1.orig      Sun May  2 14:34:19 2004
+++ usr.bin/ldd/ldd.1   Sun May  2 23:57:54 2004
@@ -26,6 +26,13 @@
 Zero, one or two
 .Fl f
 options may be given.
+If one is given, it sets
+.Ev LD_TRACE_LOADED_OBJECTS_FMT1 .
+If two are given, they set
+.Ev LD_TRACE_LOADED_OBJECTS_FMT1
+and
+.Ev LD_TRACE_LOADED_OBJECTS_FMT2 ,
+respectively.
 The argument is a format string passed to
 .Xr rtld 1
 and allows customization of
@@ -33,7 +40,7 @@
 output.
 See
 .Xr rtld 1
-for a list of recognized conversion characters.
+for details, including a list of recognized conversion characters.
 .Pp
 The
 .Fl v
--- libexec/rtld-elf/rtld.1.orig        Sun May  2 23:23:40 2004
+++ libexec/rtld-elf/rtld.1     Sun May  2 23:29:57 2004
@@ -117,6 +117,10 @@
 option and allows
 .Xr ldd 1
 to be operated as a filter more conveniently.
+.Ev LD_TRACE_LOADED_OBJECTS_FMT1
+is used for tracing shared libraries, and
+.Ev LD_TRACE_LOADED_OBJECTS_FMT2
+is used for tracing shared objects (but see BUGS below).
 The following conversions can be used:
 .Bl -tag -width 4n
 .It Li %a
@@ -153,3 +157,6 @@
 .Xr ldd 1 ,
 .Xr elf 5 ,
 .Xr ldconfig 8
+.Sh BUGS
+Libraries with a name that doesn't start with lib may be mistaken for
+objects, and conversely.
>Release-Note:
>Audit-Trail:
>Unformatted: