diff options
author | joe <joe@FreeBSD.org> | 2000-01-27 21:17:01 +0000 |
---|---|---|
committer | joe <joe@FreeBSD.org> | 2000-01-27 21:17:01 +0000 |
commit | f1a9497df5db81a71987fa20f10c831030987e36 (patch) | |
tree | bcca8d67d721cd7e4ca8e7322d19df89912cfd26 /lib/libc/gen/strtofflags.3 | |
parent | 30f3b614b3b18d86be7ff164b9aba2617637b9c6 (diff) | |
download | FreeBSD-src-f1a9497df5db81a71987fa20f10c831030987e36.zip FreeBSD-src-f1a9497df5db81a71987fa20f10c831030987e36.tar.gz |
Historically file flags (schg, uschg, etc) have been converted from
string to u_long and back using two functions, flags_to_string and
string_to_flags, which co-existed with 'ls'. As time has progressed
more and more other tools have used these private functions to
manipulate the file flags.
Recently I moved these functions from /usr/src/bin/ls to libutil,
but after some discussion with bde it's been decided that they
really ought to go in libc.
There are two already existing libc functions for manipulating file
modes: setmode and getmode. In keeping with these flags_to_string
has been renamed getflags and string_to_flags to setflags.
The manual page could probably be improved upon ;)
Diffstat (limited to 'lib/libc/gen/strtofflags.3')
-rw-r--r-- | lib/libc/gen/strtofflags.3 | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/lib/libc/gen/strtofflags.3 b/lib/libc/gen/strtofflags.3 new file mode 100644 index 0000000..09c6208 --- /dev/null +++ b/lib/libc/gen/strtofflags.3 @@ -0,0 +1,78 @@ +.\" Copyright (c) 1989, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" 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. +.\" +.\" 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. +.\" +.\" @(#)setmode.3 8.2 (Berkeley) 4/28/95 +.\" $FreeBSD$ +.\" +.Dd January 1, 2000 +.Dt SETFLAGS 3 +.Os +.Sh NAME +.Nm getflags , +.Nm setflags +.Nd modify file flag bits +.Sh SYNOPSIS +.Fd #include <unistd.h> +.Ft char * +.Fn getflags "u_long flags" "char *def" +.Ft int +.Fn setflags "char **stringp" "u_long *setp" "u_long *clrp" +.Sh DESCRIPTION +The +.Fn getflags +function returns a comma separated string of the file flags represented by +.Fa flags . +If no flags are set the string +.Fa def +is returned instead. +.Pp +The +.Fn setflags +function takes a string of file flags, as described in +.Xr chflags 1 , +parses it, and returns the 'set' flags and 'clear' flags +such as would be given as arguments to +.Xr chflags 2 . +On success +.Fn setflags +returns 0, otherwise it returns non-zero and +.Fa stringp +is left pointing to the offending token. +.Sh SEE ALSO +.Xr chflags 1 , +.Xr chflags 2 , +.Sh HISTORY +The +.Fn getflags +and +.Fn setflags +functions first appeared in +.Fx 4.0 . |