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 .\" 4. 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 .\" $DragonFly: src/usr.bin/symorder/symorder.1,v 1.3 2008/09/02 11:50:46 matthias Exp $
  31 .\"
  32 .Dd September 2, 2008
  33 .Dt SYMORDER 1
  34 .Os
  35 .Sh NAME
  36 .Nm symorder
  37 .Nd rearrange name list
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl c
  41 .Op Fl m
  42 .Op Fl t
  43 .Op Fl x Ar excludelist
  44 .Ar symlist file
  45 .Sh DESCRIPTION
  46 The file
  47 .Ar symlist
  48 contains a list of symbols to be found in
  49 .Ar file ,
  50 one symbol per line.
  51 .Pp
  52 The symbol table of
  53 .Ar file
  54 is updated in place;
  55 symbols read from
  56 .Ar symlist
  57 are relocated to the beginning of the table and in the order given.
  58 .Bl -tag -width flag
  59 .It Fl c
  60 Makes all any symbols not in
  61 .Ar symlist
  62 local to this file.
  63 .It Fl t
  64 Restrict the symbol table to the symbols listed in
  65 .Ar symlist .
  66 .It Fl x Ar excludelist
  67 Exclude the symbols listed in
  68 .Ar excludelist
  69 from the symbol table.
  70 .It Fl m
  71 Exit with status zero, even if some symbols are missing.
  72 .El
  73 .Pp
  74 This program was specifically designed to cut down on the
  75 overhead of getting symbols from
  76 .Pa /boot/kernel .
  77 .Sh DIAGNOSTICS
  78 The
  79 .Nm
  80 utility exits 0 on success, 1 if a symbol
  81 listed in the
  82 .Ar symlist
  83 file was not found in the symbol
  84 table, and >1 if an error occurs.
  85 .Sh SEE ALSO
  86 .Xr nm 1 ,
  87 .Xr strip 1 ,
  88 .Xr nlist 3
  89 .Sh HISTORY
  90 The
  91 .Nm
  92 command appeared in
  93 .Bx 3.0 .