usr.bin/symorder/symorder.1

   1 .\" Copyright (c) 1980, 1990 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)symorder.1  6.5 (Berkeley) 4/22/91
  29 .\" $FreeBSD: src/usr.bin/symorder/symorder.1,v 1.9.2.3 2001/08/16 13:17:05 ru Exp $
  30 .\"
  31 .Dd September 2, 2008
  32 .Dt SYMORDER 1
  33 .Os
  34 .Sh NAME
  35 .Nm symorder
  36 .Nd rearrange name list
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl c
  40 .Op Fl m
  41 .Op Fl t
  42 .Op Fl x Ar excludelist
  43 .Ar symlist file
  44 .Sh DESCRIPTION
  45 The file
  46 .Ar symlist
  47 contains a list of symbols to be found in
  48 .Ar file ,
  49 one symbol per line.
  50 .Pp
  51 The symbol table of
  52 .Ar file
  53 is updated in place;
  54 symbols read from
  55 .Ar symlist
  56 are relocated to the beginning of the table and in the order given.
  57 .Bl -tag -width flag
  58 .It Fl c
  59 Makes all any symbols not in
  60 .Ar symlist
  61 local to this file.
  62 .It Fl t
  63 Restrict the symbol table to the symbols listed in
  64 .Ar symlist .
  65 .It Fl x Ar excludelist
  66 Exclude the symbols listed in
  67 .Ar excludelist
  68 from the symbol table.
  69 .It Fl m
  70 Exit with status zero, even if some symbols are missing.
  71 .El
  72 .Pp
  73 This program was specifically designed to cut down on the
  74 overhead of getting symbols from
  75 .Pa /boot/kernel .
  76 .Sh EXIT STATUS
  77 The
  78 .Nm
  79 utility exits 0 on success, 1 if a symbol
  80 listed in the
  81 .Ar symlist
  82 file was not found in the symbol
  83 table, and >1 if an error occurs.
  84 .Sh SEE ALSO
  85 .Xr nm 1 ,
  86 .Xr strip 1 ,
  87 .Xr nlist 3
  88 .Sh HISTORY
  89 The
  90 .Nm
  91 command appeared in
  92 .Bx 3.0 .