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