freebsd-dev/usr.bin/lorder/lorder.1

.\" Copyright (c) 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)lorder.1	8.2 (Berkeley) 4/28/95
.\" $FreeBSD$
.\"
.Dd August 14, 2015
.Dt LORDER 1
.Os
.Sh NAME
.Nm lorder
.Nd list dependencies for object files
.Sh SYNOPSIS
.Nm
.Ar
.Sh DESCRIPTION
The
.Nm
utility uses
.Xr nm 1
to determine interdependencies in the list of object files
and library archives
specified on the command line.
The
.Nm
utility outputs a list of file names where the first file contains a symbol
which is defined by the second file.
.Pp
The output is normally used with
.Xr tsort 1
when a library is created to determine the optimum ordering of the
object modules so that all references may be resolved in a single
pass of the loader.
.Pp
When linking static binaries,
.Nm
and
.Xr tsort 1
can be used to properly order library archives automatically.
.Sh ENVIRONMENT
.Bl -tag -width indent
.It Ev NM
Path to the
.Xr nm 1
binary, defaults to
.Dq Li nm .
.It Ev NMFLAGS
Flags to pass to
.Xr nm 1 .
.El
.Sh EXAMPLES
.Bd -literal -offset indent
ar cr library.a `lorder ${OBJS} | tsort`
cc -o foo ${OBJS} `lorder ${STATIC_LIBS} | tsort`
.Ed
.Sh SEE ALSO
.Xr ar 1 ,
.Xr ld 1 ,
.Xr nm 1 ,
.Xr ranlib 1 ,
.Xr tsort 1
.Sh HISTORY
A
.Nm
utility appeared in
.At v7 .
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
Typo. 1997-07-23 06:48:01 +00:00			`.\" @(#)lorder.1 8.2 (Berkeley) 4/28/95`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
Introduce a new make variable: NMFLAGS. As the name indicates, these are flags to pass to nm(1). The newer binutils have a plugin mechanism so, to build something with LLVM's LTO, we need to pass flags to nm(1). This commit also extends lorder(1) to pass NMFLAGS to nm(1). 2015-08-14 22:54:52 +00:00			`.Dd August 14, 2015`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt LORDER 1`
			`.Os`
			`.Sh NAME`
			`.Nm lorder`
			`.Nd list dependencies for object files`
			`.Sh SYNOPSIS`
Typo. 1997-07-23 06:48:01 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Ar`
			`.Sh DESCRIPTION`
			`The`
Typo. 1997-07-23 06:48:01 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`utility uses`
			`.Xr nm 1`
			`to determine interdependencies in the list of object files`
ru@ recently changed lorder to support library archives. Document this new feature prominently. Bump date while I'm here. 2006-04-27 15:48:54 +00:00			`and library archives`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`specified on the command line.`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`The`
			`.Nm`
			`utility outputs a list of file names where the first file contains a symbol`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`which is defined by the second file.`
			`.Pp`
			`The output is normally used with`
Deal with double whitespace. 2004-07-03 00:24:45 +00:00			`.Xr tsort 1`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`when a library is created to determine the optimum ordering of the`
			`object modules so that all references may be resolved in a single`
			`pass of the loader.`
ru@ recently changed lorder to support library archives. Document this new feature prominently. Bump date while I'm here. 2006-04-27 15:48:54 +00:00			`.Pp`
			`When linking static binaries,`
Markup fixes. 2006-09-29 15:20:48 +00:00			`.Nm`
			`and`
			`.Xr tsort 1`
ru@ recently changed lorder to support library archives. Document this new feature prominently. Bump date while I'm here. 2006-04-27 15:48:54 +00:00			`can be used to properly order library archives automatically.`
Document the NM environment variable. 2006-10-25 09:40:07 +00:00			`.Sh ENVIRONMENT`
			`.Bl -tag -width indent`
			`.It Ev NM`
			`Path to the`
			`.Xr nm 1`
			`binary, defaults to`
			`.Dq Li nm .`
Introduce a new make variable: NMFLAGS. As the name indicates, these are flags to pass to nm(1). The newer binutils have a plugin mechanism so, to build something with LLVM's LTO, we need to pass flags to nm(1). This commit also extends lorder(1) to pass NMFLAGS to nm(1). 2015-08-14 22:54:52 +00:00			`.It Ev NMFLAGS`
			`Flags to pass to`
			`.Xr nm 1 .`
Document the NM environment variable. 2006-10-25 09:40:07 +00:00			`.El`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh EXAMPLES`
			`.Bd -literal -offset indent`
typo. Submitted by: "Philippe Charnier" <charnier@lirmm.fr> 1996-06-10 15:55:48 +00:00			ar cr library.a `lorder ${OBJS} \| tsort`
ru@ recently changed lorder to support library archives. Document this new feature prominently. Bump date while I'm here. 2006-04-27 15:48:54 +00:00			cc -o foo ${OBJS} `lorder ${STATIC_LIBS} \| tsort`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Ed`
			`.Sh SEE ALSO`
			`.Xr ar 1 ,`
			`.Xr ld 1 ,`
			`.Xr nm 1 ,`
			`.Xr ranlib 1 ,`
			`.Xr tsort 1`
			`.Sh HISTORY`
Typo. 1997-07-23 06:48:01 +00:00			`A`
			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`utility appeared in`
			`.At v7 .`