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. 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.\" from: @(#)strmode.3 8.3 (Berkeley) 7/28/94 29.\" $NetBSD: strmode.3,v 1.16 2003/08/07 16:43:51 agc Exp $ 30.\" 31.Dd July 28, 1994 32.Dt STRMODE 3 33.Os 34.Sh NAME 35.Nm strmode 36.Nd convert inode status information into a symbolic string 37.Sh LIBRARY 38.Lb libc 39.Sh SYNOPSIS 40.In unistd.h 41.Ft void 42.Fn strmode "mode_t mode" "char *bp" 43.Sh DESCRIPTION 44The 45.Fn strmode 46function 47converts a file 48.Fa mode 49(the type and permission information associated with an inode, see 50.Xr stat 2 ) 51into a symbolic string which is stored in the location referenced by 52.Fa bp . 53This stored string is eleven characters in length plus a trailing 54.Dv NULL . 55.Pp 56The first character is the inode type, and will be one of the following: 57.Pp 58.Bl -tag -width flag -offset indent -compact 59.It \- 60regular file 61.It a 62regular file in archive state 1 63.It A 64regular file in archive state 2 65.It b 66block special 67.It c 68character special 69.It d 70directory 71.It l 72symbolic link 73.It p 74fifo 75.It s 76socket 77.It w 78whiteout 79.It ? 80unknown inode type 81.El 82.Pp 83The next nine characters encode three sets of permissions, in three 84characters each. 85The first three characters are the permissions for the owner of the 86file, the second three for the group the file belongs to, and the 87third for the ``other'', or default, set of users. 88.Pp 89Permission checking is done as specifically as possible. 90If read permission is denied to the owner of a file in the first set 91of permissions, the owner of the file will not be able to read the file. 92This is true even if the owner is in the file's group and the group 93permissions allow reading or the ``other'' permissions allow reading. 94.Pp 95If the first character of the three character set is an ``r'', the file is 96readable for that set of users; if a dash ``\-'', it is not readable. 97.Pp 98If the second character of the three character set is a ``w'', the file is 99writable for that set of users; if a dash ``\-'', it is not writable. 100.Pp 101The third character is the first of the following characters that apply: 102.Bl -tag -width xxxx 103.It S 104If the character is part of the owner permissions and the file is not 105executable or the directory is not searchable by the owner, and the 106set-user-id bit is set. 107.It S 108If the character is part of the group permissions and the file is not 109executable or the directory is not searchable by the group, and the 110set-group-id bit is set. 111.It T 112If the character is part of the other permissions and the file is not 113executable or the directory is not searchable by others, and the ``sticky'' 114.Pq Dv S_ISVTX 115bit is set. 116.It s 117If the character is part of the owner permissions and the file is 118executable or the directory searchable by the owner, and the set-user-id 119bit is set. 120.It s 121If the character is part of the group permissions and the file is 122executable or the directory searchable by the group, and the set-group-id 123bit is set. 124.It t 125If the character is part of the other permissions and the file is 126executable or the directory searchable by others, and the ``sticky'' 127.Pq Dv S_ISVTX 128bit is set. 129.It x 130The file is executable or the directory is searchable. 131.It \- 132None of the above apply. 133.El 134.Pp 135The last character is a plus sign ``+'' if there are any alternative 136or additional access control methods associated with the inode, otherwise 137it will be a space. 138.Pp 139Archive state 1 and archive state 2 represent file system dependent 140archive state for a file. 141Most file systems do not retain file archive 142state, and so will not report files in either archive state. 143msdosfs will report a file in archive state 1 if it has been 144archived more recently than modified. 145Hierarchical storage systems may have multiple archive states for a 146file and may define archive states 1 and 2 as appropriate. 147.Sh SEE ALSO 148.Xr chmod 1 , 149.Xr find 1 , 150.Xr stat 2 , 151.Xr getmode 3 , 152.Xr setmode 3 153.Sh HISTORY 154The 155.Fn strmode 156function first appeared in 157.Bx 4.4 . 158