linux_stat 0.4.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62a54b165b53e0fe6fddad20ab6b39b8a0d57e1a02186f995fcf0341cc69aae0
-  data.tar.gz: 8bc58cc3c8b72e117892cd8f987c924337d2ab10995d14b3fb7735064e4b3685
+  metadata.gz: 05ad75bfd711c7ac7960645e2609416e868f2b425cbac94b503198db8b011aa4
+  data.tar.gz: f6291a5aaa6903839d7915c8e8494d88cf165dd6e82143ff0fc71dcea19628d8
 SHA512:
-  metadata.gz: a5490c31315132793840e3e849996f0545b08b3b416eadef3ba6979dcbad89d31329b69dad403295f8cc7e17a677f6d8df032c42706162b251b6ed921a3d11e4
-  data.tar.gz: 0100faa162b904042e8143b8dec85b45a3cb82543c693514049df17834890b12034cb1561d8c69ba606e9ebc81fba1550b255ad6d17d70a552011eb9aaf5300f
+  metadata.gz: f4406f12e2035652f26f9eb518bb4386e644622938d506880cc3f2899937e060b594d6067a8b4a4b66c85db24f068b13a70e59cbac4f9770cc937569e506da26
+  data.tar.gz: b0bbb6cd4570228bafaa2fe89d2bc6a75e67803334e907bcf6e3c3a3fb70f1333ac98da133484b37d8fe279d991ffd18cad617fa931f77c9c7150798cc2d580a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sourav Goswami
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -13,12 +13,12 @@ It only works for Linux, and detecting the OS is upto the user of this gem.
 + You need to have the C compile to be able to compile the C extension.
 On Arch Linux:
 ```
-# pacman -S gcc
+# pacman -S gcc make
 ```
 
 On Debian based systems:
 ```
-# apt install gcc
+# apt install gcc build-essential
 ```
 
 + You might also require ruby-dev in Debian based systems which provides support for ruby.h header file:
@@ -103,7 +103,7 @@ LinuxStat::CPU.count
 => 4
 
 LinuxStat::CPU.cur_freq
-=> [1999998, 2000003, 2000015, 2000009]
+=> [2000063, 2000108, 2000332, 2000028]
 
 LinuxStat::CPU.max_freq
 => [2000000, 2000000, 2000000, 2000000]
@@ -112,48 +112,48 @@ LinuxStat::CPU.model
 => "Intel(R) Core(TM) i3-6006U CPU @ 2.00GHz"
 
 LinuxStat::CPU.stat
-=> {0=>14.29, 1=>25.0, 2=>0.0, 3=>25.0, 4=>14.29}
+=> {0=>0.0, 1=>0.0, 2=>0.0, 3=>0.0, 4=>0.0}
 
 LinuxStat::CPU.total_usage
-=> 18.75
+=> 0.0
 
 LinuxStat::CPU.usage
-=> 14.29
+=> 20.0
 
 LinuxStat::CPU.usages
-=> {0=>16.67, 1=>14.29, 2=>28.57, 3=>0.0, 4=>25.0}
+=> {0=>20.0, 1=>0.0, 2=>0.0, 3=>50.0, 4=>100.0}
 
 ```
 
 ### LinuxStat::Filesystem
 ```
 LinuxStat::Filesystem.available
-=> 42144575488
+=> 33120964608
 
 LinuxStat::Filesystem.free
-=> 42144575488
+=> 33120964608
 
 LinuxStat::Filesystem.stat
-=> {:total=>119981191168, :free=>42144575488, :used=>77836615680}
+=> {:total=>119981191168, :free=>33120964608, :used=>86860226560}
 
 LinuxStat::Filesystem.stat_raw
-=> {:block_size=>4096, :fragment_size=>4096, :blocks=>29292283, :block_free=>10289203, :block_avail_unpriv=>10289203, :inodes=>58612160, :free_inodes=>56716465, :filesystem_id=>2050, :mount_flags=>1024, :max_filename_length=>255}
+=> {:block_size=>4096, :fragment_size=>4096, :blocks=>29292283, :block_free=>8086173, :block_avail_unpriv=>8086173, :inodes=>58612160, :free_inodes=>56567338, :filesystem_id=>2050, :mount_flags=>1024, :max_filename_length=>255}
 
 LinuxStat::Filesystem.total
 => 119981191168
 
 LinuxStat::Filesystem.used
