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