linux_stat 0.5.2 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c68e104d55d755cd1cef1e8901a7dd67b1a901b132d9a7786fabfd75b41cf5a
-  data.tar.gz: 94d102c6244b8da52b5f7aa7b1ea903546b5ef6e615c6317233b510005b6ded7
+  metadata.gz: 73b3180065620ed0fc96662eaa96fa9e7971176e7a5d19054ae1f10b3204987c
+  data.tar.gz: 4fb253f925728426bfad5764b97cc59b71771365e984e78478ff996d7e63378c
 SHA512:
-  metadata.gz: b94d6afea3d307c845f316ce21f66e93944e1b33ad9576ecd8d55e299d6d520732677f99ea8fba3dcb3f6f5c6c8aae98526cc21b2c0218d7a8d49bdd7896cdec
-  data.tar.gz: cecbaee79f9844c5a6ad83720071a7977697edeb958d2336a68fa9f3b19ccb28074641c9620c88574dd0b5074ba6069a3457543a2cad86c11d9c5562d6e83da6
+  metadata.gz: f4b2b9296a34fbb4415587a5f6752602a3eb35f2e7da6af38e9c76a9946e18a5a120b54901d61cd43d2e624612564cfddc50c330dee7b910a5eeb12ed0b34a73
+  data.tar.gz: 2753d9fe91b324f93ce59ea4abd3d84178f515b6e31053b1b382866089dc242f680533f3fded18c9840cbdd1679d7a81920cb87b563454c8423aa2dc3fe35307

data/README.md

@@ -103,7 +103,7 @@ LinuxStat::CPU.count
 => 4
 
 LinuxStat::CPU.cur_freq
-=> [2000050, 2000024, 1998134, 1975870]
+=> [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=>3.57, 1=>0.0, 2=>0.0, 3=>0.0, 4=>0.0}
+=> {0=>0.0, 1=>0.0, 2=>0.0, 3=>0.0, 4=>0.0}
 
 LinuxStat::CPU.total_usage
-=> 3.45
+=> 0.0
 
 LinuxStat::CPU.usage
-=> 9.68
+=> 20.0
 
 LinuxStat::CPU.usages
-=> {0=>6.67, 1=>0.0, 2=>25.0, 3=>12.5, 4=>14.29}
+=> {0=>20.0, 1=>0.0, 2=>0.0, 3=>50.0, 4=>100.0}
 
 ```
 
 ### LinuxStat::Filesystem
 ```
 LinuxStat::Filesystem.available
-=> 36234563584
+=> 33120964608
 
 LinuxStat::Filesystem.free
-=> 36234563584
+=> 33120964608
 
 LinuxStat::Filesystem.stat
-=> {:total=>119981191168, :free=>36234563584, :used=>83746627584}
+=> {:total=>119981191168, :free=>33120964608, :used=>86860226560}
 
 LinuxStat::Filesystem.stat_raw
