login/utmp.h

   1 /* Copyright (C) 1993, 1996, 1997, 1998 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3
   4    The GNU C Library is free software; you can redistribute it and/or
   5    modify it under the terms of the GNU Library General Public License as
   6    published by the Free Software Foundation; either version 2 of the
   7    License, or (at your option) any later version.
   8
   9    The GNU C Library is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    Library General Public License for more details.
  13
  14    You should have received a copy of the GNU Library General Public
  15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17    Boston, MA 02111-1307, USA.  */
  18
  19 #ifndef _UTMP_H
  20 #define _UTMP_H 1
  21
  22 #include <features.h>
  23
  24 #include <sys/types.h>
  25
  26
  27 __BEGIN_DECLS
  28
  29 /* Get system dependent values and data structures.  */
  30 #include <bits/utmp.h>
  31
  32 /* Compatibility names for the strings of the canonical file names.  */
  33 #define UTMP_FILE       _PATH_UTMP
  34 #define UTMP_FILENAME   _PATH_UTMP
  35 #define WTMP_FILE       _PATH_WTMP
  36 #define WTMP_FILENAME   _PATH_WTMP
  37
  38
  39
  40 /* Make FD be the controlling terminal, stdin, stdout, and stderr;
  41    then close FD.  Returns 0 on success, nonzero on error.  */
  42 extern int login_tty __P ((int __fd));
  43
  44
  45 /* Write the given entry into utmp and wtmp.  */
  46 extern void login __P ((__const struct utmp *__entry));
  47
  48 /* Write the utmp entry to say the user on UT_LINE has logged out.  */
  49 extern int logout __P ((__const char *__ut_line));
  50
  51 /* Append to wtmp an entry for the current time and the given info.  */
  52 extern void logwtmp __P ((__const char *__ut_line, __const char *__ut_name,
  53                           __const char *__ut_host));
  54
  55 /* Append entry UTMP to the wtmp-like file WTMP_FILE.  */
  56 extern void __updwtmp __P ((__const char *__wtmp_file,
  57                             __const struct utmp *__utmp));
  58 extern void updwtmp __P ((__const char *__wtmp_file,
  59                           __const struct utmp *__utmp));
  60
  61 /* Change name of the utmp file to be examined.  */
  62 extern int __utmpname __P ((__const char *__file));
  63 extern int utmpname __P ((__const char *__file));
  64
  65 /* Read next entry from a utmp-like file.  */
  66 extern struct utmp *__getutent __P ((void));
  67 extern struct utmp *getutent __P ((void));
  68
  69 /* Reset the input stream to the beginning of the file.  */
  70 extern void __setutent __P ((void));
  71 extern void setutent __P ((void));
  72
  73 /* Close the current open file.  */
  74 extern void __endutent __P ((void));
  75 extern void endutent __P ((void));
  76
  77 /* Search forward from the current point in the utmp file until the
  78    next entry with a ut_type matching ID->ut_type.  */
  79 extern struct utmp *__getutid __P ((__const struct utmp *__id));
  80 extern struct utmp *getutid __P ((__const struct utmp *__id));
  81
  82 /* Search forward from the current point in the utmp file until the
  83    next entry with a ut_line matching LINE->ut_line.  */
  84 extern struct utmp *__getutline __P ((__const struct utmp *__line));
  85 extern struct utmp *getutline __P ((__const struct utmp *__line));
  86
  87 /* Write out entry pointed to by UTMP_PTR into the utmp file.  */
  88 extern struct utmp *__pututline __P ((__const struct utmp *__utmp_ptr));
  89 extern struct utmp *pututline __P ((__const struct utmp *__utmp_ptr));
  90
  91
  92 #ifdef  __USE_MISC
  93 /* Reentrant versions of the file for handling utmp files.  */
  94 extern int __getutent_r __P ((struct utmp *__buffer, struct utmp **__result));
  95 extern int getutent_r __P ((struct utmp *__buffer, struct utmp **__result));
  96
  97 extern int __getutid_r __P ((__const struct utmp *__id, struct utmp *__buffer,
  98                              struct utmp **__result));
  99 extern int getutid_r __P ((__const struct utmp *__id, struct utmp *__buffer,
 100                            struct utmp **__result));
 101
 102 extern int __getutline_r __P ((__const struct utmp *__line,
 103                                struct utmp *__buffer, struct utmp **__result));
 104 extern int getutline_r __P ((__const struct utmp *__line,
 105                              struct utmp *__buffer, struct utmp **__result));
 106
 107 #endif  /* Use misc.  */
 108
 109 __END_DECLS
 110
 111 #endif /* utmp.h  */