Author: jonpryor
Date: 2006-01-15 13:26:17 -0500 (Sun, 15 Jan 2006)
New Revision: 55599
Modified:
trunk/monodoc/class/Mono.Posix/en/Mono.Unix/UnixGroupInfo.xml
trunk/monodoc/class/Mono.Posix/en/Mono.Unix/UnixUserInfo.xml
Log:
Flush.
Modified: trunk/monodoc/class/Mono.Posix/en/Mono.Unix/UnixGroupInfo.xml
===================================================================
--- trunk/monodoc/class/Mono.Posix/en/Mono.Unix/UnixGroupInfo.xml
2006-01-15 13:23:27 UTC (rev 55598)
+++ trunk/monodoc/class/Mono.Posix/en/Mono.Unix/UnixGroupInfo.xml
2006-01-15 18:26:17 UTC (rev 55599)
@@ -28,7 +28,7 @@
</summary>
<exception cref="T:System.ArgumentException">
The group name <paramref name="group" /> does not exist in the
- local password database.
+ local group database.
</exception>
<remarks>
This constructor looks up the specified group name in the local
Modified: trunk/monodoc/class/Mono.Posix/en/Mono.Unix/UnixUserInfo.xml
===================================================================
--- trunk/monodoc/class/Mono.Posix/en/Mono.Unix/UnixUserInfo.xml
2006-01-15 13:23:27 UTC (rev 55598)
+++ trunk/monodoc/class/Mono.Posix/en/Mono.Unix/UnixUserInfo.xml
2006-01-15 18:26:17 UTC (rev 55599)
@@ -17,28 +17,116 @@
<Parameter Name="user" Type="System.String" />
</Parameters>
<Docs>
- <param name="user">To be added.</param>
- <summary>To be added.</summary>
- <remarks>To be added.</remarks>
+ <param name="user">
+ A <see cref="T:System.String" /> containing the user to get
+ information about.
+ </param>
+ <summary>
+ Constructs and initializes a new instance of
+ <see cref="T:Mono.Unix.UnixUserInfo" /> by looking up the specified
+ user name in the local password database file.
+ </summary>
+ <exception cref="T:System.ArgumentException">
+ The user name <paramref name="user" /> does not exist in the lcoal
+ password database.
+ </exception>
+ <remarks>
+ <para>
+ This constructor looks up the specified user name in the local
+ password database.
+ </para>
+ </remarks>
+ <altmember cref="M:Mono.Unix.Native.Syscall.getpwnam_r" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public UnixUserInfo (uint user);"
/>
<MemberType>Constructor</MemberType>
+ <Attributes>
+ <Attribute>
+ <AttributeName>System.CLSCompliant(IsCompliant=False)</AttributeName>
+ </Attribute>
+ </Attributes>
<Parameters>
<Parameter Name="user" Type="System.UInt32" />
</Parameters>
<Docs>
- <param name="user">To be added.</param>
- <summary>To be added.</summary>
- <remarks>To be added.</remarks>
+ <param name="user">
+ A <see cref="T:System.UInt32" /> containing the user id to get
+ information about.
+ </param>
+ <summary>
+ Constructs and initializes a new instance of
+ <see cref="T:Mono.Unix.UnixUserInfo" /> by looking up the specified
+ user id in the local password database file.
+ </summary>
+ <exception cref="T:System.ArgumentException">
+ The user id <paramref name="user" /> does not exist in the lcoal
+ password database.
+ </exception>
+ <remarks>
+ <para>
+ This constructor looks up the specified user id in the local
+ password database.
+ </para>
+ </remarks>
+ <altmember cref="M:Mono.Unix.Native.Syscall.getpwuid_r" />
</Docs>
- <Attributes>
- <Attribute>
- <AttributeName>System.CLSCompliant(IsCompliant=False)</AttributeName>
- </Attribute>
- </Attributes>
</Member>
+ <Member MemberName=".ctor">
+ <MemberSignature Language="C#" Value="public UnixUserInfo (long user);"
/>
+ <MemberType>Constructor</MemberType>
+ <Parameters>
+ <Parameter Name="user" Type="System.Int64" />
+ </Parameters>
+ <Docs>
+ <param name="user">
+ A <see cref="T:System.Int64" /> containing the user id to get
+ information about.
+ </param>
+ <summary>
+ Constructs and initializes a new instance of
+ <see cref="T:Mono.Unix.UnixUserInfo" /> by looking up the specified
+ user id in the local password database file.
+ </summary>
+ <exception cref="T:System.ArgumentException">
+ The user id <paramref name="user" /> does not exist in the lcoal
+ password database.
+ </exception>
+ <remarks>
+ <para>
+ This constructor looks up the specified user id in the local
+ password database.
+ </para>
+ </remarks>
+ <altmember cref="M:Mono.Unix.Native.Syscall.getpwuid_r" />
+ </Docs>
+ </Member>
+ <Member MemberName=".ctor">
+ <MemberSignature Language="C#" Value="public UnixUserInfo
(Mono.Unix.Native.Passwd passwd);" />
+ <MemberType>Constructor</MemberType>
+ <Parameters>
+ <Parameter Name="passwd" Type="Mono.Unix.Native.Passwd" />
+ </Parameters>
+ <Docs>
+ <param name="passwd">
+ A <see cref="T:Mono.Unix.Native.Passwd" /> containing the user
+ to get information about.
+ </param>
+ <summary>
+ Constructs and initializes a new instance of
+ <see cref="T:Mono.Unix.UnixUserInfo" /> by using the specified
+ <see cref="T:Mono.Unix.Native.Passwd" /> entry.
+ </summary>
+ <remarks>
+ <para>
+ This constructor wraps <paramref name="passwd" />,
+ providing framework-compliant naming conventions over the native
+ <see cref="T:Mono.Unix.Native.Passwd" /> type.
+ </para>
+ </remarks>
+ </Docs>
+ </Member>
<Member MemberName="UserName">
<MemberSignature Language="C#" Value="public string UserName { get; };"
/>
<MemberType>Property</MemberType>
@@ -46,9 +134,17 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
+ <summary>Gets the user's login name.</summary>
+ <value>
+ A <see cref="T:System.String" /> containing the user's login name.
+ </value>
+ <remarks>
+ <para>
+ This is what the user logs in to the computer as, and is generally
+ limited to eight characters in length.
+ </para>
+ </remarks>
+ <altmember cref="F:Mono.Unix.Native.Passwd.pw_name" />
</Docs>
</Member>
<Member MemberName="Password">
@@ -58,9 +154,22 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
+ <summary>Gets the user's password.</summary>
+ <value>
+ A <see cref="T:System.String" /> containing the user's password.
+ </value>
+ <remarks>
+ <para>
+ In years past, this <i>used</i> to contain the user's password.
+ This was later found to be a security problem, as it made it
+ easier to crack the passwords of other users.
+ </para>
+ <para>
+ Currently, the actual user password is not stored in the password
+ database, so this property is of little actual use.
+ </para>
+ </remarks>
+ <altmember cref="F:Mono.Unix.Native.Passwd.pw_passwd" />
</Docs>
</Member>
<Member MemberName="UserId">
@@ -70,11 +179,35 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
+ <summary>Gets the user's id.</summary>
+ <value>
+ A <see cref="T:System.Int64" /> containing the user's id.
+ </value>
+ <remarks></remarks>
+ <altmember cref="F:Mono.Unix.Native.Passwd.pw_uid" />
</Docs>
</Member>
+ <Member MemberName="Group">
+ <MemberSignature Language="C#" Value="public Mono.Unix.UnixGroupInfo
Group { get; };" />
+ <MemberType>Property</MemberType>
+ <ReturnValue>
+ <ReturnType>Mono.Unix.UnixGroupInfo</ReturnType>
+ </ReturnValue>
+ <Docs>
+ <summary>Gets information about the user's group.</summary>
+ <value>
+ A <see cref="T:Mono.Unix.UnixGroupInfo" /> containing information
+ about the group the user belongs to.
+ </value>
+ <remarks>
+ <para>
+ This is equivalent to
+ <see cref="C:Mono.Unix.UnixGroupInfo"
+ />(<see cref="P:Mono.Unix.UnixUserInfo.GroupId" />).
+ </para>
+ </remarks>
+ </Docs>
+ </Member>
<Member MemberName="GroupId">
<MemberSignature Language="C#" Value="public long GroupId { get; };" />
<MemberType>Property</MemberType>
@@ -82,9 +215,32 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
+ <summary>Gets the user's group id.</summary>
+ <value>
+ A <see cref="T:System.Int64" /> containing the users's group id.
+ </value>
+ <remarks>
+ <para>
+ Access to file system objects
+ (as represented by <see cref="T:Mono.Unix.UnixFileSystemInfo"/>)
+ is controlled by the file system access permissions,
+ <see cref="P:Mono.Unix.UnixFileSystemInfo.FileAccessPermissions"
/>.
+ <see cref="T:Mono.Unix.FileAccessPermissions" /> is a nine-bit
field
+ specifying read, write, and execute access for the owner, group,
and
+ everyone else (other).
+ </para>
+ <para>
+ Access by the file's owner group is controlled by the bits
+ specified by <c>
+ (<see cref="P:Mono.Unix.UnixFileSystemInfo.FileAccessPermissions"
/>
+ &
+ <see
cref="F:Mono.Unix.FileAccessPermissions.GroupReadWriteExecute"
+ />)</c>.
+ All group members get these access permissions, except for the
file's
+ owner (if they belong to the file's owner group).
+ </para>
+ </remarks>
+ <altmember cref="F:Mono.Unix.Native.Passwd.pw_gid" />
</Docs>
</Member>
<Member MemberName="GroupName">
@@ -94,9 +250,18 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
+ <summary>Gets the users's group's name.</summary>
+ <value>
+ A <see cref="T:System.String" /> containing the group name that the
+ user belongs to.
+ </value>
+ <remarks>
+ <para>
+ This is equivalent to calling
+ <see cref="P:Mono.Unix.UnixUserInfo.Group"
+ />.<see cref="P:Mono.Unix.UnixGroupInfo.GroupName" />.
+ </para>
+ </remarks>
</Docs>
</Member>
<Member MemberName="RealName">
@@ -106,9 +271,14 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
+ <summary>Gets the user's real name.</summary>
+ <value>
+ A <see cref="T:System.String" /> containing the user's actual name,
+ complete with spaces, first name, last name, and anything else the
+ user wishes to provide.
+ </value>
+ <remarks></remarks>
+ <altmember cref="F:Mono.Unix.Native.Passwd.pw_gecos" />
</Docs>
</Member>
<Member MemberName="HomeDirectory">
@@ -118,9 +288,13 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
+ <summary>Gets the user's home directory.</summary>
+ <value>
+ A <see cref="T:System.String" /> containing the user's home
+ directory.
+ </value>
+ <remarks></remarks>
+ <altmember cref="F:Mono.Unix.Native.Passwd.pw_dir" />
</Docs>
</Member>
<Member MemberName="ShellProgram">
@@ -130,35 +304,15 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
+ <summary>Gets the user's login shell program.</summary>
+ <value>
+ A <see cref="T:System.String" /> containing the user's login shell
+ program.
+ </value>
+ <remarks></remarks>
+ <altmember cref="F:Mono.Unix.Native.Passwd.pw_shell" />
</Docs>
</Member>
- <Member MemberName=".ctor">
- <MemberSignature Language="C#" Value="public UnixUserInfo (long user);"
/>
- <MemberType>Constructor</MemberType>
- <Parameters>
- <Parameter Name="user" Type="System.Int64" />
- </Parameters>
- <Docs>
- <param name="user">To be added.</param>
- <summary>To be added.</summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName=".ctor">
- <MemberSignature Language="C#" Value="public UnixUserInfo
(Mono.Unix.Native.Passwd passwd);" />
- <MemberType>Constructor</MemberType>
- <Parameters>
- <Parameter Name="passwd" Type="Mono.Unix.Native.Passwd" />
- </Parameters>
- <Docs>
- <param name="passwd">To be added.</param>
- <summary>To be added.</summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
<Member MemberName="GetRealUser">
<MemberSignature Language="C#" Value="public static
Mono.Unix.UnixUserInfo GetRealUser ();" />
<MemberType>Method</MemberType>
@@ -167,9 +321,12 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
+ <summary>Get's information about the process' real user.</summary>
+ <returns>
+ A <see cref="T:Mono.Unix.UnixUserInfo" /> containing information
+ about the real user the process is executing as.
+ </returns>
+ <remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetRealUserId">
@@ -180,9 +337,13 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
+ <summary>Gets the real user id of the process.</summary>
+ <returns>
+ A <see cref="T:System.Int64" /> containing the real user id of the
+ process.
+ </returns>
+ <remarks></remarks>
+ <altmember cref="F:Mono.Unix.Native.Syscall.getuid" />
</Docs>
</Member>
<Member MemberName="GetLoginName">
@@ -193,9 +354,19 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
+ <summary>Gets the login name of the user executing this
process.</summary>
+ <returns>
+ A <see cref="T:System.String" /> containing the login name of the
+ user executing this process.
+ </returns>
+ <remarks>
+ <para>
+ It's generally more useful to use the <c>LOGNAME</c> environment
+ variable to find out who the user is, as this provides more
+ flexibility.
+ </para>
+ </remarks>
+ <altmember cref="M:Mono.Unix.Native.Syscall.getlogin_r" />
</Docs>
</Member>
<Member MemberName="GetLocalUsers">
@@ -206,23 +377,19 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
+ <summary>Gets all local users defined in the local password
database.</summary>
+ <exception cref="T:Mono.Unix.UnixIOException">
+ Insufficient memory to allocate the
+ <see cref="T:Mono.Unix.Native.Passwd" /> structure.
+ [<see cref="F:Mono.Unix.Native.Errno.ENOMEM" />]
+ </exception>
+ <returns>
+ A <see cref="T:Mono.Unix.UnixUserInfo" /> array containing
+ information about all users in the local password database.
+ </returns>
+ <remarks></remarks>
</Docs>
</Member>
- <Member MemberName="Group">
- <MemberSignature Language="C#" Value="public Mono.Unix.UnixGroupInfo
Group { get; };" />
- <MemberType>Property</MemberType>
- <ReturnValue>
- <ReturnType>Mono.Unix.UnixGroupInfo</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>To be added.</summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
<Member MemberName="ToPasswd">
<MemberSignature Language="C#" Value="public Mono.Unix.Native.Passwd
ToPasswd ();" />
<MemberType>Method</MemberType>
@@ -231,14 +398,49 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
+ <summary>
+ Converts this <see cref="T:Mono.Unix.UnixUserInfo" /> instance into
+ an equivalent <see cref="T:Mono.Unix.Native.Passwd" /> instance.
+ </summary>
+ <returns>
+ A <see cref="T:Mono.Unix.Native.Passwd" /> instance containingn the
+ same information as this instance.
+ </returns>
+ <remarks></remarks>
</Docs>
</Member>
</Members>
<Docs>
- <summary>To be added.</summary>
- <remarks>To be added.</remarks>
+ <summary>Provides information about a Unix user.</summary>
+ <remarks>
+ <para>
+ The <see cref="T:Mono.Unix.UnixUserInfo" /> type is a FxDG-compliant
+ wrapper over the <see cref="T:Mono.Unix.Native.Passwd" /> native type.
+ It represents a single entry from the local password database,
+ typically <c>/etc/passwd</c>.
+ </para>
+ <para>
+ Unix users are part of the file system access rules.
+ </para>
+ <para>
+ Access to file system objects
+ (as represented by <see cref="T:Mono.Unix.UnixFileSystemInfo"/>)
+ is controlled by the file system access permissions,
+ <see cref="P:Mono.Unix.UnixFileSystemInfo.FileAccessPermissions" />.
+ <see cref="T:Mono.Unix.FileAccessPermissions" /> is a nine-bit field
+ specifying read, write, and execute access for the owner, group, and
+ everyone else (other).
+ </para>
+ <para>
+ Access by the file's owner is controlled by the bits specified by
+ <c>
+ (<see cref="P:Mono.Unix.UnixFileSystemInfo.FileAccessPermissions" />
+ &
+ <see cref="F:Mono.Unix.FileAccessPermissions.UserReadWriteExecute"
+ />)</c>.
+ The owner permissions supersede group permissions and other
+ permissions, even if the owner belongs to the group.
+ </para>
+ </remarks>
</Docs>
</Type>
_______________________________________________
Mono-patches maillist - [email protected]
http://lists.ximian.com/mailman/listinfo/mono-patches
