bsd/man/man2/setlcid.2

   1 .\" Copyright (c) 2005 SPARTA, Inc.
   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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .\" Note: The date here should be updated whenever a non-trivial
  28 .\" change is made to the manual page.
  29 .Dd May 5, 2005
  30 .Dt SETLCID 3
  31 .Os
  32 .Sh NAME
  33 .Nm setlcid
  34 .Nd "set login context"
  35 .Sh SYNOPSIS
  36 .In sys/lctx.h
  37 .Ft int
  38 .Fn setlcid "pid_t pid" "pid_t lcid"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn setlcid
  42 system call sets the login context of the specified process
  43 .Fa pid
  44 to the specified
  45 .Fa lcid .
  46 If the
  47 .Fa pid
  48 is zero, then the call applies to the current process.
  49 If the
  50 .Fa lcid
  51 is zero a new login context will be created.
  52 If the
  53 .Fa lcid
  54 is \-1 the process will be removed from the login context
  55 it is currently a member of, if any.
  56 .Pp
  57 Creation of a new login context is only valid for the current process.
  58 A process may not create a new login context if it is currently a member
  59 of one.
  60 .Pp
  61 Superuser privilege is required to add or remove a process from
  62 a login context.
  63 .Sh RETURN VALUES
  64 .Rv -std setlcid
  65 .Sh ERRORS
  66 The
  67 .Fn setlcid
  68 function will fail if:
  69 .Bl -tag -width Er
  70 .It Bq Er EPERM
  71 Operation not permitted.
  72 .It Bq Er ESRCH
  73 No such process.
  74 .It Bq Er ENOMEM
  75 Cannot allocate memory.
  76 .It Bq Er ENOATTR
  77 Attribute not found.
  78 .El
  79 .Sh SEE ALSO
  80 .Xr getlcid 2
  81 .Sh HISTORY
  82 The
  83 .Nm
  84 manual page
  85 first appeared in
  86 .Fx 6.0 .
  87 .Sh AUTHORS
  88 This
  89 manual page was written by
  90 .An Matthew N. Dodd Aq mdodd@FreeBSD.org .