version 1.40.130 release

[feisty_meow.git] / documentation / feisty_meow_command_reference.txt

diff --git a/documentation/feisty_meow_command_reference.txt b/documentation/feisty_meow_command_reference.txt
index 789bf0de19ac245f23597ce089d48daff0dff38b..d885f0fab490cd87581ddd19882300e81ff64895 100644 (file)
--- a/documentation/feisty_meow_command_reference.txt
+++ b/documentation/feisty_meow_command_reference.txt
@@ -25,25 +25,42 @@ generally useful commands
   take inventory.  prints out some time and relative dimension in space
   information and shows the current directory's contents.
 
-  dir / l:
+  dir or l (lower-case L):
   show the directory with a "summing" feature that calculates the full size
   consumed by all files in the listing, with somewhat esthetic output.
 
+  ll:
+  like 'dir' but also includes hidden files (e.g. those starting with a dot).
+
   ls:
   the standard ls command (not the summing directory), but with ls colors
   enabled.
 
-  del / rm:
+  del or rm:
   invoke "safedel" feature to remove the files specified.  this archives the
   deleted files in "$TMP/zz_safedel_keep" and writes a report of the deletion
   history in "$TMP/zz_safedel_report.txt".
 
-note: currently there is no "empty the trash" function aside from running a command such as:
-# \rm -rf $TMP/zz_safedel*
-the backslash forces bash to run the "rm" tool from the path rather than from
-the feisty meow alias.
-a trash flushing feature is planned for the somewhat near future.
+  note about safe deletion support:
+  currently there is no "empty the trash" function aside from running a
+  command such as:
+    $ \rm -rf $TMP/zz_safedel*
+  the backslash forces bash to run the "rm" tool from the path rather than
+  using the feisty meow alias.  a trash flushing feature is planned for the
+  somewhat near future.
+
+  regenerate:
+  runs the feisty meow reconfiguration process to adapt to a new version of
+  the scripts.  this also updates the current shell's functions and aliases
+  to reflect any changes.
+
+  get_feisty:
+  update the feisty meow codebase from its origin and run the regeneration
+  script to update the current user's feisty meow configuration.
 
+  whackem:
+  permanently delete files, rather than using safe delete (safedel).  this
+  script will accept all the standard arguments to "rm".
 
 revision control commands
 =========================
@@ -109,7 +126,7 @@ some assorted other revision control commands:
   pushd $FEISTY_MEOW_APEX; git checkout dev; popd
 
   and this command will get you back onto the mainline branch:
-  pushd $FEISTY_MEOW_APEX; git checkout master; popd
+  pushd $FEISTY_MEOW_APEX; git checkout main; popd
 
 =============================
 the site avenger script suite
@@ -120,7 +137,7 @@ managing web sites.  these scripts offer a lot of power to the developer, and
 of course that comes with great responsibility...
 
 the site avenger scripts are configured by "app" files stored in the "config"
-directory (in $FEISTY_MEOW_SCRIPTS/scripts/site_avenger/config).  the scripts
+directory (in $FEISTY_MEOW_SCRIPTS/site_avenger/config).  the scripts
 seek out a config file named after the application, e.g. they look for
 "winterportlibrary.app" if the application name is "winterportlibrary".
 the basic config file "default.app" is used for any application that is unknown
@@ -162,8 +179,8 @@ the powerup command, but is not ready yet.)
   avcoreup:
   updates the avcore portion of a site avenger application.  this command can
   accept an application name within which to update, or it can auto-pick the
-  applicatin for you from the available checked out ones in ~/apps (the default
-  storage folder for all site avenger style sites).
+  application for you from the available checked out ones in ~/apps (the
+  default storage folder for all site avenger style sites).
 
   siteup:
   updates the entire checked out repository for a site avenger application.
@@ -181,7 +198,7 @@ note: satis-refresh is the one site avenger command that hasn't been "feisty meo
 lower level scripts used by site avenger scripts
 ------------------------------------------------
 
-  add_domain / remove_domain: (from system script collection)
+  add_domain and remove_domain: (from system script collection)
   adds (or removes) a DNS domain to the bind9 configuration.  the domain
   tools, are very sensitive to any edits within the chunks of code they have
   written.  when it comes time to remove the domain again, the script will eat
@@ -190,7 +207,7 @@ lower level scripts used by site avenger scripts
   config files, be sure to do it way above or way below the auto-generated
   domain chunks.
 
-  add_apache_site / remove_apache_site: (from system script collection)
+  add_apache_site and remove_apache_site: (from system script collection)
   creates (or removes) an apache compatible site definition.  this will rely
   on the site's domain previously having been added to the DNS.