added --status action

Author: arcmags

README.html

@@ -603,6 +603,9 @@ <h1>Actions</h1>
 <dt><tt class="docutils literal">remove, <span class="pre">--remove,</span> <span class="pre">-R</span></tt></dt>
 <dd>Disable ramroot.
 Remove build and runtime hooks from <em>/usr/lib/initcpio</em>.</dd>
+<dt><tt class="docutils literal">status, <span class="pre">--status,</span> <span class="pre">-S</span></tt></dt>
+<dd>Print ramroot status to screen.
+Returns exit status 2 if not enabled.</dd>
 </dl>
 </div>
 <div class="section" id="options">
@@ -631,13 +634,12 @@ <h1>Notes</h1>
 Arch Linux stores downloaded packages in <em>/var/cache/pacman/pkg/</em>.  After
 every update, if no problems occur, consider removing <a class="reference external" href="https://wiki.archlinux.org/index.php/pacman#Cleaning_the_package_cache">old packages</a>.
 Consider installer fewer packages if you indend on loading to RAM often.</p>
-<p>Also know that higher quality (more expensive) USB flash drives
-often exhibit a huge improvement in RAM sync times.</p>
+<p>Also, keep in mind that higher quality (more expensive) USB flash drives
+often exhibit a dramatic improvement in RAM sync times.</p>
 </div>
 <div class="section" id="issues-future-implementations">
 <h1>Issues / Future Implementations</h1>
 <ul class="simple">
-<li><em>status</em> action</li>
 <li><em>--rsync</em> option (maybe use rsync automatically if installed)</li>
 <li>test with full disk encryption</li>
 <li><em>flush</em> action to sync the RAM filesystem back to the

README.rst

@@ -76,6 +76,10 @@ Action performed by ramroot; one must be specified.
     Disable ramroot.
     Remove build and runtime hooks from */usr/lib/initcpio*.
 
+``status, --status, -S``
+    Print ramroot status to screen.
+    Returns exit status 2 if not enabled.
+
 
 Options
 =======
@@ -118,8 +122,6 @@ often exhibit a dramatic improvement in RAM sync times.
 Issues / Future Implementations
 ===================================
 
-*   *status* action
-
 *   *--rsync* option (maybe use rsync automatically if installed)
 
 *   test with full disk encryption

lib/man/ramroot.8

@@ -36,6 +36,10 @@ Rebuild linux cpio boot image.
 \fBremove\fR, \fB\-\-remove\fR, \fB\-R\fR
 Disable ramroot.  Remove build and runtime hooks from
 /usr/lib/initcpio.
+.TP
+\fBstatus\fR, \fB\-\-status\fR, \fB\-S\fR
+Print ramroot status to screen.
+Returns exit status 2 if not enabled.
 .SH OPTIONS
 .TP
 \fB\-b\fR, \fB\-\-boot\fR \fIUUID\fR

ramroot

@@ -28,6 +28,10 @@ ACTIONS
         Disable ramroot.
         Remove build and runtime hooks from /usr/lib/initcpio.
 
+    status, --status, -S
+        Print ramroot status to screen.
+        Returns exit status 2 if not enabled.
+
 OPTIONS
     -b, --boot UUID
         Specify /boot partition UUID to use when building hooks.
@@ -53,13 +57,16 @@ keepBuildFiles='false'
 # script variables (do not change):
 rootUUID=
 bootUUID=
-ramrootAction=
+ramrootAction='none'
 dirHooks='/usr/lib/initcpio/hooks'
 dirInstall='/usr/lib/initcpio/install'
 dirLib='/usr/lib/ramroot'
 dirScript=
 hookBuild="$dirLib/install/ramroot"
 hookRuntime="$dirLib/hooks/ramroot"
+initMODULES=
+initHOOKS=
+exitStatus=0
 
 
 ##=============================  FUNCTIONS  ==============================##
@@ -149,9 +156,6 @@ ramroot_enable() {
         mkinitChange='true'
     fi
 
-    # get current MODULES and HOOKS from /etc/mkinitcpio.conf:
-    initMODULES=`grep -P '^ *MODULES=' /etc/mkinitcpio.conf`
-    initHOOKS=`grep -P '^ *HOOKS=' /etc/mkinitcpio.conf`
     # add zram to initMODULES:
     if [[ ! "$initMODULES" =~ zram ]]; then
         if [ "$initMODULES" = 'MODULES=""' ]; then
@@ -208,9 +212,6 @@ ramroot_enable() {
 # Rebuild linux cpio boot image.
 ramroot_disable() {
     mkinitChange='false'
-    # get current MODULES and HOOKS from /etc/mkinitcpio.conf:
-    initMODULES=`grep -P '^ *MODULES=' /etc/mkinitcpio.conf`
-    initHOOKS=`grep -P '^ *HOOKS=' /etc/mkinitcpio.conf`
     # remove zram from initMODULES:
     if [[ "$initMODULES" =~ zram ]]; then
         initMODULES=`echo "$initMODULES" | \
@@ -293,6 +294,22 @@ ramroot_remove() {
     return 0
 }
 
+##========================  ramroot_status()  ========================##
+# Print ramroot installation status to screen.
+ramroot_status() {
+    if [[ "$initMODULES" =~ zram ]] &&
+    [[ "$initMODULES" =~ ext4 ]] &&
+    [[ "$initHOOKS" =~ ramroot ]] &&
+    [ -f /usr/lib/initcpio/hooks/ramroot ] &&
+    [ -f /usr/lib/initcpio/install/ramroot ]; then
+        printf ":: ramroot enabled\n"
+    else
+        printf ":: ramroot disabled\n"
+        exitStatus=2
+    fi
+}
+
+
 ##========================  helper functions  ========================##
 ramroot_cache() {
     if [ "$keepBuildFiles" = 'true' ]; then
@@ -318,6 +335,7 @@ for arg in "$@"; do case $arg in
     -K|--keep)             keepBuildFiles='true';    shift;;
     -r|--root)             shift; rootUUID="$1";     shift;;
     -R|--remove|remove)    ramrootAction='remove';   shift;;
+    -S|--status|status)    ramrootAction='status';   shift;;
 esac; done
 
 # print help:
@@ -333,9 +351,7 @@ if [ -n "$1" ]; then
 fi
 
 # FAIL: no action specified:
-if [ "$ramrootAction" != 'enable' ] &&
-[ "$ramrootAction" != 'disable' ] &&
-[ "$ramrootAction" != 'remove' ]; then
+if [ "$ramrootAction" = 'none' ]; then
     printf ":! No action specified.  See --help\n"
     exit 1
 fi
@@ -345,6 +361,10 @@ mkdir -p "$dirBuild"
 cd "$dirBuild"
 sudo -k
 
+# get current MODULES and HOOKS from /etc/mkinitcpio.conf:
+initMODULES=`grep -P '^ *MODULES=' /etc/mkinitcpio.conf`
+initHOOKS=`grep -P '^ *HOOKS=' /etc/mkinitcpio.conf`
+
 # execute action:
 if [ "$ramrootAction" = 'enable' ]; then
     ramroot_enable
@@ -353,10 +373,12 @@ elif [ "$ramrootAction" = 'disable' ]; then
 elif [ "$ramrootAction" = 'remove' ]; then
     ramroot_disable
     ramroot_remove
+elif [ "$ramrootAction" = 'status' ]; then
+    ramroot_status
 fi
 
 # remove build files:
 cd ..
 rm -Rd "$dirBuild"
 
-exit 0
+exit $exitStatus