xref: /netbsd-src/external/bsd/elftoolchain/dist/libelf/elf_kind.3 (revision 5ac3bc719ce6e70593039505b491894133237d12)
1*5ac3bc71Schristos.\"	$NetBSD: elf_kind.3,v 1.6 2024/03/03 17:37:33 christos Exp $
2e81373b4Schristos.\"
39dd9d0cfSchristos.\" Copyright (c) 2006,2008 Joseph Koshy.  All rights reserved.
49dd9d0cfSchristos.\"
59dd9d0cfSchristos.\" Redistribution and use in source and binary forms, with or without
69dd9d0cfSchristos.\" modification, are permitted provided that the following conditions
79dd9d0cfSchristos.\" are met:
89dd9d0cfSchristos.\" 1. Redistributions of source code must retain the above copyright
99dd9d0cfSchristos.\"    notice, this list of conditions and the following disclaimer.
109dd9d0cfSchristos.\" 2. Redistributions in binary form must reproduce the above copyright
119dd9d0cfSchristos.\"    notice, this list of conditions and the following disclaimer in the
129dd9d0cfSchristos.\"    documentation and/or other materials provided with the distribution.
139dd9d0cfSchristos.\"
149dd9d0cfSchristos.\" This software is provided by Joseph Koshy ``as is'' and
159dd9d0cfSchristos.\" any express or implied warranties, including, but not limited to, the
169dd9d0cfSchristos.\" implied warranties of merchantability and fitness for a particular purpose
179dd9d0cfSchristos.\" are disclaimed.  in no event shall Joseph Koshy be liable
189dd9d0cfSchristos.\" for any direct, indirect, incidental, special, exemplary, or consequential
199dd9d0cfSchristos.\" damages (including, but not limited to, procurement of substitute goods
209dd9d0cfSchristos.\" or services; loss of use, data, or profits; or business interruption)
219dd9d0cfSchristos.\" however caused and on any theory of liability, whether in contract, strict
229dd9d0cfSchristos.\" liability, or tort (including negligence or otherwise) arising in any way
239dd9d0cfSchristos.\" out of the use of this software, even if advised of the possibility of
249dd9d0cfSchristos.\" such damage.
259dd9d0cfSchristos.\"
263f622274Sjkoshy.\" Id: elf_kind.3 3957 2022-03-12 14:11:52Z jkoshy
279dd9d0cfSchristos.\"
289dd9d0cfSchristos.Dd June 1, 2006
299dd9d0cfSchristos.Dt ELF_KIND 3
30c5261b83Sjkoshy.Os
319dd9d0cfSchristos.Sh NAME
329dd9d0cfSchristos.Nm elf_kind
339dd9d0cfSchristos.Nd determine ELF file type
349dd9d0cfSchristos.Sh LIBRARY
359dd9d0cfSchristos.Lb libelf
369dd9d0cfSchristos.Sh SYNOPSIS
379dd9d0cfSchristos.In libelf.h
389dd9d0cfSchristos.Ft Elf_Kind
399dd9d0cfSchristos.Fn elf_kind "Elf *elf"
409dd9d0cfSchristos.Sh DESCRIPTION
419dd9d0cfSchristosThe
429dd9d0cfSchristos.Fn elf_kind
439dd9d0cfSchristosfunction identifies the kind of file associated with its argument
443f622274Sjkoshy.Fa elf .
459dd9d0cfSchristosThe argument
463f622274Sjkoshy.Fa elf
47c5261b83Sjkoshyis allowed to be
48c5261b83Sjkoshy.Dv NULL .
499dd9d0cfSchristos.Sh RETURN VALUES
509dd9d0cfSchristosThe
519dd9d0cfSchristos.Fn elf_kind
529dd9d0cfSchristosfunction returns one of the following values:
539dd9d0cfSchristos.Bl -tag -width indent
549dd9d0cfSchristos.It Dv ELF_K_AR
559dd9d0cfSchristosThe file associated with argument
563f622274Sjkoshy.Fa elf
579dd9d0cfSchristosis an archive.
589dd9d0cfSchristos.It Dv ELF_K_ELF
599dd9d0cfSchristosThe file associated with argument
603f622274Sjkoshy.Fa elf
619dd9d0cfSchristosis an ELF file.
629dd9d0cfSchristos.It Dv ELF_K_NONE
639dd9d0cfSchristosThe argument
643f622274Sjkoshy.Fa elf
65c5261b83Sjkoshywas
66c5261b83Sjkoshy.Dv NULL ,
67c5261b83Sjkoshyor the ELF library could not determine the type of the file
689dd9d0cfSchristosassociated with argument
693f622274Sjkoshy.Fa elf ,
709dd9d0cfSchristosor an error occurred when processing.
719dd9d0cfSchristos.El
729dd9d0cfSchristos.Sh SEE ALSO
739dd9d0cfSchristos.Xr elf 3 ,
749dd9d0cfSchristos.Xr elf_begin 3 ,
759dd9d0cfSchristos.Xr elf_getident 3 ,
769dd9d0cfSchristos.Xr gelf 3
77