projects / unix-history / blobdiff
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
BSD 4_3_Net_2 release
[unix-history] / usr / src / lib / libc / string / strmode.3
diff --git a/usr/src/lib/libc/string/strmode.3 b/usr/src/lib/libc/string/strmode.3
index f6fb5fb..2132571 100644 (file)
--- a/usr/src/lib/libc/string/strmode.3
+++ b/usr/src/lib/libc/string/strmode.3
@@ -1,146 +1,148 @@
-.\" Copyright (c) 1990 The Regents of the University of California.
+.\" Copyright (c) 1990, 1991 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"
-.\" Redistribution and use in source and binary forms are permitted
-.\" provided that: (1) source distributions retain this entire copyright
-.\" notice and comment, and (2) distributions including binaries display
-.\" the following acknowledgement:  ``This product includes software
-.\" developed by the University of California, Berkeley and its contributors''
-.\" in the documentation or other materials provided with the distribution
-.\" and in all advertising materials mentioning features or use of this
-.\" software. Neither the name of the University nor the names of its
-.\" contributors may be used to endorse or promote products derived
-.\" from this software without specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
-.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
 .\"
 .\"
-.\"    @(#)strmode.3   5.1 (Berkeley) 5/10/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
 .\"
 .\"
-.TH STRMODE 3 "May 10, 1990"
-.UC 7
-.SH NAME
-strmode \- convert inode status information into a symbolic string
-.SH SYNOPSIS
-.nf
-.ft B
-#include <string.h>
-
-void
-strmode(mode_t mode, char *bp);
-.ft R
-.fi
-.SH DESCRIPTION
-.I Strmode
+.\"     @(#)strmode.3  5.4 (Berkeley) 7/31/91
+.\"
+.Dd July 31, 1991
+.Dt STRMODE 3
+.Os
+.Sh NAME
+.Nm strmode
+.Nd convert inode status information into a symbolic string
+.Sh SYNOPSIS
+.Fd #include <string.h>
+.Ft void
+.Fn strmode "mode_t mode" "char *bp"
+.Sh DESCRIPTION
+The
+.Fn strmode
+function
 converts a file
 converts a file
-.I mode
+.Fa mode
 (the type and permission information associated with an inode, see
 (the type and permission information associated with an inode, see
-.IR stat (2))
+.Xr stat 2 )
 into a symbolic string which is stored in the location referenced by
 into a symbolic string which is stored in the location referenced by
-.IR bp .
-This stored string is eleven characters in length plus a trailing NULL.
-.PP
+.Fa bp .
+This stored string is eleven characters in length plus a trailing
+.Dv NULL .
+.Pp
 The first character is the inode type, and will be one of the following:
 The first character is the inode type, and will be one of the following:
-.TP
-\-
+.Pp
+.Bl -tag -width flag -offset indent -compact
+.It \-
 regular file
 regular file
-.br
-.ns
-.TP
-b
+.It b
 block special
 block special
-.br
-.ns
-.TP
-c
+.It c
 character special
 character special
-.br
-.ns
-.TP
-d
+.It d
 directory
 directory
-.br
-.ns
-.TP
-l
+.It l
 symbolic link
 symbolic link
-.br
-.ns
-.TP
-p
+.It p
 fifo
 fifo
-.br
-.ns
-.TP
-s
+.It s
 socket
 socket
-.br
-.ns
-.TP
-?
+.It ?
 unknown inode type
 unknown inode type
-.PP
+.El
+.Pp
 The next nine characters encode three sets of permissions, in three
 characters each.
 The first three characters are the permissions for the owner of the
 file, the second three for the group the file belongs to, and the
 third for the ``other'', or default, set of users.
 The next nine characters encode three sets of permissions, in three
 characters each.
 The first three characters are the permissions for the owner of the
 file, the second three for the group the file belongs to, and the
 third for the ``other'', or default, set of users.
