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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)symorder.1  6.5 (Berkeley) 4/22/91
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd April 22, 1991
  36 .Dt SYMORDER 1
  37 .Os
  38 .Sh NAME
  39 .Nm symorder
  40 .Nd rearrange name list
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl c
  44 .Op Fl m
  45 .Op Fl t
  46 .Op Fl x Ar excludelist
  47 .Ar symlist file
  48 .Sh DESCRIPTION
  49 The file
  50 .Ar symlist
  51 contains a list of symbols to be found in
  52 .Ar file ,
  53 one symbol per line.
  54 .Pp
  55 The symbol table of
  56 .Ar file
  57 is updated in place;
  58 symbols read from
  59 .Ar symlist
  60 are relocated to the beginning of the table and in the order given.
  61 .Pp
  62 The following options are available:
  63 .Bl -tag -width indent
  64 .It Fl c
  65 Make all any symbols not in
  66 .Ar symlist
  67 local to this file.
  68 .It Fl t
  69 Restrict the symbol table to the symbols listed in
  70 .Ar symlist .
  71 .It Fl x Ar excludelist
  72 Exclude the symbols listed in
  73 .Ar excludelist
  74 from the symbol table.
  75 .It Fl m
  76 Exit with status zero, even if some symbols are missing.
  77 .El
  78 .Pp
  79 This program was specifically designed to cut down on the
  80 overhead of getting symbols from
  81 .Pa /boot/kernel/kernel .
  82 .Sh DIAGNOSTICS
  83 The
  84 .Nm
  85 utility exits 0 on success, 1 if a symbol
  86 listed in the
  87 .Ar symlist
  88 file was not found in the symbol
  89 table, and >1 if an error occurs.
  90 .Sh SEE ALSO
  91 .Xr nm 1 ,
  92 .Xr strip 1 ,
  93 .Xr nlist 3
  94 .Sh HISTORY
  95 The
  96 .Nm
  97 command appeared in
  98 .Bx 3.0 .