rbs 4.0.0.dev.4 → 4.1.0.pre.2

data/stdlib/etc/0/etc.rbs

@@ -1,15 +1,16 @@
 # <!-- rdoc-file=ext/etc/etc.c -->
 # The Etc module provides access to information typically stored in files in the
-# `/etc` directory on Unix systems.
+# <code>/etc</code> directory on Unix systems.
 #
 # The information accessible consists of the information found in the
-# `/etc/passwd` and `/etc/group` files, plus information about the system's
-# temporary directory (`/tmp`) and configuration directory (`/etc`).
+# <code>/etc/passwd</code> and <code>/etc/group</code> files, plus information
+# about the system's temporary directory (<code>/tmp</code>) and configuration
+# directory (<code>/etc</code>).
 #
 # The Etc module provides a more reliable way to access information about the
 # logged in user than environment variables such as +$USER+.
 #
-# **Example:**
+# <strong>Example:</strong>
 #
 #     require 'etc'
 #
@@ -48,7 +49,7 @@ module Etc
   #   rdoc-file=ext/etc/etc.c
   #   - endgrent
   # -->
-  # Ends the process of scanning through the `/etc/group` file begun by
+  # Ends the process of scanning through the <code>/etc/group</code> file begun by
   # ::getgrent, and closes the file.
   #
   def self?.endgrent: () -> void
@@ -57,8 +58,8 @@ module Etc
   #   rdoc-file=ext/etc/etc.c
   #   - endpwent
   # -->
-  # Ends the process of scanning through the `/etc/passwd` file begun with
-  # ::getpwent, and closes the file.
+  # Ends the process of scanning through the <code>/etc/passwd</code> file begun
+  # with ::getpwent, and closes the file.
   #
   def self?.endpwent: () -> void
 
@@ -66,7 +67,7 @@ module Etc
   #   rdoc-file=ext/etc/etc.c
   #   - getgrent     ->  Etc::Group
   # -->
-  # Returns an entry from the `/etc/group` file.
+  # Returns an entry from the <code>/etc/group</code> file.
   #
   # The first time it is called it opens the file and returns the first entry;
   # each successive call returns the next entry, or `nil` if the end of the file
@@ -83,13 +84,13 @@ module Etc
   #   - getgrgid(group_id)  ->       Etc::Group
   # -->
   # Returns information about the group with specified integer `group_id`, as
-  # found in `/etc/group`.
+  # found in <code>/etc/group</code>.
   #
   # The information is returned as a Group struct.
   #
-  # See the unix manpage for `getgrgid(3)` for more detail.
+  # See the unix manpage for <code>getgrgid(3)</code> for more detail.
   #
-  # **Example:**
+  # <strong>Example:</strong>
   #
   #     Etc.getgrgid(100)
   #     #=> #<struct Etc::Group name="users", passwd="x", gid=100, mem=["meta", "root"]>
@@ -101,13 +102,13 @@ module Etc
   #   - getgrnam(name)       ->  Etc::Group
   # -->
   # Returns information about the group with specified `name`, as found in
-  # `/etc/group`.
+  # <code>/etc/group</code>.
   #
   # The information is returned as a Group struct.
   #
-  # See the unix manpage for `getgrnam(3)` for more detail.
+  # See the unix manpage for <code>getgrnam(3)</code> for more detail.
   #
-  # **Example:**
+  # <strong>Example:</strong>
   #
   #     Etc.getgrnam('users')
   #     #=> #<struct Etc::Group name="users", passwd="x", gid=100, mem=["meta", "root"]>
@@ -125,7 +126,7 @@ module Etc
   #
   # If ::getlogin fails, try ::getpwuid.
   #
-  # See the unix manpage for `getpwuid(3)` for more detail.
+  # See the unix manpage for <code>getpwuid(3)</code> for more detail.
   #
   # e.g.
   #     Etc.getlogin -> 'guest'
@@ -136,7 +137,7 @@ module Etc
   #   rdoc-file=ext/etc/etc.c
   #   - getpwent     ->  Etc::Passwd
   # -->
-  # Returns an entry from the `/etc/passwd` file.
+  # Returns an entry from the <code>/etc/passwd</code> file.
   #
   # The first time it is called it opens the file and returns the first entry;
   # each successive call returns the next entry, or `nil` if the end of the file
@@ -152,14 +153,14 @@ module Etc
   #   rdoc-file=ext/etc/etc.c
   #   - getpwnam(name)       ->  Etc::Passwd
   # -->
-  # Returns the `/etc/passwd` information for the user with specified login
-  # `name`.
+  # Returns the <code>/etc/passwd</code> information for the user with specified
+  # login `name`.
   #
   # The information is returned as a Passwd struct.
   #
