feat(bkgpslog):Add ~/.local/bin to PATH

[EVA-2020-02.git] / doc / location / README.org

diff --git a/doc/location/README.org b/doc/location/README.org
index 92e73b7958d718c56dc7c2a2da832642a25706de..50a0b5ed5d0e7f449a8d3746abed31f4a148edbd 100644 (file)
--- a/doc/location/README.org
+++ b/doc/location/README.org
@@ -1,7 +1,7 @@
 * Location Logging
 This document was created by Steven Baltakatei Sandoval on
 <2020-06-29 Mon 12:14> under a [[https://creativecommons.org/licenses/by-sa/4.0/][Creative Commons BY-SA 4.0 license]]. It
-was updated by Steven Baltakatei Sandoval on <2020-06-29 Mon 18:39>.
+was updated by Steven Baltakatei Sandoval on <2020-06-29 Mon 22:06>.
 ** Narrative
 Ninfacyzga-01 records (logs) its position in time and space using a
 [[https://en.wikipedia.org/wiki/Satellite_navigation_device][GPS receiver]]. The NMEA location data produced by the receiver is
@@ -134,15 +134,39 @@ Edit the user cron job list with ~$ crontab -e~ to add the following
 lines:
 
 #+BEGIN_EXAMPLE
-0 * * * * /bin/bash /path/to/bkgpslog --output $HOME/Sync/example_dir
+0 * * * * /bin/bash ~/bkgpslog --output ~/dir
 
-@reboot /bin/bash /path/to/bkgpslog --output $HOME/Sync/example_dir
+@reboot /bin/bash ~/bkgpslog --output ~/dir
 #+END_EXAMPLE
 
-The first line will run ~bkgpslog~ at the start of every hour.
+The first line will run ~bkgpslog~ at the start of every hour and save
+output files to the ~dir~ directory in your home folder.
 
 The second line will run ~bkgpslog~ when the system starts up.
 
+~/bin/bash~ tells ~cron~ to run ~bkgpslog~ with Bash.
+
+If encryption and compression are required, then the appropriate
+options must be added. The lines that must be added via ~$ crontab -e~
+may resemble:
+
+#+BEGIN_EXAMPLE
+0 * * * * /bin/bash ~/bkgpslog -c -e -r age1z2...qkv6p -o ~/dir
+
+@reboot /bin/bash ~/bkgpslog -c -e -r age1z2...qkv6p -o ~/dir
+#+END_EXAMPLE
+
+The ~age1z2...qkv6p~ is an ~age~ public key string. See the Encryption
+Methods section for an explanation.
+
+The options are:
+
+: -c : tells bkgpslog to compress output
+: -e : tells bkgpslog log to encrypt output
+: -r : tells bkgpslog to interpret the next argument as a pubkey string
+: -o : tells bkgpslog to write output files to the directory represented
+:        by the next argument
+
 ***** Log Transfer Configuration
 Log files may be shared to other machines via ~syncthing~. See [[https://docs.syncthing.net/][this]]
 manual for how to set up a shared folder and add Ninfacyzga-01 as a