1.\" $OpenBSD: strmode.3,v 1.6 1998/06/15 17:55:13 mickey 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 50converts a file 51.Fa mode 52(the type and permission information associated with an inode, see 53.Xr stat 2 ) 54into a symbolic string which is stored in the location referenced by 55.Fa bp . 56This stored string is eleven characters in length plus a trailing 57.Dv NUL . 58.Pp 59The first character is the inode type, and will be one of the following: 60.Pp 61.Bl -tag -width flag -offset indent -compact 62.It \- 63regular file 64.It b 65block special 66.It c 67character special 68.It d 69directory 70.It l 71symbolic link 72.It p 73fifo 74.It s 75socket 76.It w 77whiteout 78.It ? 79unknown inode type 80.El 81.Pp 82The next nine characters encode three sets of permissions, in three 83characters each. 84The first three characters are the permissions for the owner of the 85file, the second three for the group the file belongs to, and the 86third for the ``other'', or 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 ``other'' permissions allow reading. 93.Pp 94If the first character of the three character set is an ``r'', the file is 95readable for that set of users; if a dash ``\-'', it is not readable. 96.Pp 97If the second character of the three character set is a ``w'', the file is 98writable for that set of users; if a dash ``\-'', it is not writable. 99.Pp 100The third character is the first of the following characters that apply: 101.Bl -tag -width xxxx 102.It S 103If the character is part of the owner permissions and the file is not 104executable or the directory is not searchable by the owner, and the 105set-user-id bit is set. 106.It S 107If the character is part of the group permissions and the file is not 108executable or the directory is not searchable by the group, and the 109set-group-id bit is set. 110.It T 111If the character is part of the other permissions and the file is not 112executable or the directory is not searchable by others, and the ``sticky'' 113.Pq Dv S_ISVTX 114bit is set. 115.It s 116If the character is part of the owner permissions and the file is 117executable or the directory searchable by the owner, and the set-user-id 118bit is set. 119.It s 120If the character is part of the group permissions and the file is 121executable or the directory searchable by the group, and the set-group-id 122bit is set. 123.It t 124If the character is part of the other permissions and the file is 125executable or the directory searchable by others, and the ``sticky'' 126.Pq Dv S_ISVTX 127bit is set. 128.It x 129The file is executable or the directory is searchable. 130.It \- 131None of the above apply. 132.El 133.Pp 134The last character is a plus sign ``+'' if there are any alternate 135or additional access control methods associated with the inode, otherwise 136it will be a space. 137.Sh RETURN VALUES 138The 139.Fn strmode 140function 141always returns 0. 142.Sh SEE ALSO 143.Xr chmod 1 , 144.Xr find 1 , 145.Xr stat 2 , 146.Xr getmode 3 , 147.Xr setmode 3 148.Sh HISTORY 149The 150.Fn strmode 151function first appeared in 152.Bx 4.4 . 153