-=> {:block_size=>4096, :fragment_size=>4096, :blocks=>29292283, :block_free=>8846329, :block_avail_unpriv=>8846329, :inodes=>58612160, :free_inodes=>56635312, :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
-=> 83746627584
+=> 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
-=> 602148
+=> 579264
 
 LinuxStat::Memory.percent_available
-=> 15.7
+=> 15.1
 
 LinuxStat::Memory.percent_used
-=> 84.3
+=> 84.9
 
 LinuxStat::Memory.stat
-=> {:total=>3836256, :used=>3234108, :available=>602148, :percent_used=>84.3, :percent_available=>15.7}
+=> {:total=>3836236, :used=>3256972, :available=>579264, :percent_used=>84.9, :percent_available=>15.1}
 
 LinuxStat::Memory.total
-=> 3836256
+=> 3836236
 
 LinuxStat::Memory.used
-=> 3234108
+=> 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.43.107"
+=> "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=>15, :minute=>19, :second=>34.72}
+=> {:hour=>7, :minute=>44, :second=>29.92}
 
 ```
 
 ### LinuxStat::Process
 ```
 LinuxStat::Process.count
-=> 228
+=> 205
 
 LinuxStat::Process.idle
-=> [3, 4, 6, 9, 12, 23, 30, 37, 39, 49, 102, 103, 104, 106, 107, 108, 109, 110, 117, 118, 119, 121, 131, 134, 140, 152, 153, 174, 176, 178, 182, 183, 187, 188, 189, 190, 191, 192, 225, 231, 280, 327, 329, 335, 5823, 5824, 5825, 5826, 5827, 5828, 43047, 4...
+=> [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, 119, 121, 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
-=> [49287]
+=> [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, 173, 175, 193, 219, 235, 301, 312, 313, 315, 326, 328, 340, 363, 364, 365, 366, 373, 376, 378, 381, 395,...
+=> [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,37 +318,46 @@ LinuxStat::Process.zombie
 ### LinuxStat::ProcessInfo
 ```
 LinuxStat::ProcessInfo.cmdline
-=> "/usr/bin/ruby /home/sourav/.gem/ruby/2.7.0/bin/linuxstat.rb --html -md"
+=> "ruby exe/linuxstat.rb -md"
 
 LinuxStat::ProcessInfo.command_name
 => "ruby"
 
 LinuxStat::ProcessInfo.cpu_stat
-=> {:cpu_usage=>0.0, :threads=>1, :last_executed_cpu=>3}
+=> {: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
-=> 3
+=> 1
 
 LinuxStat::ProcessInfo.mem_stat
-=> {:memory=>11748, :virtual_memory=>81680, :resident_memory=>17928}
+=> {:memory=>10051.584, :virtual_memory=>81801.216, :resident_memory=>15986.688}
 
 LinuxStat::ProcessInfo.memory
-=> 11748
+=> 10051.584
+
+LinuxStat::ProcessInfo.owner
+=> "sourav"
 
 LinuxStat::ProcessInfo.resident_memory
-=> 17928
+=> 15986.688
 
 LinuxStat::ProcessInfo.threads
 => 1
 
 LinuxStat::ProcessInfo.total_io
-=> {:read_bytes=>3932160, :write_bytes=>0}
+=> {:read_bytes=>0, :write_bytes=>0}
+
+LinuxStat::ProcessInfo.uid
+=> {:real=>1000, :effective=>1000, :saved_set=>1000, :filesystem_uid=>1000}
 
 LinuxStat::ProcessInfo.virtual_memory
-=> 81680
+=> 81801.216
 
 ```
 
@@ -328,25 +367,25 @@ LinuxStat::Swap.any?
 => true
 
 LinuxStat::Swap.available
-=> 3358184
+=> 3383720
 
 LinuxStat::Swap.list
-=> {"/dev/zram0"=>[:partition, 4194300, 836116, -2]}
+=> {"/dev/zram0"=>[:partition, 4194300, 810580, -2]}
 
 LinuxStat::Swap.percent_available
-=> 80.07
+=> 80.67
 
 LinuxStat::Swap.percent_used
-=> 19.93
+=> 19.33
 
 LinuxStat::Swap.stat
-=> {:total=>4194300, :used=>836116, :available=>3358184, :percent_used=>19.93, :percent_available=>80.07}
+=> {:total=>4194300, :used=>810580, :available=>3383720, :percent_used=>19.33, :percent_available=>80.67}
 
 LinuxStat::Swap.total
 => 4194300
 
 LinuxStat::Swap.used
-=> 836116
+=> 810580
 
 ```
 
@@ -379,7 +418,7 @@ LinuxStat::Sysconf.login_name_max
 LinuxStat::Sysconf.open_max
 => 1024
 
-LinuxStat::Sysconf.page_size_max
+LinuxStat::Sysconf.pagesize
 => 4096
 
 LinuxStat::Sysconf.posix_version
@@ -405,24 +444,30 @@ 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
 
@@ -469,7 +514,71 @@ LinuxStat::User.usernames_by_uid
 
 ---
 
-## Note 1: Filesystem
+## Note 1: CPU usage, and Net usage
+To calculate the current usage, we need to get two usages at a given interval, and subtract the 2nd from the 1st.
+For example, if the current download (`LinuxStat::Net.total_bytes_received`) is 1000 bytes, and if 0.1 seconds ago, it was 100 bytes, that means 900 bytes was received in 0.1 seconds.
+That means the current speed is 9000 bytes/s or 9 kB/s.
+
+Without the polling, it's not really possible to calculate the current usage. Although the total usage can be calculated.
+A system monitor does that, too...
+
+Thus these methods requires a polling interval:
+
+1. LinuxStat::CPU.stat, usage, total_usage, usage.
+2. LinuxStat::ProcessInfo.cpu_usage, cpu_stat.
+3. LinuxStat::Net.usage, current_usage.
+
+They sleep for a given interval and then differentiate between the data.
+
+For more info look at the ri documentation for the above methods.
+
+These methods can slow down your application a bit unless you implement them in a thread.
+
+Other methods doesn't have the sleep implemented, and they just works under a millisecond.
+
+For example:
+
+```
+LinuxStat::CPU.stat(0.1)
+=> {0=>7.69, 1=>0.0, 2=>0.0, 3=>18.18, 4=>10.0}
+```
+This will sleep for 0.1 seconds. To be reliable, use a time like 0.05 seconds or so.
+
+If you want to build a system monitor and don't want to wait, you have to do something like this:
+
+```
+#!/usr/bin/ruby
+require 'linux_stat'
+
+usages = []
+thread = Thread.new { }
+counter = 0
+
+while true
+	thread = Thread.new { usages = LinuxStat::CPU.usages(0.5).values } unless thread.alive?
+
+	# clears the screen and prints the info
+	puts "\e[2J\e[H\e[3J"\
+	"#{counter += 1}\n"\
+	"\e[1;33mTotal CPU Usage:\e[0m #{usages[0]}%\n"\
+	"#{usages[1..-1].to_a.map.with_index { |x, i| "\e[1;33mCore #{i}\e[0m => #{x}%\n" }.join}"\
+	"Total Download: #{LinuxStat::PrettifyBytes.convert_decimal LinuxStat::Net.total_bytes_received}\n"\
+	"Total Upload: #{LinuxStat::PrettifyBytes.convert_decimal LinuxStat::Net.total_bytes_transmitted}"
+end
+```
+
+This will not wait in every loop for 0.5 seconds, but it will not update the cpu usage in every loop either.
+So what you will be seeing in the CPU usage in every 0.5 seconds interval.
+
+You will also see the counter increases like crazy. Which means it's not getting waited for 0.5 seconds.
+
+But the other methods doesn't have this delay, thus in this example,
+you will be able see the "Total Download" and "Total Upload" in real time,
+well as soon as the Linux kernel updates the data and ruby executes the loop.
+
+Just run the linuxstat.rb command to test what method takes what time measured in microseconds.
+
+## Note 2: Filesystem
 
 Filesystem can take arguments. By default it's '/' or the root of the system...
 
@@ -491,7 +600,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 = _
@@ -504,7 +613,7 @@ irb(main):005:0> LinuxStat::Filesystem.total(thumbdrive).fdiv(1024 ** 3).to_s <<
 => "29.305004119873047 GiB"
 ```
 
-## Note 2: ProcessInfo
+## Note 3: ProcessInfo
 
 All the methods LinuxStat::ProcessInfo can take an argument containing the Process ID of a process.
 By default it's $$ or the PID of the current process, ruby, itself.
@@ -556,7 +665,7 @@ irb(main):002:0> LinuxStat::ProcessInfo.memory(LinuxStat::Process.names.find { |
 => "467.51 MiB"
 ```
 
-## Note 3: FS
+## Note 4: FS
 
 LinuxStat::FS module gives you the raw info in Hash collected from statvfs.
 
@@ -581,7 +690,7 @@ irb(main):003:0> t = Time.now ; puts LinuxStat::FS.stat('/') ; Time.now - t
 
 To learn more about them, just run ri and the method name. To see all available methods.
 
-## Note 4: User
+## Note 5: User
 Most of the LinuxStat::User supports arguments.
 
 For example, to get a user's home by the username:
@@ -627,7 +736,7 @@ irb(main):006:0> LinuxStat::User.home_by_gid(0)
 Or to get the UID/GID by username:
 
 ```
-$ irb 
+$ irb
 irb(main):001:0> require 'linux_stat'
 => true
 
@@ -644,6 +753,119 @@ 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 6: 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.
 
 ---