-  # See the unix manpage for `getpwnam(3)` for more detail.
+  # See the unix manpage for <code>getpwnam(3)</code> for more detail.
   #
-  # **Example:**
+  # <strong>Example:</strong>
   #
   #     Etc.getpwnam('root')
   #     #=> #<struct Etc::Passwd name="root", passwd="x", uid=0, gid=0, gecos="root",dir="/root", shell="/bin/bash">
@@ -170,16 +171,17 @@ module Etc
   #   rdoc-file=ext/etc/etc.c
   #   - getpwuid(uid)        ->  Etc::Passwd
   # -->
-  # Returns the `/etc/passwd` information for the user with the given integer
-  # `uid`.
+  # Returns the <code>/etc/passwd</code> information for the user with the given
+  # integer `uid`.
   #
   # The information is returned as a Passwd struct.
   #
-  # If `uid` is omitted, the value from `Passwd[:uid]` is returned instead.
+  # If `uid` is omitted, the value from <code>Passwd[:uid]</code> is returned
+  # instead.
   #
-  # See the unix manpage for `getpwuid(3)` for more detail.
+  # See the unix manpage for <code>getpwuid(3)</code> for more detail.
   #
-  # **Example:**
+  # <strong>Example:</strong>
   #
   #     Etc.getpwuid(0)
   #     #=> #<struct Etc::Passwd name="root", passwd="x", uid=0, gid=0, gecos="root",dir="/root", shell="/bin/bash">
@@ -192,13 +194,13 @@ module Etc
   #   - group                                ->  Etc::Group
   # -->
   # Provides a convenient Ruby iterator which executes a block for each entry in
-  # the `/etc/group` file.
+  # the <code>/etc/group</code> file.
   #
   # The code block is passed an Group struct.
   #
   # See ::getgrent above for details.
   #
-  # **Example:**
+  # <strong>Example:</strong>
   #
   #     require 'etc'
   #
@@ -223,7 +225,7 @@ module Etc
   # *   sysconf(_SC_NPROCESSORS_ONLN): GNU/Linux, NetBSD, FreeBSD, OpenBSD,
   #     DragonFly BSD, OpenIndiana, Mac OS X, AIX
   #
-  # **Example:**
+  # <strong>Example:</strong>
   #
   #     require 'etc'
   #     p Etc.nprocessors #=> 4
@@ -232,7 +234,7 @@ module Etc
   # process is bound to specific cpus. This is intended for getting better
   # parallel processing.
   #
-  # **Example:** (Linux)
+  # <strong>Example:</strong> (Linux)
   #
   #     linux$ taskset 0x3 ./ruby -retc -e "p Etc.nprocessors"  #=> 2
   #
@@ -244,13 +246,13 @@ module Etc
   #   - passwd                               ->  Etc::Passwd
   # -->
   # Provides a convenient Ruby iterator which executes a block for each entry in
-  # the `/etc/passwd` file.
+  # the <code>/etc/passwd</code> file.
   #
   # The code block is passed an Passwd struct.
   #
   # See ::getpwent above for details.
   #
-  # **Example:**
+  # <strong>Example:</strong>
   #
   #     require 'etc'
   #
@@ -265,8 +267,8 @@ module Etc
   #   rdoc-file=ext/etc/etc.c
   #   - setgrent
   # -->
-  # Resets the process of reading the `/etc/group` file, so that the next call to
-  # ::getgrent will return the first entry again.
+  # Resets the process of reading the <code>/etc/group</code> file, so that the
+  # next call to ::getgrent will return the first entry again.
   #
   def self?.setgrent: () -> void
 
@@ -274,8 +276,8 @@ module Etc
   #   rdoc-file=ext/etc/etc.c
   #   - setpwent
   # -->
-  # Resets the process of reading the `/etc/passwd` file, so that the next call to
-  # ::getpwent will return the first entry again.
+  # Resets the process of reading the <code>/etc/passwd</code> file, so that the
+  # next call to ::getpwent will return the first entry again.
   #
   def self?.setpwent: () -> void
 
@@ -293,7 +295,7 @@ module Etc
   #     Etc.sysconf(Etc::SC_ARG_MAX) #=> 2097152
   #     Etc.sysconf(Etc::SC_LOGIN_NAME_MAX) #=> 256
   #
-  def self?.sysconf: (::Integer p1) -> ::Integer
+  def self?.sysconf: (::Integer p1) -> ::Integer?
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
@@ -301,9 +303,10 @@ module Etc
   # -->
   # Returns system configuration directory.
   #
-  # This is typically `"/etc"`, but is modified by the prefix used when Ruby was
-  # compiled. For example, if Ruby is built and installed in `/usr/local`, returns
-  # `"/usr/local/etc"` on other platforms than Windows.
+  # This is typically <code>"/etc"</code>, but is modified by the prefix used when
+  # Ruby was compiled. For example, if Ruby is built and installed in
+  # <code>/usr/local</code>, returns <code>"/usr/local/etc"</code> on other
+  # platforms than Windows.
   #
   # On Windows, this always returns the directory provided by the system.
   #
