| blob | 3f0d814a1a7bf64bbc2881c2226b2556c6902065 |
1 '\" te
2 .\" Copyright 1989 AT&T
3 .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved
4 .\" Portions Copyright (c) 1982-2007 AT&T Knowledge Ventures
5 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
6 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
7 .\" http://www.opengroup.org/bookstore/.
8 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
9 .\" This notice shall appear on any product containing this material.
10 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
11 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
12 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
13 .TH UMASK 1 "Sep 17, 2007"
14 .SH NAME
15 umask \- get or set the file mode creation mask
16 .SH SYNOPSIS
17 .LP
18 .nf
19 \fB/usr/bin/umask\fR [\fB-S\fR] [\fImask\fR]
20 .fi
22 .SS "sh"
23 .LP
24 .nf
25 \fBumask\fR [\fIooo\fR]
26 .fi
28 .SS "csh"
29 .LP
30 .nf
31 \fBumask\fR [\fIooo\fR]
32 .fi
34 .SS "ksh"
35 .LP
36 .nf
37 \fBumask\fR [\fB-S\fR] [\fImask\fR]
38 .fi
40 .SS "ksh93"
41 .LP
42 .nf
43 \fBumask\fR [\fB-S\fR] [\fImask\fR]
44 .fi
46 .SH DESCRIPTION
47 .sp
48 .LP
49 The \fBumask\fR utility sets the file mode creation mask of the current shell
50 execution environment to the value specified by the \fImask\fR operand. This
51 mask affects the initial value of the file permission bits of subsequently
52 created files. If \fBumask\fR is called in a subshell or separate utility
53 execution environment, such as one of the following:
54 .sp
55 .in +2
56 .nf
57 (umask 002)
58 nohup umask ...
59 find . -exec umask ...
60 .fi
61 .in -2
62 .sp
64 .sp
65 .LP
66 it does not affect the file mode creation mask of the caller's environment. For
67 this reason, the \fB/usr/bin/umask\fR utility cannot be used to change the
68 umask in an ongoing session. Its usefulness is limited to checking the caller's
69 umask. To change the umask of an ongoing session you must use one of the shell
70 builtins.
71 .sp
72 .LP
73 If the \fImask\fR operand is not specified, the \fBumask\fR utility writes the
74 value of the invoking process's file mode creation mask to standard output.
75 .SS "sh"
76 .sp
77 .LP
78 The user file-creation mode mask is set to \fIooo\fR. The three octal digits
79 refer to read/write/execute permissions for owner, group, and other,
80 respectively (see \fBchmod\fR(1), \fBchmod\fR(2), and \fBumask\fR(2)). The
81 value of each specified digit is subtracted from the corresponding ``digit''
82 specified by the system for the creation of a file (see \fBcreat\fR(2)). For
83 example, \fBumask\fR \fB022\fR removes write permission for group and other.
84 Files (and directories) normally created with mode \fB777\fR become mode
85 \fB755\fR. Files (and directories) created with mode \fB666\fR become mode
86 \fB644\fR).
87 .RS +4
88 .TP
89 .ie t \(bu
90 .el o
91 If \fIooo\fR is omitted, the current value of the mask is printed.
92 .RE
93 .RS +4
94 .TP
95 .ie t \(bu
96 .el o
97 \fBumask\fR is recognized and executed by the shell.
98 .RE
99 .RS +4
100 .TP
101 .ie t \(bu
102 .el o
103 \fBumask\fR can be included in the user's \fB\&.profile\fR (see
104 \fBprofile\fR(4)) and invoked at login to automatically set the user's
105 permissions on files or directories created.
106 .RE
107 .SS "csh"
108 .sp
109 .LP
110 See the description above for the Bourne shell (\fBsh\fR)\fBumask\fR built-in.
111 .SS "ksh"
112 .sp
113 .LP
114 The user file-creation mask is set to \fImask\fR. \fImask\fR can either be an
115 octal number or a symbolic value as described in \fBchmod\fR(1). If a symbolic
116 value is given, the new \fBumask\fR value is the complement of the result of
117 applying \fImask\fR to the complement of the previous umask value. If
118 \fImask\fR is omitted, the current value of the mask is printed.
119 .SS "ksh93"
120 .sp
121 .LP
122 \fBumask\fR sets the file creation mask of the current shell execution
123 environment to the value specified by the \fBmask\fI\fR\fR operand. This mask
124 affects the file permission bits of subsequently created files. \fImask\fR can
125 either be an octal number or a symbolic value as described in chmod(1). If a
126 symbolic value is specified, the new file creation mask is the complement of
127 the result of applying \fImask\fR to the complement of the current file
128 creation mask. If \fImask\fR is not specified, \fBumask\fR writes the value of
129 the file creation mask for the current process to standard output.
130 .SH OPTIONS
131 .SS "ksh"
132 .sp
133 .LP
134 The following option is supported for \fB/usr/bin/umask\fR and \fBumask\fR in
135 \fBksh\fR:
136 .sp
137 .ne 2
138 .na
139 \fB\fB-S\fR\fR
140 .ad
141 .RS 6n
142 Produces symbolic output.
143 .RE
145 .sp
146 .LP
147 The default output style is unspecified, but will be recognized on a subsequent
148 invocation of \fBumask\fR on the same system as a \fImask\fR operand to restore
149 the previous file mode creation mask.
150 .SS "ksh93"
151 .sp
152 .LP
153 The following option is supported in \fBksh93\fR:
154 .sp
155 .ne 2
156 .na
157 \fB\fB-S\fR\fR
158 .ad
159 .RS 6n
160 Causes the file creation mask to be written or treated as a symbolic value
161 rather than an octal number.
162 .RE
164 .SH OPERANDS
165 .sp
166 .LP
167 The following operand is supported:
168 .sp
169 .ne 2
170 .na
171 \fB\fImask\fR\fR
172 .ad
173 .RS 8n
174 A string specifying the new file mode creation mask. The string is treated in
175 the same way as the \fImode\fR operand described in the \fBchmod\fR(1) manual
176 page.
177 .sp
178 For a \fIsymbolic_mode\fR value, the new value of the file mode creation mask
179 is the logical complement of the file permission bits portion of the file mode
180 specified by the \fIsymbolic_mode\fR string.
181 .sp
182 In a \fIsymbolic_mode\fR value, the permissions \fIop\fR characters \fB+\fR and
183 \fB\(mi\fR are interpreted relative to the current file mode creation mask.
184 \fB+\fR causes the bits for the indicated permissions to be cleared in the
185 mask. \fB\(mi\fR causes the bits of the indicated permissions to be set in the
186 mask.
187 .sp
188 The interpretation of \fImode\fR values that specify file mode bits other than
189 the file permission bits is unspecified.
190 .sp
191 The file mode creation mask is set to the resulting numeric value.
192 .sp
193 The default output of a prior invocation of \fBumask\fR on the same system with
194 no operand will also be recognized as a \fImask\fR operand. The use of an
195 operand obtained in this way is not obsolescent, even if it is an octal number.
196 .RE
198 .SH OUTPUT
199 .sp
200 .LP
201 When the \fImask\fR operand is not specified, the \fBumask\fR utility will
202 write a message to standard output that can later be used as a \fBumask\fR
203 \fImask\fR operand.
204 .sp
205 .LP
206 If \fB-S\fR is specified, the message will be in the following format:
207 .sp
208 .in +2
209 .nf
210 "u=%s,g=%s,o=%s\en", \fIowner permissions\fR, \fIgroup permissions\fR, \e
211 \fIother permissions\fR
212 .fi
213 .in -2
214 .sp
216 .sp
217 .LP
218 where the three values will be combinations of letters from the set
219 \fB{\fRr\fB,\fR \fBw\fR, \fBx\fR}. The presence of a letter will indicate that
220 the corresponding bit is clear in the file mode creation mask.
221 .sp
222 .LP
223 If a \fImask\fR operand is specified, there will be no output written to
224 standard output.
225 .SH EXAMPLES
226 .LP
227 \fBExample 1 \fRUsing the \fBumask\fR Command
228 .sp
229 .LP
230 The examples in this section refer to the \fB/usr/bin/umask\fR utility and the
231 \fBksh umask\fR builtin.
233 .sp
234 .LP
235 Either of the commands:
237 .sp
238 .in +2
239 .nf
240 \fBumask a=rx,ug+w
241 umask 002\fR
242 .fi
243 .in -2
244 .sp
246 .sp
247 .LP
248 sets the mode mask so that subsequently created files have their \fBS_IWOTH\fR
249 bit cleared.
251 .sp
252 .LP
253 After setting the mode mask with either of the above commands, the \fBumask\fR
254 command can be used to write the current value of the mode mask:
256 .sp
257 .in +2
258 .nf
259 example$ \fBumask\fR
260 0002
261 .fi
262 .in -2
263 .sp
265 .sp
266 .LP
267 The output format is unspecified, but historical implementations use the
268 obsolescent octal integer mode format.
270 .sp
271 .in +2
272 .nf
273 example$ \fBumask -S\fR
274 u=rwx,g=rwx,o=rx
275 .fi
276 .in -2
277 .sp
279 .sp
280 .LP
281 Either of these outputs can be used as the mask operand to a subsequent
282 invocation of the \fBumask\fR utility.
284 .sp
285 .LP
286 Assuming the mode mask is set as above, the command:
288 .sp
289 .in +2
290 .nf
291 \fBumask g-w\fR
292 .fi
293 .in -2
294 .sp
296 .sp
297 .LP
298 sets the mode mask so that subsequently created files have their \fBS_IWGRP\fR
299 and \fBS_IWOTH\fR bits cleared.
301 .sp
302 .LP
303 The command:
305 .sp
306 .in +2
307 .nf
308 \fBumask --w\fR
309 .fi
310 .in -2
311 .sp
313 .sp
314 .LP
315 sets the mode mask so that subsequently created files have all their write bits
316 cleared. Notice that \fImask\fR operands \fBr\fR, \fBw\fR, \fBx\fR, or anything
317 beginning with a hyphen (\fB\(mi\fR), must be preceded by \fB-\fR to keep it
318 from being interpreted as an option.
320 .SH ENVIRONMENT VARIABLES
321 .sp
322 .LP
323 See \fBenviron\fR(5) for descriptions of the following environment variables
324 that affect the execution of \fBumask\fR: \fBLANG\fR, \fBLC_ALL\fR,
325 \fBLC_COLLATE\fR\fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
326 .SH EXIT STATUS
327 .sp
328 .LP
329 The following exit values are returned:
330 .sp
331 .ne 2
332 .na
333 \fB\fB0\fR\fR
334 .ad
335 .RS 6n
336 The file mode creation mask was successfully changed, or no \fImask\fR operand
337 was supplied.
338 .RE
340 .sp
341 .ne 2
342 .na
343 \fB\fB>0\fR\fR
344 .ad
345 .RS 6n
346 An error occurred.
347 .RE
349 .SH ATTRIBUTES
350 .sp
351 .LP
352 See \fBattributes\fR(5) for descriptions of the following attributes:
353 .SS "/usr/bin/umask, csh, ksh, sh"
354 .sp
356 .sp
357 .TS
358 box;
359 c | c
360 l | l .
361 ATTRIBUTE TYPE ATTRIBUTE VALUE
362 _
363 Interface Stability Standard
364 .TE
366 .SS "ksh93"
367 .sp
369 .sp
370 .TS
371 box;
372 c | c
373 l | l .
374 ATTRIBUTE TYPE ATTRIBUTE VALUE
375 _
376 Interface Stability External
377 .TE
379 .SH SEE ALSO
380 .sp
381 .LP
382 \fBchmod\fR(1), \fBcsh\fR(1), \fBksh\fR(1), \fBksh93\fR(1), \fBsh\fR(1),
383 \fBchmod\fR(2), \fBcreat\fR(2), \fBumask\fR(2), \fBprofile\fR(4),
384 \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)