-.PP
+.Pp
 Permission checking is done as specifically as possible.
 If read permission is denied to the owner of a file in the first set
 of permssions, the owner of the file will not be able to read the file.
 This is true even if the owner is in the file's group and the group
 permissions allow reading or the ``other'' permissions allow reading.
 Permission checking is done as specifically as possible.
 If read permission is denied to the owner of a file in the first set
 of permssions, the owner of the file will not be able to read the file.
 This is true even if the owner is in the file's group and the group
 permissions allow reading or the ``other'' permissions allow reading.
-.PP
+.Pp
 If the first character of the three character set is an ``r'', the file is
 readable for that set of users; if a dash ``\-'', it is not readable.
 If the first character of the three character set is an ``r'', the file is
 readable for that set of users; if a dash ``\-'', it is not readable.
-.PP
+.Pp
 If the second character of the three character set is a ``w'', the file is
 writable for that set of users; if a dash ``\-'', it is not writable.
 If the second character of the three character set is a ``w'', the file is
 writable for that set of users; if a dash ``\-'', it is not writable.
-.PP
+.Pp
 The third character is the first of the following characters that apply:
 The third character is the first of the following characters that apply:
-.TP
-S
+.Bl -tag -width xxxx
+.It S
 If the character is part of the owner permissions and the file is not
 executable or the directory is not searchable, by the owner, and the
 set-user-id bit is set.
 If the character is part of the owner permissions and the file is not
 executable or the directory is not searchable, by the owner, and the
 set-user-id bit is set.
-.TP
-S
+.It S
 If the character is part of the group permissions and the file is not
 executable or the directory is not searchable, by the group, and the
 set-group-id bit is set.
 If the character is part of the group permissions and the file is not
 executable or the directory is not searchable, by the group, and the
 set-group-id bit is set.
-.TP
-T
+.It T
 If the character is part of the other permissions and the file is not
 executable or the directory is not searchable, by others, and the ``sticky''
 If the character is part of the other permissions and the file is not
 executable or the directory is not searchable, by others, and the ``sticky''
-(S_ISVTX) bit is set.
-.TP
-s
+.Pq Dv S_ISVTX
+bit is set.
+.It s
 If the character is part of the owner permissions and the file is
 executable or the directory searchable, by the owner, and the set-user-id
 bit is set.
 If the character is part of the owner permissions and the file is
 executable or the directory searchable, by the owner, and the set-user-id
 bit is set.
-.TP
-s
+.It s
 If the character is part of the group permissions and the file is
 executable or the directory searchable, by the group, and the set-group-id
 bit is set.
 If the character is part of the group permissions and the file is
 executable or the directory searchable, by the group, and the set-group-id
 bit is set.
-.TP
-t
+.It t
 If the character is part of the other permissions and the file is
 executable or the directory searchable, by others, and the ``sticky''
 If the character is part of the other permissions and the file is
 executable or the directory searchable, by others, and the ``sticky''
-(S_ISVTX) bit is set.
-.TP
-x
+.Pq Dv S_ISVTX
+bit is set.
+.It x
 The file is executable or the directory is searchable.
 The file is executable or the directory is searchable.
-.TP
-\-
+.It \-
 None of the above apply.
 None of the above apply.
-.PP
+.El
+.Pp
 The last character is a plus sign ``+'' if any there are any alternate
 or additional access control methods associated with the inode, otherwise
 it will be a space.
 The last character is a plus sign ``+'' if any there are any alternate
 or additional access control methods associated with the inode, otherwise
 it will be a space.
-.SH RETURN VALUE
-.I Strmode
+.Sh RETURN VALUES
+The
+.Fn strmode
+function
 always returns 0.
 always returns 0.
-.SH SEE ALSO
-chmod(1), find(1), stat(2), getmode(3), setmode(3)
+.Sh SEE ALSO
+.Xr chmod 1 ,
+.Xr find 1 ,
+.Xr stat 2 ,
+.Xr getmode 3 ,
+.Xr setmode 3
+.Sh HISTORY
+The
+.Fn strmode
+function
+.Ud .
Continuous source code history from original PDP-7 UNIX to FreeBSD 2, the first fully unencumbered FreeBSD release.