diff options
author | Nathan Scott <nathans@sgi.com> | 2002-03-26 04:30:40 +0000 |
---|---|---|
committer | Nathan Scott <nathans@sgi.com> | 2002-03-26 04:30:40 +0000 |
commit | 5bf7c3b7fc817a461c1892cf7a9c437e7526ba54 (patch) | |
tree | 3c0e2fc515263702457a3c6dbeee0e151fac98ae /man/man3 | |
parent | b20b284b703b0dc7d0fa2c0110b933c4f01fde21 (diff) | |
download | attr-5bf7c3b7fc817a461c1892cf7a9c437e7526ba54.tar.gz |
bump release number for man page and mips syscall updates.
Diffstat (limited to 'man/man3')
-rw-r--r-- | man/man3/Makefile | 11 | ||||
-rw-r--r-- | man/man3/attr_get.3 | 46 | ||||
-rw-r--r-- | man/man3/attr_list.3 | 54 | ||||
-rw-r--r-- | man/man3/attr_multi.3 | 36 | ||||
-rw-r--r-- | man/man3/attr_remove.3 | 28 | ||||
-rw-r--r-- | man/man3/attr_set.3 | 40 |
6 files changed, 92 insertions, 123 deletions
diff --git a/man/man3/Makefile b/man/man3/Makefile index 32a0030..029c2c4 100644 --- a/man/man3/Makefile +++ b/man/man3/Makefile @@ -38,7 +38,6 @@ MAN_SECTION = 3 MAN_PAGES = $(shell echo *.$(MAN_SECTION)) MAN_DEST = $(PKG_MAN_DIR)/man$(MAN_SECTION) LSRCFILES = $(MAN_PAGES) -LDIRT = $(MAN_PAGES:%=%.ps) $(MAN_PAGES:%=%.html) default install : $(MAN_PAGES) @@ -48,13 +47,3 @@ install-dev : default $(INSTALL) -m 755 -d $(MAN_DEST) $(INSTALL_MAN) install-lib: - -html : $(MAN_PAGES:%=%.html) -ps : $(MAN_PAGES:%=%.ps) - -%.$(MAN_SECTION).ps : %.$(MAN_SECTION) - groff -man -T ps $< > $@ - -%.$(MAN_SECTION).html : %.$(MAN_SECTION) - groff -man -T html $< > $@ - diff --git a/man/man3/attr_get.3 b/man/man3/attr_get.3 index f573843..a6b8640 100644 --- a/man/man3/attr_get.3 +++ b/man/man3/attr_get.3 @@ -2,22 +2,21 @@ .SH NAME attr_get, attr_getf \- get the value of a user attribute of a filesystem object .SH C SYNOPSIS -.PP .sp .nf .B #include <attr/attributes.h> .sp -.B "int attr_get (const char **path, const char **attrname, " -.B " char **attrvalue, int **valuelength, int flags);" +.B "int attr_get (const char **\f2path\f3, const char **\f2attrname\f3, " +.B " char **\f2attrvalue\f3, int **\f2valuelength\f3, int \f2flags\f3);" .PP -.B "int attr_getf (int fd, const char **attrname, " -.B " char **attrvalue, int **valuelength, int flags);" +.B "int attr_getf (int \f2fd\f3, const char **\f2attrname\f3, " +.B " char **\f2attrvalue\f3, int **\f2valuelength\f3, int \f2flags\f3);" .Op .SH DESCRIPTION The -.I attr_get +.B attr_get and -.I attr_getf +.B attr_getf functions provide a way to retrieve the value of an attribute. .P .I Path\^ @@ -32,7 +31,7 @@ buffer. The .I valuelength argument is an input/output argument that on the call to -.I attr_get +.B attr_get should contain the maximum size of attribute value the process is willing to accept. On return, the @@ -59,11 +58,11 @@ address space. Do not follow symbolic links when resolving a .I path on an -.I attr_get +.B attr_get function call. The default is to follow symbolic links. .PP -.I attr_get +.B attr_get will fail if one or more of the following are true: .TP 17 .SM @@ -87,22 +86,17 @@ The named file does not exist. \%[EPERM] The effective user .SM ID -does not match the owner of the file -and the effective user +does not match the owner of the file and the effective user .SM ID is not super-user. .TP .SM \%[ENOTDIR] -A component of the -path prefix -is not a directory. +A component of the path prefix is not a directory. .TP .SM \%[EACCES] -Search permission is denied on a -component of the -path prefix. +Search permission is denied on a component of the path prefix. .TP .SM \%[EINVAL] @@ -134,7 +128,7 @@ or a pathname component is longer than .SM .RI { MAXNAMELEN }. .PP -.I attr_getf\^ +.B attr_getf\^ will fail if: .TP 15 .SM @@ -171,16 +165,14 @@ points outside the allocated address space of the process. \%[EBADF] .I Fd\^ does not refer to a valid descriptor. -.SH "SEE ALSO" -attr(1), -.br -attr_multi(3), attr_multif(3), -.br -attr_remove(3), attr_removef(3), -.br -attr_set(3), attr_setf(3), .SH "DIAGNOSTICS" Upon successful completion, a value of 0 is returned. Otherwise, a value of \-1 is returned and .I errno\^ is set to indicate the error. +.SH "SEE ALSO" +.BR attr (1), +.BR attr_multi (3), +.BR attr_remove (3), +and +.BR attr_set (3). diff --git a/man/man3/attr_list.3 b/man/man3/attr_list.3 index 4037d28..f22b63e 100644 --- a/man/man3/attr_list.3 +++ b/man/man3/attr_list.3 @@ -2,24 +2,23 @@ .SH NAME attr_list, attr_listf \- list the names of the user attributes of a filesystem object .SH C SYNOPSIS -.PP .sp .nf .B #include <attr/attributes.h> .sp -.B "int attr_list (const char **path, char **buffer, " -.B " const int buffersize, int flags," -.B " attrlist_cursor_t **cursor);" +.B "int attr_list (const char **\f2path\f3, char **\f2buffer\f3, " +.B " const int \f2buffersize\f3, int \f2flags\f3," +.B " attrlist_cursor_t **\f2cursor\f3);" .PP -.B "int attr_listf (int fd, char **buffer, " -.B " const int buffersize, int flags," -.B " attrlist_cursor_t **cursor);" +.B "int attr_listf (int \f2fd\f3, char **\f2buffer\f3, " +.B " const int \f2buffersize\f3, int \f2flags\f3," +.B " attrlist_cursor_t **\f2cursor\f3);" .Op .SH DESCRIPTION The -.I attr_list +.B attr_list and -.I attr_listf +.B attr_listf functions provide a way to list the existing attributes of a filesystem object. .P @@ -66,7 +65,7 @@ array. The .I al_more field will be non-zero if another -.I attr_list +.B attr_list call would result in more attributes. The .I al_offset @@ -108,10 +107,10 @@ The name is a NULL terminated string. .PP Note that the value of the attribute cannot be obtained through this interface, the -.I attr_get +.B attr_get call should be used to get the value. The -.I attr_list +.B attr_list interface tells the calling process how large of a buffer it must have in order to get the attribute\'s value. .PP @@ -133,7 +132,7 @@ address space. Do not follow symbolic links when resolving a .I path on an -.I attr_list +.B attr_list function call. The default is to follow symbolic links. .PP @@ -144,18 +143,18 @@ to track the calling process\'s position in the attribute list. The only valid operations on a .I cursor are to pass it into an -.I attr_list +.B attr_list function call or to zero it out. It should be zero\'ed out before the first -.I attr_list +.B attr_list call. Note that multi-threaded applications may keep more than one .I cursor in order to serve multiple contexts, ie: the -.I attr_list +.B attr_list call is "thread-safe". .PP -.I attr_list +.B attr_list will fail if one or more of the following are true: .TP 17 .SM @@ -222,7 +221,7 @@ or a pathname component is longer than .I attribute\^ does not exist for this file. .PP -.I attr_listf\^ +.B attr_listf\^ will fail if: .TP 15 .SM @@ -250,20 +249,15 @@ are not 32bit aligned. \%[EBADF] .I Fd\^ does not refer to a valid descriptor. -.SH "SEE ALSO" -attr(1), -.br -attrctl(2), -.br -attr_get(3), attr_getf(3), -.br -attr_multi(3), attr_multif(3) -.br -attr_remove(3), attr_removef(3), -.br -attr_set(3), attr_set(3) .SH "DIAGNOSTICS" Upon successful completion, a value of 0 is returned. Otherwise, a value of \-1 is returned and .I errno\^ is set to indicate the error. +.SH "SEE ALSO" +.BR attr (1), +.BR attr_get (3), +.BR attr_multi (3), +.BR attr_remove (3), +and +.BR attr_set (3). diff --git a/man/man3/attr_multi.3 b/man/man3/attr_multi.3 index aaab0b2..3379083 100644 --- a/man/man3/attr_multi.3 +++ b/man/man3/attr_multi.3 @@ -7,17 +7,17 @@ attr_multi, attr_multif \- manipulate multiple user attributes on a filesystem o .nf .B #include <attr/attributes.h> .sp -.B "int attr_multi (const char **path, attr_multiop_t **oplist, " -.B " int count, int flags);" +.B "int attr_multi (const char **\f2path\f3, attr_multiop_t **\f2oplist\f3, " +.B " int \f2count\f3, int \f2flags\f3);" .PP -.B "int attr_multif (int fd, attr_multiop_t **oplist, " -.B " int count, int flags);" +.B "int attr_multif (int \f2fd\f3, attr_multiop_t **\f2oplist\f3, " +.B " int \f2count\f3, int \f2flags\f3);" .Op .SH DESCRIPTION The -.I attr_multi +.B attr_multi and -.I attr_multif +.B attr_multif functions provide a way to operate on multiple attributes of a filesystem object at once. .P @@ -79,7 +79,7 @@ the result codes that are possible from the corresponding single-attribute function call. For example, the result code possible from an \f4ATTR_OP_GET\fP sub-operation are a subset of those that can be returned from an -.I attr_get +.B attr_get function call. .PP The @@ -166,7 +166,7 @@ otherwise the USER namespace will be searched. The .I flags argument to the -.I attr_multi +.B attr_multi call is used to control following of symbolic links in the .I path argument. @@ -174,7 +174,7 @@ The default is to follow symbolic links, .I flags should be set to ATTR_DONTFOLLOW to not follow symbolic links. .PP -.I attr_multi +.B attr_multi will fail if one or more of the following are true: .TP 17 .SM @@ -230,7 +230,7 @@ or a pathname component is longer than .SM .RI { MAXNAMELEN }. .PP -.I attr_multif +.B attr_multif will fail if: .TP 15 .SM @@ -250,17 +250,9 @@ points outside the allocated address space of the process. \%[EBADF] .I Fd\^ does not refer to a valid descriptor. -.SH "SEE ALSO" -attr(1), -.br -attr_get(3), attr_getf(3), -.br -attr_remove(3), attr_removef(3), -.br -attr_set(3), attr_set(3) .SH "DIAGNOSTICS" Upon successful completion of the -.I attr_multi +.B attr_multi call, a value of 0 is returned. Otherwise, a value of \-1 is returned and .I errno @@ -273,3 +265,9 @@ The variable only records the result of the .I attr_multi call itself, not the result of any of the sub-operations. +.SH "SEE ALSO" +.BR attr (1), +.BR attr_get (3), +.BR attr_remove (3), +and +.BR attr_set (3). diff --git a/man/man3/attr_remove.3 b/man/man3/attr_remove.3 index ccae1dd..b1ee328 100644 --- a/man/man3/attr_remove.3 +++ b/man/man3/attr_remove.3 @@ -7,15 +7,15 @@ attr_remove, attr_removef \- remove a user attribute of a filesystem object .nf .B #include <attr/attributes.h> .sp -.B "int attr_remove (const char **path, const char **attrname, int flags);" +.B "int attr_remove (const char **\f2path\f3, const char **\f2attrname\f3, int \f2flags\f3);" .PP -.B "int attr_removef (int fd, const char **attrname, int flags);" +.B "int attr_removef (int \f2fd\f3, const char **\f2attrname\f3, int \f2flags\f3);" .Op .SH DESCRIPTION The -.I attr_remove +.B attr_remove and -.I attr_removef +.B attr_removef functions provide a way to remove previously created attributes from filesystem objects. .P @@ -47,11 +47,11 @@ address space. Do not follow symbolic links when resolving a .I path on an -.I attr_remove +.B attr_remove function call. The default is to follow symbolic links. .PP -.I attr_remove +.B attr_remove will fail if one or more of the following are true: .TP 17 .SM @@ -110,7 +110,7 @@ or a pathname component is longer than .SM .RI { MAXNAMELEN }. .PP -.I attr_removef\^ +.B attr_removef\^ will fail if: .TP 15 .SM @@ -136,16 +136,14 @@ points outside the allocated address space of the process. \%[EBADF] .I Fd\^ does not refer to a valid descriptor. -.SH "SEE ALSO" -attr(1), -.br -attr_get(3), attr_getf(3), -.br -attr_multi(3), attr_multif(3), -.br -attr_set(3), attr_setf(3), .SH "DIAGNOSTICS" Upon successful completion, a value of 0 is returned. Otherwise, a value of \-1 is returned and .I errno\^ is set to indicate the error. +.SH "SEE ALSO" +.BR attr (1), +.BR attr_get (3), +.BR attr_multi (3), +and +.BR attr_set (3). diff --git a/man/man3/attr_set.3 b/man/man3/attr_set.3 index 567ba74..fbf8ad9 100644 --- a/man/man3/attr_set.3 +++ b/man/man3/attr_set.3 @@ -7,19 +7,19 @@ attr_set, attr_setf \- set the value of a user attribute of a filesystem object .nf .B #include <attr/attributes.h> .sp -.B "int attr_set (const char **path, const char **attrname, " -.B " const char **attrvalue, const int valuelength," -.B " int flags);" +.B "int attr_set (const char **\f2path\f3, const char **\f2attrname\f3, " +.B " const char **\f2attrvalue\f3, const int \f2valuelength\f3," +.B " int \f2flags\f3);" .PP -.B "int attr_setf (int fd, const char **attrname, " -.B " const char **attrvalue, const int valuelength," -.B " int flags);" +.B "int attr_setf (int \f2fd\f3, const char **\f2attrname\f3, " +.B " const char **\f2attrvalue\f3, const int \f2valuelength\f3," +.B " int \f2flags\f3);" .Op .SH DESCRIPTION The -.I attr_set +.B attr_set and -.I attr_setf +.B attr_setf functions provide a way to create attributes and set/change their values. .P .I Path\^ @@ -57,7 +57,7 @@ address space. Do not follow symbolic links when resolving a .I path on an -.I attr_set +.B attr_set function call. The default is to follow symbolic links. .TP @@ -68,7 +68,7 @@ already exists on the indicated filesystem object, otherwise create an attribute with the given name and value. This flag is used to implement a pure create operation, without this flag -.I attr_set +.B attr_set will create the attribute if it does not already exist. An error (EINVAL) will be returned if both ATTR_CREATE and ATTR_REPLACE are set in the same call. @@ -80,12 +80,12 @@ does not already exist on the indicated filesystem object, otherwise replace the existing attribute\'s value with the given value. This flag is used to implement a pure replacement operation, without this flag -.I attr_set +.B attr_set will create the attribute if it does not already exist. An error (EINVAL) will be returned if both ATTR_CREATE and ATTR_REPLACE are set in the same call. .PP -.I attr_set +.B attr_set will fail if one or more of the following are true: .TP 17 .SM @@ -158,7 +158,7 @@ or a pathname component is longer than .SM .RI { MAXNAMELEN }. .PP -.I attr_setf\^ +.B attr_setf\^ will fail if: .TP 15 .SM @@ -196,16 +196,14 @@ points outside the allocated address space of the process. \%[EBADF] .I Fd\^ does not refer to a valid descriptor. -.SH "SEE ALSO" -attr(1), -.br -attr_get(3), attr_getf(3), -.br -attr_multi(3), attr_multif(3), -.br -attr_remove(3), attr_removef(3), .SH "DIAGNOSTICS" Upon successful completion, a value of 0 is returned. Otherwise, a value of \-1 is returned and .I errno\^ is set to indicate the error. +.SH "SEE ALSO" +.BR attr (1), +.BR attr_get (3), +.BR attr_multi (3), +and +.BR attr_remove (3). |