lib/libc/sys/umask.2

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)umask.2     8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 4, 1993
  32 .Dt UMASK 2
  33 .Os
  34 .Sh NAME
  35 .Nm umask
  36 .Nd set file creation mode mask
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/stat.h
  41 .Ft mode_t
  42 .Fn umask "mode_t numask"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn umask
  46 routine sets the process's file mode creation mask to
  47 .Fa numask
  48 and returns the previous value of the mask.
  49 The 9 low-order
  50 access permission
  51 bits of
  52 .Fa numask
  53 are used by system calls, including
  54 .Xr open 2 ,
  55 .Xr mkdir 2 ,
  56 and
  57 .Xr mkfifo 2 ,
  58 to turn off corresponding bits
  59 requested in file mode.
  60 (See
  61 .Xr chmod 2 ) .
  62 This clearing allows each user to restrict the default access
  63 to his files.
  64 .Pp
  65 The default mask value is S_IWGRP|S_IWOTH (022, write access for the
  66 owner only).
  67 Child processes inherit the mask of the calling process.
  68 .Sh RETURN VALUES
  69 The previous value of the file mode mask is returned by the call.
  70 .Sh ERRORS
  71 The
  72 .Fn umask
  73 system call is always successful.
  74 .Sh SEE ALSO
  75 .Xr chmod 2 ,
  76 .Xr mkfifo 2 ,
  77 .Xr mknod 2 ,
  78 .Xr open 2
  79 .Sh STANDARDS
  80 The
  81 .Fn umask
  82 system call is expected to conform to
  83 .St -p1003.1-90 .
  84 .Sh HISTORY
  85 The
  86 .Fn umask
  87 function appeared in
  88 .At v7 .