1.\" $OpenBSD: strmode.3,v 1.8 2000/04/21 15:24:20 aaron Exp $ 2.\" 3.\" Copyright (c) 1990, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)strmode.3 8.3 (Berkeley) 7/28/94 35.\" 36.Dd July 28, 1994 37.Dt STRMODE 3 38.Os 39.Sh NAME 40.Nm strmode 41.Nd convert inode status information into a symbolic string 42.Sh SYNOPSIS 43.Fd #include <string.h> 44.Ft void 45.Fn strmode "mode_t mode" "char *bp" 46.Sh DESCRIPTION 47The 48.Fn strmode 49function converts a file 50.Fa mode 51(the type and permission information associated with an inode, see 52.Xr stat 2 ) 53into a symbolic string which is stored in the location referenced by 54.Fa bp . 55This stored string is eleven characters in length plus a trailing null byte. 56.Pp 57The first character is the inode type, and will be one of the following: 58.Pp 59.Bl -tag -width flag -offset indent -compact 60.It \- 61regular file 62.It b 63block special 64.It c 65character special 66.It d 67directory 68.It l 69symbolic link 70.It p 71fifo 72.It s 73socket 74.It w 75whiteout 76.It ? 77unknown inode type 78.El 79.Pp 80The next nine characters encode three sets of permissions, in three 81characters each. 82The first three characters are the permissions for the owner of the 83file, the second three for the group the file belongs to, and the 84third for the 85.Dq other , 86or default, set of users. 87.Pp 88Permission checking is done as specifically as possible. 89If read permission is denied to the owner of a file in the first set 90of permissions, the owner of the file will not be able to read the file. 91This is true even if the owner is in the file's group and the group 92permissions allow reading or the 93.Dq other 94permissions allow reading. 95.Pp 96If the first character of the three character set is an 97.Sq r , 98the file is readable for that set of users; if a dash 99.Pq Ql - , 100it is not readable. 101.Pp 102If the second character of the three character set is a 103.Sq w , 104the file is writable for that set of users; if a dash 105.Pq Ql - , 106it is not writable. 107.Pp 108The third character is the first of the following characters that apply: 109.Bl -tag -width xxxx 110.It S 111If the character is part of the owner permissions and the file is not 112executable or the directory is not searchable by the owner, and the 113set-user-ID bit is set. 114.It S 115If the character is part of the group permissions and the file is not 116executable or the directory is not searchable by the group, and the 117set-group-ID bit is set. 118.It T 119If the character is part of the other permissions and the file is not 120executable or the directory is not searchable by others, and the 121.Dq sticky 122.Pq Dv S_ISVTX 123bit is set. 124.It s 125If the character is part of the owner permissions and the file is 126executable or the directory searchable by the owner, and the set-user-ID 127bit is set. 128.It s 129If the character is part of the group permissions and the file is 130executable or the directory searchable by the group, and the set-group-ID 131bit is set. 132.It t 133If the character is part of the other permissions and the file is 134executable or the directory searchable by others, and the 135.Dq sticky 136.Pq Dv S_ISVTX 137bit is set. 138.It x 139The file is executable or the directory is searchable. 140.It \- 141None of the above apply. 142.El 143.Pp 144The last character is a plus sign 145.Pq Ql + 146if there are any alternate 147or additional access control methods associated with the inode, otherwise 148it will be a space. 149.Sh RETURN VALUES 150The 151.Fn strmode 152function always returns 0. 153.Sh SEE ALSO 154.Xr chmod 1 , 155.Xr find 1 , 156.Xr stat 2 , 157.Xr getmode 3 , 158.Xr setmode 3 159.Sh HISTORY 160The 161.Fn strmode 162function first appeared in 163.Bx 4.4 . 164