d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ca46b5698e
freebsd-dev/lib/libc/gen/strtofflags.3

96 lines
3.0 KiB
Groff
Raw Normal View History

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 ;)
2000-01-27 21:17:01 +00:00
.\" 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.
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96
2017-02-28 23:42:47 +00:00
.\" 3. Neither the name of the University nor the names of its contributors
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 ;)
2000-01-27 21:17:01 +00:00
.\" 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
Return of the evil file flags! The {s|g}etflags functions were renamed to {s|g}etflagsbyname, which received objections. They're now called strtofflags (string to file flags) and fflagstostr (file flags to string). Suggested by: bde
2000-06-17 01:28:13 +00:00
.Dt STRTOFFLAGS 3
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 ;)
2000-01-27 21:17:01 +00:00
.Os
.Sh NAME
Return of the evil file flags! The {s|g}etflags functions were renamed to {s|g}etflagsbyname, which received objections. They're now called strtofflags (string to file flags) and fflagstostr (file flags to string). Suggested by: bde
2000-06-17 01:28:13 +00:00
.Nm fflagstostr ,
.Nm strtofflags
Modify strtofflags so that it returns a malloced string instead of a pointer to a static buffer.
2000-06-17 11:09:24 +00:00
.Nd convert between file flag bits and their string names
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following.
2000-04-21 09:42:15 +00:00
.Sh LIBRARY
.Lb libc
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 ;)
2000-01-27 21:17:01 +00:00
.Sh SYNOPSIS
mdoc(7) police: Use the new .In macro for #include statements.
2001-10-01 16:09:29 +00:00
.In unistd.h
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 ;)
2000-01-27 21:17:01 +00:00
.Ft char *
The "def" arg for fflagstostr is too specialized for ls. The caller can easily translate from "" to whatever it wants to print if no flags are set. (ls prints "-" and mtree prints "none".) Suggested by: bde
2000-06-17 01:43:56 +00:00
.Fn fflagstostr "u_long flags"
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 ;)
2000-01-27 21:17:01 +00:00
.Ft int
Return of the evil file flags! The {s|g}etflags functions were renamed to {s|g}etflagsbyname, which received objections. They're now called strtofflags (string to file flags) and fflagstostr (file flags to string). Suggested by: bde
2000-06-17 01:28:13 +00:00
.Fn strtofflags "char **stringp" "u_long *setp" "u_long *clrp"
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 ;)
2000-01-27 21:17:01 +00:00
.Sh DESCRIPTION
The
Return of the evil file flags! The {s|g}etflags functions were renamed to {s|g}etflagsbyname, which received objections. They're now called strtofflags (string to file flags) and fflagstostr (file flags to string). Suggested by: bde
2000-06-17 01:28:13 +00:00
.Fn fflagstostr
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 ;)
2000-01-27 21:17:01 +00:00
function returns a comma separated string of the file flags represented by
.Fa flags .
The "def" arg for fflagstostr is too specialized for ls. The caller can easily translate from "" to whatever it wants to print if no flags are set. (ls prints "-" and mtree prints "none".) Suggested by: bde
2000-06-17 01:43:56 +00:00
If no flags are set a zero length string is returned.
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 ;)
2000-01-27 21:17:01 +00:00
.Pp
Modify strtofflags so that it returns a malloced string instead of a pointer to a static buffer.
2000-06-17 11:09:24 +00:00
If memory cannot be allocated for the return value,
.Fn fflagstostr
returns
Whitespace only change: trim trailing whitespace.
2000-10-30 13:23:19 +00:00
.Dv NULL .
Modify strtofflags so that it returns a malloced string instead of a pointer to a static buffer.
2000-06-17 11:09:24 +00:00
.Pp
Whitespace only change: trim trailing whitespace.
2000-10-30 13:23:19 +00:00
The value returned from
Modify strtofflags so that it returns a malloced string instead of a pointer to a static buffer.
2000-06-17 11:09:24 +00:00
.Fn fflagstostr
Whitespace only change: trim trailing whitespace.
2000-10-30 13:23:19 +00:00
is obtained from
.Fn malloc
Modify strtofflags so that it returns a malloced string instead of a pointer to a static buffer.
2000-06-17 11:09:24 +00:00
and should be returned to the system with
Whitespace only change: trim trailing whitespace.
2000-10-30 13:23:19 +00:00
.Fn free
Modify strtofflags so that it returns a malloced string instead of a pointer to a static buffer.
2000-06-17 11:09:24 +00:00
when the program is done with it.
.Pp
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 ;)
2000-01-27 21:17:01 +00:00
The
Return of the evil file flags! The {s|g}etflags functions were renamed to {s|g}etflagsbyname, which received objections. They're now called strtofflags (string to file flags) and fflagstostr (file flags to string). Suggested by: bde
2000-06-17 01:28:13 +00:00
.Fn strtofflags
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 ;)
2000-01-27 21:17:01 +00:00
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
Return of the evil file flags! The {s|g}etflags functions were renamed to {s|g}etflagsbyname, which received objections. They're now called strtofflags (string to file flags) and fflagstostr (file flags to string). Suggested by: bde
2000-06-17 01:28:13 +00:00
.Fn strtofflags
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 ;)
2000-01-27 21:17:01 +00:00
returns 0, otherwise it returns non-zero and
.Fa stringp
is left pointing to the offending token.
Modify strtofflags so that it returns a malloced string instead of a pointer to a static buffer.
2000-06-17 11:09:24 +00:00
.Sh ERRORS
The
.Fn fflagstostr
function
may fail and set errno for any of the errors specified for the library
routine
.Xr malloc 3 .
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 ;)
2000-01-27 21:17:01 +00:00
.Sh SEE ALSO
.Xr chflags 1 ,
.Xr chflags 2 ,
Modify strtofflags so that it returns a malloced string instead of a pointer to a static buffer.
2000-06-17 11:09:24 +00:00
.Xr malloc 3
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 ;)
2000-01-27 21:17:01 +00:00
.Sh HISTORY
The
Return of the evil file flags! The {s|g}etflags functions were renamed to {s|g}etflagsbyname, which received objections. They're now called strtofflags (string to file flags) and fflagstostr (file flags to string). Suggested by: bde
2000-06-17 01:28:13 +00:00
.Fn fflagstostr
Modify strtofflags so that it returns a malloced string instead of a pointer to a static buffer.
2000-06-17 11:09:24 +00:00
and
.Fn strtofflags
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 ;)
2000-01-27 21:17:01 +00:00
functions first appeared in
.Fx 4.0 .
Reference in New Issue Copy Permalink