man3/getutmp.3

   1 .\" Copyright (c) 2008, Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH GETUTMP 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 getutmp, getutmpx \- copy utmp structure to utmpx, and vice versa
  29 .SH SYNOPSIS
  30 .nf
  31 .BR "#define _GNU_SOURCE" "             /* See feature_test_macros(7) */"
  32 .B #include <utmpx.h>
  33 .PP
  34 .BI "void getutmp(const struct utmpx *" ux ", struct utmp *" u );
  35 .BI "void getutmpx(const struct utmp *" u ", struct utmpx *" ux );
  36 .fi
  37 .SH DESCRIPTION
  38 The
  39 .BR getutmp ()
  40 function copies the fields of the
  41 .I utmpx
  42 structure pointed to by
  43 .I ux
  44 to the corresponding fields of the
  45 .I utmp
  46 structure pointed to by
  47 .IR u .
  48 The
  49 .BR getutmpx ()
  50 function performs the converse operation.
  51 .SH RETURN VALUE
  52 These functions do not return a value.
  53 .SH VERSIONS
  54 These functions first appeared in glibc in version 2.1.1.
  55 .SH ATTRIBUTES
  56 For an explanation of the terms used in this section, see
  57 .BR attributes (7).
  58 .ad l
  59 .nh
  60 .TS
  61 allbox;
  62 lbx lb lb
  63 l l l.
  64 Interface       Attribute       Value
  65 T{
  66 .BR getutmp (),
  67 .BR getutmpx ()
  68 T}      Thread safety   MT-Safe
  69 .TE
  70 .hy
  71 .ad
  72 .sp 1
  73 .SH CONFORMING TO
  74 These functions are nonstandard, but appear on a few other systems,
  75 such as Solaris and NetBSD.
  76 .SH NOTES
  77 These functions exist primarily for compatibility with other
  78 systems where the
  79 .I utmp
  80 and
  81 .I utmpx
  82 structures contain different fields,
  83 or the size of corresponding fields differs.
  84 .\" e.g., on Solaris, the utmpx structure is rather larger than utmp.
  85 On Linux, the two structures contain the same fields,
  86 and the fields have the same sizes.
  87 .SH SEE ALSO
  88 .BR utmpdump (1),
  89 .BR getutent (3),
  90 .BR utmp (5)