Menu
▾
▴
[Oorexx-svn] SF.net SVN: oorexx:[6942] docs/trunk/unixextensions
|
From: <wda...@us...> - 2011-04-27 16:11:21
|
Revision: 6942
http://oorexx.svn.sourceforge.net/oorexx/?rev=6942&view=rev
Author: wdashley
Date: 2011-04-27 16:11:14 +0000 (Wed, 27 Apr 2011)
Log Message:
-----------
Fix Returns header placement in all sections.
Modified Paths:
--------------
docs/trunk/unixextensions/files.xml
docs/trunk/unixextensions/misc.xml
docs/trunk/unixextensions/namelookup.xml
docs/trunk/unixextensions/process.xml
docs/trunk/unixextensions/usergrps.xml
docs/trunk/unixextensions/xattr.xml
Modified: docs/trunk/unixextensions/files.xml
===================================================================
--- docs/trunk/unixextensions/files.xml 2011-04-27 15:36:07 UTC (rev 6941)
+++ docs/trunk/unixextensions/files.xml 2011-04-27 16:11:14 UTC (rev 6942)
@@ -10,7 +10,6 @@
>>-SysAccess(file, mode)---------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Checks to see if the user has access permissions on a file.</para>
<para>This function uses the <filename>access()</filename>
C API to perform the action.</para>
@@ -23,6 +22,7 @@
<listitem><para>The access permissions to check on the file. Must be a decimal number.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success (all access rights available) or -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -42,7 +42,6 @@
>>-SysChmod(file, mode)----------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Sets the mode bits of a file.</para>
<para>This function uses the <filename>chmod()</filename>
C API to perform the action.</para>
@@ -59,6 +58,7 @@
This parameter must be a decimal number.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success (all access rights available) or -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -79,7 +79,6 @@
>>-SysChown(srcpath, uid, gid)---------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Change the user and group ownership attributes of a file.</para>
<para>This function uses the <filename>chown()</filename>
C API to perform the action.</para>
@@ -97,6 +96,7 @@
<listitem><para>The new numerical group id.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success and -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -116,7 +116,6 @@
>>-SysChroot(srcpath)------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Change the root directory of the current process.</para>
<para>This function uses the <filename>chroot()</filename>
C API to perform the action.</para>
@@ -126,6 +125,7 @@
<listitem><para>The new root subdirectory base path.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success and -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -145,7 +145,6 @@
>>-SysClose(fh)------------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Close the specified file handle.</para>
<para>This function uses the <filename>close()</filename>
C API to perform the action.</para>
@@ -155,6 +154,7 @@
<listitem><para>The file handle to be closed.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success and -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -174,7 +174,6 @@
>>-SysEuidaccess(file, mode)-----------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Checks to see if the effective user has access permissions on a file.</para>
<para>This function uses the <filename>euidaccess()</filename>
C API to perform the action.</para>
@@ -187,6 +186,7 @@
<listitem><para>The access permissions to check on the file. Must be a decimal number.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success (all access rights available) or -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -219,6 +219,7 @@
<listitem><para>The subdirectory to be listed.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns an ooRexx array.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -241,7 +242,6 @@
>>-SysLchown(srcpath, uid, gid)--------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Change the user and group ownership attributes of a symbolic link.</para>
<para>This function uses the <filename>lchown()</filename>
C API to perform the action.</para>
@@ -257,6 +257,7 @@
<listitem><para>The new numerical group id.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success and -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -276,7 +277,6 @@
>>-SysLink(srcpath, targetpath)--------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Create a symbolic (hard) link.</para>
<para>This function uses the <filename>link()</filename>
C API to perform the action.</para>
@@ -289,6 +289,7 @@
<listitem><para>The new path/filname that will become the hard link.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success and -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -308,7 +309,6 @@
>>-SysMkdir(dir, mode)-----------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Create a subdirectory.</para>
<para>This function uses the <filename>mkdir()</filename>
C API to perform the action.</para>
@@ -321,6 +321,7 @@
<listitem><para>The mode (decimal number) for the new subdirectory.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success and -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -340,7 +341,6 @@
>>-SysRmdir(dir)-----------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Remove a subdirectory.</para>
<para>This function uses the <filename>rmdir()</filename>
C API to perform the action.</para>
@@ -350,6 +350,7 @@
<listitem><para>The subdirectory to remove.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success and -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -369,7 +370,6 @@
>>-SysStat(file, option)---------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns information about a file.</para>
<para>This function uses the <filename>stat64()</filename>
C API to perform the action.</para>
@@ -420,6 +420,7 @@
</variablelist>
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns information specified by the <emphasis>option</emphasis>.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -443,7 +444,6 @@
>>-SysSymlink(srcpath, targetpath)-----------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Create a symbolic (soft) link.</para>
<para>This function uses the <filename>symlink()</filename>
C API to perform the action.</para>
@@ -456,6 +456,7 @@
<listitem><para>The new path/filname that will become the soft link.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success and -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -475,7 +476,6 @@
>>-SysUmask(umask)---------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Set the umask.</para>
<para>This function uses the <filename>umask()</filename>
C API to perform the action.</para>
@@ -485,6 +485,7 @@
<listitem><para>The new umask. This MUST be a decimal number (not octal).
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success or -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -505,7 +506,6 @@
+--option--+
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns system information.</para>
<para>This function uses the <filename>uname()</filename>
C API to perform the action.</para>
@@ -534,6 +534,7 @@
</variablelist>
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns information specified by the <emphasis>option</emphasis>.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -558,7 +559,6 @@
>>-SysUnLink(srcpath)------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Removes a hard link.</para>
<para>This function uses the <filename>unlink()</filename>
C API to perform the action.</para>
@@ -568,6 +568,7 @@
<listitem><para>The path/filename of the source file to be removed.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success and -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -587,7 +588,6 @@
>>-SysWordexp(exp)---------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Performs a shell-like expansion of the input expression and returns the result in an
array. This function will expand the characters "*", "?" and "~" (the tilde).
</para>
@@ -599,6 +599,7 @@
<listitem><para>The expression to expand.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns an array of the expanded results.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
Modified: docs/trunk/unixextensions/misc.xml
===================================================================
--- docs/trunk/unixextensions/misc.xml 2011-04-27 15:36:07 UTC (rev 6941)
+++ docs/trunk/unixextensions/misc.xml 2011-04-27 16:11:14 UTC (rev 6942)
@@ -10,7 +10,6 @@
>>-SysCrypt(str, salt)-----------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns an encrypted version of <emphasis>str</emphasis>.</para>
<para>This function uses the <filename>crypt()</filename>
C API to perform the action.</para>
@@ -23,6 +22,7 @@
<listitem><para>The two character encryption salt.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the encrypted string or a zero-length string on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -42,12 +42,12 @@
>>-SysGetsid()-------------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Gets the current session id.</para>
<para>This function uses the <filename>getsid()</filename>
C API to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the current sid or -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -67,10 +67,10 @@
>>-SysGeterrno()-----------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the errno numeric value.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the numeric errno value.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -90,7 +90,6 @@
>>-SysGeterrnomsg(errno)---------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns a short description of the errno value.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<variablelist>
@@ -98,6 +97,7 @@
<listitem><para>The numeric errno value.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns a short description of the errno value.
If the message is not available it returns the strimg "Unknown".</para>
<para><emphasis role="bold">Example:</emphasis></para>
@@ -118,12 +118,12 @@
>>-SysGetsizeofptr()-------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Gets the size (in bits) of a pointer.</para>
<para>This function uses the <filename>sizeof(void *)</filename>
C macro to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns 32 or 64 in most cases.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -143,12 +143,12 @@
>>-SysSetsid()-------------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Set the session id.</para>
<para>This function uses the <filename>setsid()</filename>
C API to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None.</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the new sid or -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -168,7 +168,6 @@
>>-SysSignal(signum, option)-----------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Sets the disposition of a signal to either SIG_IGN (ignore) or SIG_DFL (default).</para>
<note><title>Note</title><para>You should be VERY carefull when calling this function as it can
cause problems with the Rexx interpreter. If you don't know what you are doing then you
@@ -228,6 +227,7 @@
</variablelist>
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns previous signal value. This is meaningless to the Rexx programmer.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -245,13 +245,5 @@
</section>
-
-
-
-
-
-
-
-
</chapter>
Modified: docs/trunk/unixextensions/namelookup.xml
===================================================================
--- docs/trunk/unixextensions/namelookup.xml 2011-04-27 15:36:07 UTC (rev 6941)
+++ docs/trunk/unixextensions/namelookup.xml 2011-04-27 16:11:14 UTC (rev 6942)
@@ -12,12 +12,13 @@
>>-SysGethostname()--------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the hostname of the machine.</para>
<para>This function uses the <filename>gethostname()</filename>
C API to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None.</para>
+<para><emphasis role="bold">Returns</emphasis></para>
+<para>Returns the hostname of the machine.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
<![CDATA[
@@ -36,7 +37,6 @@
>>-SysGetservbyname(name, proto, option)-----------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns information about a service.</para>
<para>This function uses the <filename>getservbyname()</filename>
C API to perform the action.</para>
@@ -65,6 +65,7 @@
</variablelist>
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns information specified by the <emphasis>option</emphasis>.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -85,7 +86,6 @@
>>-SysGetservbyport(port, proto, option)-----------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns information about a service.</para>
<para>This function uses the <filename>getservbyport()</filename>
C API to perform the action.</para>
@@ -114,6 +114,7 @@
</variablelist>
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns information specified by the <emphasis>option</emphasis>.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -134,13 +135,13 @@
>>-SysGettzname1()---------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the time zone name.</para>
<para>This function uses the <filename>time.h</filename>
C header file to obtain the time zone name and is sensitive
to the environment variable TZ.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None.</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the time zone name.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -158,13 +159,13 @@
>>-SysGettzname2()---------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the daylight savings time zone name.</para>
<para>This function uses the <filename>time.h</filename>
C header file to obtain the time zone name and is sensitive
to the environment variable TZ.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None.</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the daylight savings time zone name.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
Modified: docs/trunk/unixextensions/process.xml
===================================================================
--- docs/trunk/unixextensions/process.xml 2011-04-27 15:36:07 UTC (rev 6941)
+++ docs/trunk/unixextensions/process.xml 2011-04-27 16:11:14 UTC (rev 6942)
@@ -9,12 +9,12 @@
>>-SysGetpid()-------------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Gets the current process id.</para>
<para>This function uses the <filename>getpid()</filename>
C API to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the current numerical process id.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -34,12 +34,12 @@
>>-SysGetppid()------------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Gets the parent process id of the current process.</para>
<para>This function uses the <filename>getppid()</filename>
C API to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the current parent process id.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -59,12 +59,12 @@
>>-SysGettid()-------------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Gets the current thread id.</para>
<para>This function uses the <filename>pthread_self()</filename>
C API to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the current numerical thread id.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -84,7 +84,6 @@
>>-SysKill(pid, sig)-------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Kill the specified process using the specified signal.</para>
<para>This function uses the <filename>kill()</filename>
C API to perform the action.</para>
@@ -97,6 +96,7 @@
<listitem><para>The signal to use (usually 0).
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the return code from the C kill() API.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -109,15 +109,5 @@
</section>
-
-
-
-
-
-
-
-
-
-
</chapter>
Modified: docs/trunk/unixextensions/usergrps.xml
===================================================================
--- docs/trunk/unixextensions/usergrps.xml 2011-04-27 15:36:07 UTC (rev 6941)
+++ docs/trunk/unixextensions/usergrps.xml 2011-04-27 16:11:14 UTC (rev 6942)
@@ -9,12 +9,12 @@
>>-SysGetegid()------------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Gets the current numerical effective group id.</para>
<para>This function uses the <filename>getegid()</filename>
C API to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the current numerical effective group id.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -34,12 +34,12 @@
>>-SysGeteuid()------------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Gets the current numerical effective user id.</para>
<para>This function uses the <filename>geteuid()</filename>
C API to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the current numerical effective user id.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -59,12 +59,12 @@
>>-SysGetgid()-------------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Gets the current numerical group id.</para>
<para>This function uses the <filename>getgid()</filename>
C API to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the current numerical group id.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -84,8 +84,6 @@
>>-SysGetgrgid(gid, option)------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
-<para>Returns information about a group.</para>
<para>This function uses the <filename>getgrgid()</filename>
C API to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
@@ -113,6 +111,8 @@
</variablelist>
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
+<para>Returns information about a group.</para>
<para>Returns information specified by the <emphasis>option</emphasis>.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -135,7 +135,6 @@
>>-SysGetgrnam(grpname, option)--------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns information about a group.</para>
<para>This function uses the <filename>getgrnam()</filename>
C API to perform the action.</para>
@@ -164,6 +163,7 @@
</variablelist>
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns information specified by the <emphasis>option</emphasis>.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -186,12 +186,12 @@
>>-SysGetpgrp()------------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Gets the current numerical process group id.</para>
<para>This function uses the <filename>getpgrp()</filename>
C API to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the current numerical process group id.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -211,7 +211,6 @@
>>-SysGetpwnam(username, option)-------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns information about a user.</para>
<para>This function uses the <filename>getpwnam()</filename>
C API to perform the action.</para>
@@ -249,6 +248,7 @@
</variablelist>
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns information specified by the <emphasis>option</emphasis>.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -274,7 +274,6 @@
>>-SysGetpwuid(uid, option)------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns information about a user.</para>
<para>This function uses the <filename>getpwuid()</filename>
C API to perform the action.</para>
@@ -312,6 +311,7 @@
</variablelist>
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns information specified by the <emphasis>option</emphasis>.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -337,12 +337,12 @@
>>-SysGetuid()-------------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Gets the current numerical user id.</para>
<para>This function uses the <filename>getuid()</filename>
C API to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the current numerical user id.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -362,7 +362,6 @@
>>-SysSetegid(gid)---------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Set the numerical effective group id.</para>
<para>This function uses the <filename>setegid()</filename>
C API to perform the action.</para>
@@ -372,6 +371,7 @@
<listitem><para>The new numerical effective group id.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success or -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -391,7 +391,6 @@
>>-SysSetuid(euid)---------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Set the numerical effective user id.</para>
<para>This function uses the <filename>seteuid()</filename>
C API to perform the action.</para>
@@ -401,6 +400,7 @@
<listitem><para>The new numerical effective user id.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success or -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -420,7 +420,6 @@
>>-SysSetgid(gid)----------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Set the numerical group id.</para>
<para>This function uses the <filename>setgid()</filename>
C API to perform the action.</para>
@@ -430,6 +429,7 @@
<listitem><para>The new numerical group id.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success or -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -449,7 +449,6 @@
>>-SysSetpgid(pid, pgid)---------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Set a numerical process id to use the specified process group id.</para>
<para>This function uses the <filename>setpgid()</filename>
C API to perform the action.</para>
@@ -462,6 +461,7 @@
<listitem><para>The new process group id.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success and -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -481,12 +481,12 @@
>>-SysSetpgrp()------------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Sets the current numerical process usr id to zero and the group id to zero.</para>
<para>This function uses the <filename>setpgrp()</filename>
C API to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None</para>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success and -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -506,7 +506,6 @@
>>-SysSetuid(uid)----------------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Set the numerical user id.</para>
<para>This function uses the <filename>setuid()</filename>
C API to perform the action.</para>
@@ -516,6 +515,7 @@
<listitem><para>The new numerical user id.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns zero on success or -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
Modified: docs/trunk/unixextensions/xattr.xml
===================================================================
--- docs/trunk/unixextensions/xattr.xml 2011-04-27 15:36:07 UTC (rev 6941)
+++ docs/trunk/unixextensions/xattr.xml 2011-04-27 16:11:14 UTC (rev 6942)
@@ -12,7 +12,6 @@
>>-SysGetxattr(fname, xname)-----------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Gets an extended attribute from the specified file.</para>
<para>This function uses the <filename>getxattr()</filename>
C API to perform the action.</para>
@@ -25,6 +24,7 @@
<listitem><para>The extended attribute name.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the extended attribute value on success or a zero-length string on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -44,7 +44,6 @@
>>-SysListxattr(fname)-----------------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns an array of the extended attribut names from the specified file.</para>
<para>This function uses the <filename>listxattr()</filename>
C API to perform the action.</para>
@@ -54,6 +53,7 @@
<listitem><para>The file name.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns an array of the extended attribute names on success. The array will be empty on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -76,7 +76,6 @@
>>-SysRemovexattr(fname, xname)--------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Removes an extended attribute from the specified file.</para>
<para>This function uses the <filename>removexattr()</filename>
C API to perform the action.</para>
@@ -89,6 +88,7 @@
<listitem><para>The extended attribute name.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns 0 on success or -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
@@ -108,7 +108,6 @@
>>-SysSetxattr(fname, xname, val)------------------------------><
]]>
</programlisting>
-<para><emphasis role="bold">Returns</emphasis></para>
<para>Sets/replaces an extended attribute on the specified file.</para>
<para>This function uses the <filename>removexattr()</filename>
C API to perform the action.</para>
@@ -124,6 +123,7 @@
<listitem><para>The value to be set for the extended attribute.
</para></listitem></varlistentry>
</variablelist>
+<para><emphasis role="bold">Returns</emphasis></para>
<para>Returns the 0 on success or -1 on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|