external/bsd/elftoolchain/dist/libelf/elf_kind.3

   1 .\"     $NetBSD: elf_kind.3,v 1.2 2014/03/09 16:58:04 christos Exp $
   2 .\"
   3 .\" Copyright (c) 2006,2008 Joseph Koshy.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" This software is provided by Joseph Koshy ``as is'' and
  15 .\" any express or implied warranties, including, but not limited to, the
  16 .\" implied warranties of merchantability and fitness for a particular purpose
  17 .\" are disclaimed.  in no event shall Joseph Koshy be liable
  18 .\" for any direct, indirect, incidental, special, exemplary, or consequential
  19 .\" damages (including, but not limited to, procurement of substitute goods
  20 .\" or services; loss of use, data, or profits; or business interruption)
  21 .\" however caused and on any theory of liability, whether in contract, strict
  22 .\" liability, or tort (including negligence or otherwise) arising in any way
  23 .\" out of the use of this software, even if advised of the possibility of
  24 .\" such damage.
  25 .\"
  26 .\" Id: elf_kind.3 189 2008-07-20 10:38:08Z jkoshy
  27 .\"
  28 .Dd June 1, 2006
  29 .Os
  30 .Dt ELF_KIND 3
  31 .Sh NAME
  32 .Nm elf_kind
  33 .Nd determine ELF file type
  34 .Sh LIBRARY
  35 .Lb libelf
  36 .Sh SYNOPSIS
  37 .In libelf.h
  38 .Ft Elf_Kind
  39 .Fn elf_kind "Elf *elf"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn elf_kind
  43 function identifies the kind of file associated with its argument
  44 .Ar elf .
  45 The argument
  46 .Ar elf
  47 is allowed to be NULL.
  48 .Sh RETURN VALUES
  49 The
  50 .Fn elf_kind
  51 function returns one of the following values:
  52 .Bl -tag -width indent
  53 .It Dv ELF_K_AR
  54 The file associated with argument
  55 .Ar elf
  56 is an archive.
  57 .It Dv ELF_K_ELF
  58 The file associated with argument
  59 .Ar elf
  60 is an ELF file.
  61 .It Dv ELF_K_NONE
  62 The argument
  63 .Ar elf
  64 was NULL, or the ELF library could not determine the type of the file
  65 associated with argument
  66 .Ar elf ,
  67 or an error occurred when processing.
  68 .El
  69 .Sh SEE ALSO
  70 .Xr elf 3 ,
  71 .Xr elf_begin 3 ,
  72 .Xr elf_getident 3 ,
  73 .Xr gelf 3