Menu
▾
▴
[Oorexx-svn] SF.net SVN: oorexx:[6143] incubator/nixclib/docs
|
From: <wda...@us...> - 2010-09-03 14:11:12
|
Revision: 6143
http://oorexx.svn.sourceforge.net/oorexx/?rev=6143&view=rev
Author: wdashley
Date: 2010-09-03 14:11:05 +0000 (Fri, 03 Sep 2010)
Log Message:
-----------
Clean up some minor docs problems.
Modified Paths:
--------------
incubator/nixclib/docs/files.xml
incubator/nixclib/docs/misc.xml
incubator/nixclib/docs/namelookup.xml
incubator/nixclib/docs/usergrps.xml
Modified: incubator/nixclib/docs/files.xml
===================================================================
--- incubator/nixclib/docs/files.xml 2010-09-03 04:09:35 UTC (rev 6142)
+++ incubator/nixclib/docs/files.xml 2010-09-03 14:11:05 UTC (rev 6143)
@@ -20,7 +20,7 @@
<listitem><para>The path/file name to check access permissions.
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="italic">mode</emphasis></term>
-<listitem><para>The access permissions to check on the file. Must be a decilam number.
+<listitem><para>The access permissions to check on the file. Must be a decimal number.
</para></listitem></varlistentry>
</variablelist>
<para>Returns zero on success (all access rights available) or -1 on an error.</para>
@@ -46,6 +46,8 @@
<para>Sets the mode bits of a file.</para>
<para>This function uses the <filename>chmod()</filename>
C API to perform the action.</para>
+<para>You must be the owner of the file or root in order for this function
+to be successful.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<variablelist>
<varlistentry><term><emphasis role="italic">file</emphasis></term>
@@ -54,6 +56,7 @@
<varlistentry><term><emphasis role="italic">mode</emphasis></term>
<listitem><para>The new and complete list of bits. Note that it is not
possible to unset bits with this function except through this argument.
+This parameter must be a decimal number.
</para></listitem></varlistentry>
</variablelist>
<para>Returns zero on success (all access rights available) or -1 on an error.</para>
@@ -80,6 +83,8 @@
<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>
+<para>You must be the owner of the file or root in order for this function
+to be successful.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<variablelist>
<varlistentry><term><emphasis role="italic">srcpath</emphasis></term>
@@ -118,7 +123,7 @@
<para><emphasis role="bold">Parameter:</emphasis></para>
<variablelist>
<varlistentry><term><emphasis role="italic">srcpath</emphasis></term>
-<listitem><para>The path/filename of the source file to change.
+<listitem><para>The new root subdirectory base path.
</para></listitem></varlistentry>
</variablelist>
<para>Returns zero on success and -1 on an error.</para>
@@ -150,7 +155,7 @@
<listitem><para>The path/file name to check access permissions.
</para></listitem></varlistentry>
<varlistentry><term><emphasis role="italic">mode</emphasis></term>
-<listitem><para>The access permissions to check on the file. Must be a decilam number.
+<listitem><para>The access permissions to check on the file. Must be a decimal number.
</para></listitem></varlistentry>
</variablelist>
<para>Returns zero on success (all access rights available) or -1 on an error.</para>
Modified: incubator/nixclib/docs/misc.xml
===================================================================
--- incubator/nixclib/docs/misc.xml 2010-09-03 04:09:35 UTC (rev 6142)
+++ incubator/nixclib/docs/misc.xml 2010-09-03 14:11:05 UTC (rev 6143)
@@ -23,7 +23,7 @@
<listitem><para>The two character encryption salt.
</para></listitem></varlistentry>
</variablelist>
-<para>Returns the current sid or -1 on an error.</para>
+<para>Returns the encrypted string or a zero-length string on an error.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
<![CDATA[
@@ -94,11 +94,12 @@
<para>Returns a short description of the errno value.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<variablelist>
-<varlistentry><term><emphasis role="italic">sid</emphasis></term>
+<varlistentry><term><emphasis role="italic">errno</emphasis></term>
<listitem><para>The numeric errno value.
</para></listitem></varlistentry>
</variablelist>
-<para>Returns a short description of the errno value.</para>
+<para>Returns a short description of the errno value.
+If the message is not available it returns the strimg "Unknown".</section>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
<![CDATA[
@@ -123,7 +124,7 @@
C macro to perform the action.</para>
<para><emphasis role="bold">Parameter:</emphasis></para>
<para>None</para>para>
-<para>Returns 32 o 64 in most cases.</para>
+<para>Returns 32 or 64 in most cases.</para>
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
<![CDATA[
@@ -183,7 +184,7 @@
<variablelist>
<varlistentry><term><emphasis role="italic">signum</emphasis></term>
<listitem><para>The signal number to change. This is an integer and cooresponds to the
-setof system signal numbers. The following is a list of valid values:
+set of system signal numbers. The following is a partial list of valid values:
<programlisting>
SIGHUP 1 Hangup (POSIX)
SIGINT 2 Terminal interrupt (ANSI)
@@ -217,7 +218,7 @@
SIGPWR 30 Power failure restart (System V)
</programlisting>
</para></listitem></varlistentry>
-<varlistentry><term><emphasis role="italic">opt</emphasis></term>
+<varlistentry><term><emphasis role="italic">option</emphasis></term>
<listitem><para>An option specifying the signal action.
The values are all case insensitive and only the first letter of the option value is checked.
Allowed values are:
Modified: incubator/nixclib/docs/namelookup.xml
===================================================================
--- incubator/nixclib/docs/namelookup.xml 2010-09-03 04:09:35 UTC (rev 6142)
+++ incubator/nixclib/docs/namelookup.xml 2010-09-03 14:11:05 UTC (rev 6143)
@@ -21,7 +21,7 @@
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
<![CDATA[
-/* the following examples came from a Linux laptop running Fedora 12 */
+/* the following example comes from a Linux laptop running Fedora */
SysGethostname() --> "wda.holmes4.com"
]]>
@@ -59,7 +59,7 @@
<varlistentry><term>"PORT"</term>
<listitem><para>The service port number.
</para></listitem></varlistentry>
-<varlistentry><term>"Aliases"</term>
+<varlistentry><term>"ALIASES"</term>
<listitem><para>The services alias names are returned in an array.
</para></listitem></varlistentry>
</variablelist>
@@ -69,7 +69,7 @@
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
<![CDATA[
-/* the following examples came from a Linux laptop running Fedora 12 */
+/* the following examples came from a Linux laptop running Fedora */
SysGetservbyname("HTTP", "TCP", "n") --> HTTP
SysGetservbyname("HTTP", "TCP", "p") --> 80
@@ -108,7 +108,7 @@
<varlistentry><term>"PORT"</term>
<listitem><para>The service port number.
</para></listitem></varlistentry>
-<varlistentry><term>"Aliases"</term>
+<varlistentry><term>"ALAISES"</term>
<listitem><para>The services alias names are returned in an array.
</para></listitem></varlistentry>
</variablelist>
@@ -118,7 +118,7 @@
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
<![CDATA[
-/* the following examples came from a Linux laptop running Fedora 12 */
+/* the following examples came from a Linux laptop running Fedora */
SysGetservbyport(80, "TCP", "n") --> HTTP
SysGetservbyport(80, "TCP", "p") --> 80
Modified: incubator/nixclib/docs/usergrps.xml
===================================================================
--- incubator/nixclib/docs/usergrps.xml 2010-09-03 04:09:35 UTC (rev 6142)
+++ incubator/nixclib/docs/usergrps.xml 2010-09-03 14:11:05 UTC (rev 6143)
@@ -117,7 +117,7 @@
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
<![CDATA[
-/* the following examples came from a Linux laptop running Fedora 12 */
+/* the following examples came from a Linux laptop running Fedora */
SysGetpwgid(100, "n") --> users
SysGetpwgid(100, "g") --> 100
@@ -168,7 +168,7 @@
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
<![CDATA[
-/* the following examples came from a Linux laptop running Fedora 12 */
+/* the following examples came from a Linux laptop running Fedora */
SysGetpwgrp("users", "n") --> users
SysGetpwgrp("users", "g") --> 100
@@ -253,7 +253,7 @@
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
<![CDATA[
-/* the following examples came from a Linux laptop running Fedora 12 */
+/* the following examples came from a Linux laptop running Fedora */
SysGetpwnam("dashley", "n") --> dashley
SysGetpwnam("dashley", "u") --> 500
@@ -316,7 +316,7 @@
<para><emphasis role="bold">Example:</emphasis></para>
<programlisting>
<![CDATA[
-/* the following examples came from a Linux laptop running Fedora 12 */
+/* the following examples came from a Linux laptop running Fedora */
SysGetpwuid(500, "n") --> dashley
SysGetpwuid(500, "u") --> 500
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|