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: src/lib/libc/sys/umask.2,v 1.6.2.4 2001/12/14 18:34:02 ru Exp $
  30 .\" $DragonFly: src/lib/libc/sys/umask.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  31 .\"
  32 .Dd June 4, 1993
  33 .Dt UMASK 2
  34 .Os
  35 .Sh NAME
  36 .Nm umask
  37 .Nd set file creation mode mask
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/stat.h
  42 .Ft mode_t
  43 .Fn umask "mode_t numask"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn umask
  47 routine sets the process's file mode creation mask to
  48 .Fa numask
  49 and returns the previous value of the mask.  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 function is always successful.
  74 .Sh SEE ALSO
  75 .Xr chmod 2 ,
  76 .Xr mknod 2 ,
  77 .Xr open 2
  78 .Sh STANDARDS
  79 The
  80 .Fn umask
  81 function call is expected to conform to
  82 .St -p1003.1-90 .
  83 .Sh HISTORY
  84 An
  85 .Fn umask
  86 function call appeared in
  87 .At v7 .