-=> 77836615680
+=> 86860226560
 
 ```
 
 ### LinuxStat::Kernel
 ```
 LinuxStat::Kernel.build_date
-=> 2020-10-21 01:11:20 +0000
+=> 2020-11-20 07:44:55 +0000
 
 LinuxStat::Kernel.build_date_string
-=> "21 Oct 2020 01:11:20 +0000"
+=> "20 Nov 2020 07:44:55 +0000"
 
 LinuxStat::Kernel.build_user
 => "souravgoswami@archlinux"
@@ -168,45 +168,60 @@ LinuxStat::Kernel.compiler_version
 => "10.2.0"
 
 LinuxStat::Kernel.release
-=> "5.9.1-xanmod1-1"
+=> "5.9.9-xanmod1-1"
 
 LinuxStat::Kernel.string
-=> "Linux version 5.9.1-xanmod1-1 (souravgoswami@archlinux) (gcc (GCC) 10.2.0, GNU ld (GNU Binutils) 2.35.1) #1 SMP PREEMPT Wed, 21 Oct 2020 01:11:20 +0000"
+=> "Linux version 5.9.9-xanmod1-1 (souravgoswami@archlinux) (gcc (GCC) 10.2.0, GNU ld (GNU Binutils) 2.35.1) #1 SMP PREEMPT Fri, 20 Nov 2020 07:44:55 +0000"
 
 LinuxStat::Kernel.ticks
 => 100
 
 LinuxStat::Kernel.version
-=> "5.9.1-xanmod1-1"
+=> "5.9.9-xanmod1-1"
 
 ```
 
 ### LinuxStat::Memory
 ```
 LinuxStat::Memory.available
-=> 606548
+=> 579264
 
 LinuxStat::Memory.percent_available
-=> 15.81
+=> 15.1
 
 LinuxStat::Memory.percent_used
-=> 84.19
+=> 84.9
 
 LinuxStat::Memory.stat
-=> {:total=>3836256, :used=>3229708, :available=>606548, :percent_used=>84.19, :percent_available=>15.81}
+=> {:total=>3836236, :used=>3256972, :available=>579264, :percent_used=>84.9, :percent_available=>15.1}
 
 LinuxStat::Memory.total
-=> 3836256
+=> 3836236
 
 LinuxStat::Memory.used
-=> 3229708
+=> 3256972
 
 ```
 
 ### LinuxStat::Mounts
 ```