@@ -315,7 +318,7 @@ module Etc
   # -->
   # Returns system temporary directory; typically "/tmp".
   #
-  def self?.systmpdir: () -> ::String
+  def self?.systmpdir: () -> ::String?
 
   # <!--
   #   rdoc-file=ext/etc/etc.c
@@ -326,7 +329,7 @@ module Etc
   # The return value is a hash which has 5 keys at least:
   #     :sysname, :nodename, :release, :version, :machine
   #
-  # **Example:**
+  # <strong>Example:</strong>
   #
   #     require 'etc'
   #     require 'pp'
@@ -666,10 +669,10 @@ module Etc
   # :   contains the name of the group as a String.
   #
   # passwd
-  # :   contains the encrypted password as a String. An `'x'` is returned if
-  #     password access to the group is not available; an empty string is returned
-  #     if no password is needed to obtain membership of the group. This is
-  #     system-dependent.
+  # :   contains the encrypted password as a String. An <code>'x'</code> is
+  #     returned if password access to the group is not available; an empty string
+  #     is returned if no password is needed to obtain membership of the group.
+  #     This is system-dependent.
   #
   # gid
   # :   contains the group's numeric ID as an integer.
@@ -688,13 +691,14 @@ module Etc
     #   - Etc::Group.each { |group| block }   ->       Etc::Group
     #   - Etc::Group.each                          ->     Enumerator
     # -->
-    # Iterates for each entry in the `/etc/group` file if a block is given.
+    # Iterates for each entry in the <code>/etc/group</code> file if a block is
+    # given.
     #
     # If no block is given, returns the Enumerator.
     #
     # The code block is passed a Group struct.
     #
-    # **Example:**
+    # <strong>Example:</strong>
     #
     #     require 'etc'
     #
@@ -705,7 +709,8 @@ module Etc
     #     Etc::Group.collect {|g| g.name}
     #     Etc::Group.select {|g| !g.mem.empty?}
     #
-    def self.each: () -> untyped
+    def self.each: () { (::Etc::Group) -> void } -> singleton(::Etc::Group)
+                 | () -> ::Enumerator[::Etc::Group]
 
     def self.inspect: () -> untyped
 
@@ -741,9 +746,9 @@ module Etc
   # :   contains the short login name of the user as a String.
   #
   # passwd
-  # :   contains the encrypted password of the user as a String. an `'x'` is
-  #     returned if shadow passwords are in use. An `'*'` is returned if the user
-  #     cannot log in using a password.
+  # :   contains the encrypted password of the user as a String. an
+  #     <code>'x'</code> is returned if shadow passwords are in use. An
+  #     <code>'*'</code> is returned if the user cannot log in using a password.
   #
   # uid
   # :   contains the integer user ID (uid) of the user.
@@ -793,7 +798,8 @@ module Etc
     #   - Etc::Passwd.each { |struct| block }  ->  Etc::Passwd
     #   - Etc::Passwd.each                     ->  Enumerator
     # -->
-    # Iterates for each entry in the `/etc/passwd` file if a block is given.
+    # Iterates for each entry in the <code>/etc/passwd</code> file if a block is
+    # given.
     #
     # If no block is given, returns the Enumerator.
     #
@@ -801,7 +807,7 @@ module Etc
     #
     # See Etc.getpwent above for details.
     #
-    # **Example:**
+    # <strong>Example:</strong>
     #
     #     require 'etc'
     #
@@ -812,7 +818,8 @@ module Etc
     #     Etc::Passwd.collect {|u| u.gecos}
     #     Etc::Passwd.collect {|u| u.gecos}
     #
-    def self.each: () -> untyped
+    def self.each: () { (::Etc::Passwd) -> void } -> singleton(::Etc::Passwd)
+                 | () -> ::Enumerator[::Etc::Passwd]
 
     def self.inspect: () -> untyped
 
@@ -822,10 +829,18 @@ module Etc
 
     def self.new: (*untyped) -> untyped
 
+    def age: () -> Integer
+
+    def age=: (Integer new_age) -> void
+
     def change: () -> Integer
 
     def change=: (Integer new_change) -> void
 
+    def comment: () -> String
+
+    def comment=: (String new_comment) -> void
+
     def dir: () -> String
 
     def dir=: (String new_dir) -> void
@@ -850,6 +865,10 @@ module Etc
 
     def passwd=: (String new_passwd) -> void
 
+    def quota: () -> Integer
+
+    def quota=: (Integer new_quota) -> void
+
     def shell: () -> String
 
     def shell=: (String new_shell) -> void