diff options
| author | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2012-12-07 07:08:06 +0000 |
|---|---|---|
| committer | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2012-12-07 07:08:06 +0000 |
| commit | a756aa75ea9a8cd21264864d3cb81b7f13e43a8c (patch) | |
| tree | b121270a863192537cb50b4c10be979103dc4fce /doc | |
| parent | 8b2a4e68c38c50b0a5d658ea101d9933dfd3de53 (diff) | |
* doc/etc.rd: Removed stale documentation file
* ext/etc/etc.c: Merged documentation from doc/etc.rd and updated
rdoc, added documentation for Etc::Passwd and Etc::Group
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38258 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/etc.rd | 75 |
1 files changed, 0 insertions, 75 deletions
diff --git a/doc/etc.rd b/doc/etc.rd deleted file mode 100644 index b69f9884ad..0000000000 --- a/doc/etc.rd +++ /dev/null @@ -1,75 +0,0 @@ -# etc.rd - -*- mode: rd; coding: us-ascii -*- created at: Fri Jul 14 00:47:15 JST 1995 -=begin - -= Etc(Module) - -The module to retrieve information from running OS. All operations -defined in this module are module functions, so that you can include -Etc module into your class. - -== Module Function - ---- getlogin - - returns login name of the user. It this fails, try getpwuid(). - ---- getpwnam(name) - - searches in /etc/passwd file (or equivalent database), and - returns password entry for the user. The return value is an - passwd structure, which has members described below. - - struct passwd - name # user name(string) - passwd # encrypted password(string) - uid # user ID(integer) - gid # group ID(integer) - gecos # gecos field(string) - dir # home directory(string) - shell # login shell(string) - # members below are optional - change # password change time(integer) - quota # quota value(integer) - age # password age(integer) - class # user access class(string) - comment # comment(string) - expire # account expiration time(integer) - end - - See getpwnam(3) for detail. - ---- getpwuid([uid]) - - returns passwd entry for the specified user id. If uid is - ommitted, use the value from getuid(). See getpwuid(3) for - detail. - ---- getgrgid(gid) - - searches in /etc/group file (or equivalent database), and - returns group entry for the group id. The return value is an - group structure, which has members described below. - - struct group - name # group name(string) - passwd # group password(string) - gid # group ID(integer) - mem # array of the group member names - end - - See getgrgid(3) for detail. - ---- getgrnam(name) - - returns the group entry for the specified name. The return - value is the group structure. See getgrnam(3) for detail. - ---- group - - iterates over all group entries. - ---- passwd - - iterates over all passwd entries. - -=end |