+LinuxStat::Mounts.device_stat
+=> {:mountpoint=>"/", :total=>119981191168, :free=>33120964608, :available=>33120964608, :used=>86860226560, :percent_used=>72.39, :percent_free=>27.61, :percent_available=>27.61}
+
+LinuxStat::Mounts.devices_stat
+=> {"proc"=>{:mountpoint=>"/proc", :total=>0, :free=>0, :available=>0, :used=>0, :percent_used=>NaN, :percent_free=>NaN, :percent_available=>NaN}, "sys"=>{:mountpoint=>"/sys", :total=>0, :free=>0, :available=>0, :used=>0, :percent_used=>NaN, :percent_fre...
+
 LinuxStat::Mounts.list
-=> ["proc /proc proc rw,nosuid,nodev,noexec,relatime 0 0", "sys /sys sysfs rw,nosuid,nodev,noexec,relatime 0 0", "dev /dev devtmpfs rw,nosuid,relatime,size=1891804k,nr_inodes=472951,mode=755 0 0", "run /run tmpfs rw,nosuid,nodev,relatime,mode=755 0 0", "...
+=> ["proc /proc proc rw,nosuid,nodev,noexec,relatime 0 0", "sys /sys sysfs rw,nosuid,nodev,noexec,relatime 0 0", "dev /dev devtmpfs rw,nosuid,relatime,size=1892908k,nr_inodes=473227,mode=755 0 0", "run /run tmpfs rw,nosuid,nodev,relatime,mode=755 0 0", "...
+
+LinuxStat::Mounts.list_devices
+=> ["proc", "sys", "dev", "run", "/dev/sda2", "securityfs", "tmpfs", "devpts", "tmpfs", "cgroup2", "cgroup", "pstore", "none", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "cgroup", "systemd-1", "deb...
+
+LinuxStat::Mounts.list_devices_mount_point
+=> {"proc"=>"/proc", "sys"=>"/sys", "dev"=>"/dev", "run"=>"/run", "/dev/sda2"=>"/", "securityfs"=>"/sys/kernel/security", "tmpfs"=>"/run/user/1000", "devpts"=>"/dev/pts", "cgroup2"=>"/sys/fs/cgroup/unified", "cgroup"=>"/sys/fs/cgroup/perf_event", "pstore...
+
+LinuxStat::Mounts.mount_point
+=> "/"
 
 LinuxStat::Mounts.root
 => "/dev/sda2"
@@ -224,8 +239,23 @@ LinuxStat::Mounts.tmpfs
 
 ### LinuxStat::Net
 ```
+LinuxStat::Net.current_usage
+=> {:received=>2183400.0, :transmitted=>114860.0}
+
 LinuxStat::Net.ipv4_private
-=> "192.168.0.101"
+=> "192.168.0.102"
+
+LinuxStat::Net.total_bytes
+=> {:received=>294316415, :transmitted=>45313147}
+
+LinuxStat::Net.total_bytes_received
+=> 294317913
+
+LinuxStat::Net.total_bytes_transmitted
+=> 45313147
+
+LinuxStat::Net.usage
+=> {:received=>1643690.0, :transmitted=>146030.0}
 
 ```
 
@@ -253,29 +283,29 @@ LinuxStat::OS.os_release
 => {:NAME=>"Arch Linux", :PRETTY_NAME=>"Arch Linux", :ID=>"arch", :BUILD_ID=>"rolling", :ANSI_COLOR=>"38;2;23;147;209", :HOME_URL=>"https://www.archlinux.org/", :DOCUMENTATION_URL=>"https://wiki.archlinux.org/", :SUPPORT_URL=>"https://bbs.archlinux.org/"...
 
 LinuxStat::OS.uptime
-=> {:hour=>9, :minute=>10, :second=>19.41}
+=> {:hour=>7, :minute=>44, :second=>29.92}
 
 ```
 
 ### LinuxStat::Process
 ```
 LinuxStat::Process.count
-=> 221
+=> 205
 
 LinuxStat::Process.idle
-=> [3, 4, 6, 9, 12, 23, 30, 37, 39, 49, 102, 103, 104, 106, 107, 108, 109, 110, 117, 118, 120, 122, 131, 134, 140, 152, 153, 168, 170, 173, 174, 182, 183, 184, 185, 186, 187, 214, 224, 268, 308, 313, 314, 330, 2357, 2358, 2359, 2360, 2361, 2362, 25094, 2...
+=> [3, 4, 6, 9, 12, 23, 30, 37, 39, 49, 102, 103, 104, 106, 107, 108, 109, 110, 117, 118, 120, 122, 131, 134, 140, 152, 153, 166, 168, 172, 174, 176, 178, 182, 183, 184, 185, 186, 188, 230, 271, 324, 328, 337, 14228, 14757, 14998, 14999, 15000, 15001, 15...
 
 LinuxStat::Process.list
-=> [1, 2, 3, 4, 6, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 27, 28, 30, 31, 32, 33, 34, 35, 37, 38, 39, 40, 41, 42, 46, 47, 48, 49, 50, 51, 52, 102, 103, 104, 106, 107, 108, 109, 110, 112, 114, 115, 117, 118, 120, 122, 131, 134,...
+=> [1, 2, 3, 4, 6, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 27, 28, 30, 31, 32, 33, 34, 35, 37, 38, 39, 40, 41, 42, 46, 47, 48, 49, 50, 51, 52, 102, 103, 104, 106, 107, 108, 109, 110, 111, 114, 115, 117, 118, 120, 122, 131, 134,...
 
 LinuxStat::Process.names
-=> {1=>"systemd", 2=>"kthreadd", 3=>"rcu_gp", 4=>"rcu_par_gp", 6=>"kworker/0:0H-kblockd", 9=>"mm_percpu_wq", 10=>"ksoftirqd/0", 11=>"rcuc/0", 12=>"rcu_preempt", 13=>"rcub/0", 14=>"migration/0", 15=>"idle_inject/0", 16=>"cpuhp/0", 17=>"cpuhp/1", 18=>"idle...
+=> {1=>"systemd", 2=>"kthreadd", 3=>"rcu_gp", 4=>"rcu_par_gp", 6=>"kworker/0:0H", 9=>"mm_percpu_wq", 10=>"ksoftirqd/0", 11=>"rcuc/0", 12=>"rcu_preempt", 13=>"rcub/0", 14=>"migration/0", 15=>"idle_inject/0", 16=>"cpuhp/0", 17=>"cpuhp/1", 18=>"idle_inject/...
 
 LinuxStat::Process.running
-=> [30804]
+=> [21158]
 
 LinuxStat::Process.sleeping
-=> [1, 2, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 27, 28, 31, 32, 33, 34, 35, 38, 40, 41, 42, 46, 47, 48, 50, 51, 52, 112, 114, 115, 167, 169, 188, 215, 228, 307, 309, 311, 316, 317, 319, 320, 354, 355, 356, 357, 364, 368, 370, 384, 397,...
+=> [1, 2, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 27, 28, 31, 32, 33, 34, 35, 38, 40, 41, 42, 46, 47, 48, 50, 51, 52, 111, 114, 115, 165, 167, 189, 217, 231, 302, 307, 308, 309, 310, 320, 321, 322, 323, 325, 326, 350, 353, 356, 374, 394,...
 
 LinuxStat::Process.types
 => {1=>:sleeping, 2=>:sleeping, 3=>:idle, 4=>:idle, 6=>:idle, 9=>:idle, 10=>:sleeping, 11=>:sleeping, 12=>:idle, 13=>:sleeping, 14=>:sleeping, 15=>:sleeping, 16=>:sleeping, 17=>:sleeping, 18=>:sleeping, 19=>:sleeping, 20=>:sleeping, 21=>:sleeping, 23=>:i...
@@ -288,28 +318,34 @@ LinuxStat::Process.zombie
 ### LinuxStat::ProcessInfo
 ```
 LinuxStat::ProcessInfo.cmdline
-=> "ruby bin/linuxstat.rb -md"
+=> "ruby exe/linuxstat.rb -md"
 
 LinuxStat::ProcessInfo.command_name
 => "ruby"
 
 LinuxStat::ProcessInfo.cpu_stat
-=> {:cpu_usage=>0.0, :threads=>1, :last_executed_cpu=>2}
+=> {:cpu_usage=>0.0, :threads=>1, :last_executed_cpu=>1}
 
 LinuxStat::ProcessInfo.cpu_usage
 => 0.0
 
+LinuxStat::ProcessInfo.gid
+=> {:real=>1000, :effective=>1000, :saved_set=>1000, :filesystem_uid=>1000}
+
 LinuxStat::ProcessInfo.last_executed_cpu
-=> 2
+=> 1
 
 LinuxStat::ProcessInfo.mem_stat
-=> {:memory=>9644, :virtual_memory=>79568, :resident_memory=>15764}
+=> {:memory=>10051.584, :virtual_memory=>81801.216, :resident_memory=>15986.688}
 
 LinuxStat::ProcessInfo.memory
-=> 9644
+=> 10051.584
+
+LinuxStat::ProcessInfo.owner
+=> "sourav"
 
 LinuxStat::ProcessInfo.resident_memory
-=> 15764
+=> 15986.688
 
 LinuxStat::ProcessInfo.threads
 => 1
@@ -317,8 +353,11 @@ LinuxStat::ProcessInfo.threads
 LinuxStat::ProcessInfo.total_io
 => {:read_bytes=>0, :write_bytes=>0}
 
+LinuxStat::ProcessInfo.uid
+=> {:real=>1000, :effective=>1000, :saved_set=>1000, :filesystem_uid=>1000}
+
 LinuxStat::ProcessInfo.virtual_memory
-=> 79568
+=> 81801.216
 
 ```
 
@@ -328,25 +367,25 @@ LinuxStat::Swap.any?
 => true
 
 LinuxStat::Swap.available
-=> 2256212
+=> 3383720
 
 LinuxStat::Swap.list
-=> {"/dev/zram0"=>[:partition, 4194300, 1938088, -2]}
+=> {"/dev/zram0"=>[:partition, 4194300, 810580, -2]}
 
 LinuxStat::Swap.percent_available
-=> 53.79
+=> 80.67
 
 LinuxStat::Swap.percent_used
-=> 46.21
+=> 19.33
 
 LinuxStat::Swap.stat
-=> {:total=>4194300, :used=>1938088, :available=>2256212, :percent_used=>46.21, :percent_available=>53.79}
+=> {:total=>4194300, :used=>810580, :available=>3383720, :percent_used=>19.33, :percent_available=>80.67}
 
 LinuxStat::Swap.total
 => 4194300
 
 LinuxStat::Swap.used
-=> 1938088
+=> 810580
 
 ```
 
@@ -355,6 +394,21 @@ LinuxStat::Swap.used
 LinuxStat::Sysconf.child_max
 => 2000000
 
+LinuxStat::Sysconf.get_euid
+=> 1000
+
+LinuxStat::Sysconf.get_gid
+=> 1000
+
+LinuxStat::Sysconf.get_login
+=> "sourav"
+
+LinuxStat::Sysconf.get_uid
+=> 1000
+
+LinuxStat::Sysconf.get_user
+=> "sourav"
+
 LinuxStat::Sysconf.hostname_max
 => 64
 
@@ -362,9 +416,9 @@ LinuxStat::Sysconf.login_name_max
 => 256
 
 LinuxStat::Sysconf.open_max
-=> 8192
+=> 1024
 
-LinuxStat::Sysconf.page_size_max
+LinuxStat::Sysconf.pagesize
 => 4096
 
 LinuxStat::Sysconf.posix_version
@@ -390,15 +444,74 @@ LinuxStat::Uname.nodename
 => "archlinux"
 
 LinuxStat::Uname.release
-=> "5.9.1-xanmod1-1"
+=> "5.9.9-xanmod1-1"
 
 LinuxStat::Uname.sysname
 => "Linux"
 
 LinuxStat::Uname.version
-=> "#1 SMP PREEMPT Wed, 21 Oct 2020 01:11:20 +0000"
+=> "#1 SMP PREEMPT Fri, 20 Nov 2020 07:44:55 +0000"
+
+```
 
+### LinuxStat::User
 ```
+LinuxStat::User.get_current_user
+=> "sourav"
+
+LinuxStat::User.get_euid
+=> 1000
+
+LinuxStat::User.get_gid
+=> 1000
+
+LinuxStat::User.get_login
+=> "sourav"
+
+LinuxStat::User.get_uid
+=> 1000
+
+LinuxStat::User.get_user
+=> "sourav"
+
+LinuxStat::User.gid_by_username
+=> 1000
+
+LinuxStat::User.gids
+=> {:root=>0, :bin=>1, :daemon=>2, :mail=>12, :ftp=>11, :http=>33, :nobody=>65534, :dbus=>81, :"systemd-journal-remote"=>982, :"systemd-network"=>981, :"systemd-resolve"=>980, :"systemd-timesync"=>979, :"systemd-coredump"=>978, :uuidd=>68, :avahi=>977, :...
+
+LinuxStat::User.home_by_gid
+=> "/home/sourav"
+
+LinuxStat::User.home_by_username
+=> "/home/sourav"
+
+LinuxStat::User.home_directories
+=> {:root=>"/root", :bin=>"/", :daemon=>"/", :mail=>"/var/spool/mail", :ftp=>"/srv/ftp", :http=>"/srv/http", :nobody=>"/", :dbus=>"/", :"systemd-journal-remote"=>"/", :"systemd-network"=>"/", :"systemd-resolve"=>"/", :"systemd-timesync"=>"/", :"systemd-c...
+
+LinuxStat::User.homes_by_uid
+=> ["/home/sourav"]
+
+LinuxStat::User.ids
+=> {:root=>{:uid=>0, :gid=>0}, :bin=>{:uid=>1, :gid=>1}, :daemon=>{:uid=>2, :gid=>2}, :mail=>{:uid=>8, :gid=>12}, :ftp=>{:uid=>14, :gid=>11}, :http=>{:uid=>33, :gid=>33}, :nobody=>{:uid=>65534, :gid=>65534}, :dbus=>{:uid=>81, :gid=>81}, :"systemd-journal...
+
+LinuxStat::User.list
+=> ["root", "bin", "daemon", "mail", "ftp", "http", "nobody", "dbus", "systemd-journal-remote", "systemd-network", "systemd-resolve", "systemd-timesync", "systemd-coredump", "uuidd", "avahi", "colord", "git", "lxdm", "polkitd", "rtkit", "usbmux", "sourav...
+
+LinuxStat::User.uid_by_username
+=> 1000
+
+LinuxStat::User.uids
+=> {:root=>0, :bin=>1, :daemon=>2, :mail=>8, :ftp=>14, :http=>33, :nobody=>65534, :dbus=>81, :"systemd-journal-remote"=>982, :"systemd-network"=>981, :"systemd-resolve"=>980, :"systemd-timesync"=>979, :"systemd-coredump"=>978, :uuidd=>68, :avahi=>977, :c...
+
+LinuxStat::User.username_by_gid
+=> "sourav"
+
+LinuxStat::User.usernames_by_uid
+=> ["sourav"]
+
+```
+
 ---
 
 ## Note 1: Filesystem
@@ -423,7 +536,7 @@ $ irb
 irb(main):001:0> require 'linux_stat'
 => true
 
-irb(main):002:0> LinuxStat::Mounts.list.find { |x| x.include?('/run/media/sourav') }.split[1]
+irb(main):002:0> LinuxStat::Mounts.mount_point('/dev/sdb1')
 => "/run/media/sourav/5c2b7af7-d4c3-4ab4-a035-06d18ffc8e6f"
 
 irb(main):003:0> thumbdrive = _
@@ -511,7 +624,185 @@ irb(main):003:0> t = Time.now ; puts LinuxStat::FS.stat('/') ; Time.now - t
 => 5.0468e-05
 ```
 
-To learn more about them, just run ri and the method name. To see all available methods:
+To learn more about them, just run ri and the method name. To see all available methods.
+
+## Note 4: User
+Most of the LinuxStat::User supports arguments.
+
+For example, to get a user's home by the username:
+
+```
+$ irb
+irb(main):001:0> require 'linux_stat'
+=> true
+
+irb(main):002:0> LinuxStat::User.home_by_username('root')
+=> "/root"
+
+irb(main):003:0> LinuxStat::User.home_by_username('ftp')
+=> "/srv/ftp"
+
+irb(main):004:0> LinuxStat::User.home_by_username('mail')
+=> "/var/spool/mail"
+```
+
+Or to get the user's home by the GID/UID:
+
+```
+$ irb
+irb(main):001:0> require 'linux_stat'
+=> true
+
+irb(main):002:0> LinuxStat::User.homes_by_uid(1001)
+=> ["/home/userx", "/home/userz"]
+
+irb(main):003:0> LinuxStat::User.homes_by_uid(1000)
+=> ["/home/sourav"]
+
+irb(main):004:0> LinuxStat::User.home_by_gid(1001)
+=> "/home/userx"
+
+irb(main):005:0> LinuxStat::User.home_by_gid(1000)
+=> "/home/sourav"
+
+irb(main):006:0> LinuxStat::User.home_by_gid(0)
+=> "/root"
+```
+
+Or to get the UID/GID by username:
+
+```
+$ irb
+irb(main):001:0> require 'linux_stat'
+=> true
+
+irb(main):002:0> LinuxStat::User.uid_by_username('root')
+=> 0
+
+irb(main):003:0> LinuxStat::User.uid_by_username('ftp')
+=> 14
+
+irb(main):004:0> LinuxStat::User.gid_by_username('ftp')
+=> 11
+
+irb(main):005:0> LinuxStat::User.gid_by_username('InvalidUser')
+=> nil
+```
+
+Or to get the current user (in docker for example):
+
+```
+$ irb
+irb(main):001:0> require 'linux_stat'
+=> true
+
+irb(main):002:0> LinuxStat::User.get_current_user
+=> "x"
+
+irb(main):003:0> LinuxStat::User.get_user
+=> "x"
+
+irb(main):004:0> LinuxStat::User.get_login
+=> ""
+```
+
+Right, the get_login() can return an empty string. But LinuxStat::User.get_user also aliased as LinuxStat::User.get_current_user shouldn't return an empty string under most circumstances.
+
+## Note 5: PrettifyBytes
+Often times we need to work with KB, MB GB, TB, or KiB, MiB, GiB, TiB, etc.
+And we need some work to convert bytes to those units.
+Because LinuxStat provides a lot of data in bytes, and kilobytes, it's quite tedious to convert them all the time.
+To avoid such duplication, it comes with a PrettifyBytes module.
+
+For example, to convert bytes to decimal suffixes:
+
+```
+$irb
+irb(main):001:0> require 'linux_stat'
+=> true
+
+irb(main):002:0> LinuxStat::PrettifyBytes.convert_decimal(1000)
+=> "1.00 kilobyte"
+
+irb(main):003:0> LinuxStat::PrettifyBytes.convert_decimal(10000)
+=> "10.00 kilobytes"
+
+irb(main):004:0> LinuxStat::PrettifyBytes.convert_decimal(100000)
+=> "100.00 kilobytes"
+
+irb(main):005:0> LinuxStat::PrettifyBytes.convert_decimal(10 ** 13)
+=> "10.00 terabytes"
+```
+
+To convert bytes to binary suffixes:
+
+```
+irb(main):006:0> LinuxStat::PrettifyBytes.convert_binary(1000)
+=> "1000.00 bytes"
+
+irb(main):007:0> LinuxStat::PrettifyBytes.convert_binary(10000)
+=> "9.77 kibibytes"
+
+irb(main):008:0> LinuxStat::PrettifyBytes.convert_binary(100000)
+=> "97.66 kibibytes"
+
+irb(main):009:0> LinuxStat::PrettifyBytes.convert_binary(10 ** 13)
+=> "9.09 tebibytes"
+```
+
+To convert them to short Metric decimal suffixes:
+
+```
+irb(main):010:0> LinuxStat::PrettifyBytes.convert_short_decimal(1000)
+=> "1.00 kB"
+
+irb(main):011:0> LinuxStat::PrettifyBytes.convert_short_decimal(10000)
+=> "10.00 kB"
+
+irb(main):012:0> LinuxStat::PrettifyBytes.convert_short_decimal(100000)
+=> "100.00 kB"
+
+irb(main):013:0> LinuxStat::PrettifyBytes.convert_short_decimal(10 ** 13)
+=> "10.00 TB"
+```
+
+To convert them to short IEC binary suffixes:
+
+```
+irb(main):014:0> LinuxStat::PrettifyBytes.convert_short_binary(1000)
+=> "1000 B"
+
+irb(main):015:0> LinuxStat::PrettifyBytes.convert_short_binary(10000)
+=> "9.77 KiB"
+
+irb(main):016:0> LinuxStat::PrettifyBytes.convert_short_binary(100000)
+=> "97.66 KiB"
+
+irb(main):017:0> LinuxStat::PrettifyBytes.convert_short_binary(10 ** 13)
+=> "9.09 TiB"
+```
+
+It can support values upto hundreds of yottabytes and yobibytes, or yb and yib. You can also do stuff like:
+
+```
+$ irb
+irb(main):001:0> require 'linux_stat'
+=> true
+
+irb(main):002:0> LinuxStat::PrettifyBytes.convert_short_decimal(LinuxStat::Mounts.device_stat('/dev/sdb1')[:total])
+=> "31.47 GB"
+
+irb(main):003:0> LinuxStat::PrettifyBytes.convert_short_binary(LinuxStat::Mounts.device_stat('/dev/sdb1')[:total])
+=> "29.31 GiB"
+
+irb(main):004:0> LinuxStat::PrettifyBytes.convert_short_binary(LinuxStat::Mounts.device_stat('/dev/sdb1')[:used])
+=> "26.80 GiB"
+
+irb(main):005:0> LinuxStat::PrettifyBytes.convert_short_binary(LinuxStat::Mounts.device_stat('/dev/sdb1')[:available])
+=> "2.51 GiB"
+```
+
+Read the ri documentation for more info.
 
 ---
 
@@ -558,31 +849,37 @@ Issues regarding running LinuxStat on termux are also welcomed.
 ---
 
 ## Development
+After checking out the repo, compile and install this gem onto your local machine with `bundle exec rake install`
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To test all modules, run `rake install` and then `exe/linuxstat.rb`. Also check "Testing" below.
 
 ---
 
 ## Testing
-Like other gems, this doesn't have a test like RSpec. We suggest using the bin/linuxstat.rb file on various systems.
+Like other gems, this doesn't have a test like RSpec.
+
+We suggest using the exe/linuxstat.rb file on various Linux systems to test.
+
+First you need to execute `bundle exec rake install` to compile and install this gem.
+
 If you need to test a specific module, say the CPU, just run it like this:
 
 ```
-$ ruby bin/linuxstat.rb CPU
+$ ruby exe/linuxstat.rb CPU
 ```
 
 Or:
 ```
-$ ruby bin/linuxstat.rb cpu
+$ ruby exe/linuxstat.rb cpu
 ```
 
 That is, the argument passed is not case-sensitive.
 But if the argument passed isn't available and outright wrong, it will run all the module methods. For example, you can't do:
 
 ```
-$ ruby bin/linuxstat.rb upc
+$ ruby exe/linuxstat.rb upc
 ```
 This is not a valid module and can't be run.