Latest version

README.md

@@ -1,4 +1,6 @@
 ---*This project is still under heavy development!*---
+\Please do not delete this file, as it is used to display help information.
+
 # L A C K A D A I S I C A L
 A collection of easy-to-understand, easy-to-use scripts, functions and aliases. Designed to be beginner-friendly but also useful!
 
@@ -34,8 +36,6 @@ lackadaisical` if you so desire.
 To read this notice again, call the function 'daisy_help'.
 ===============================================================================
 These are the included binaries and utilities:
- - calm:
-     Reduce a process 'niceness' to 0.
  - cdz:
      This utility extracts an archive to /tmp and changes
      directory to it in a new shell instance. Upon exit,
@@ -45,6 +45,25 @@ These are the included binaries and utilities:
      NO_ARCHIVEMOUNT=1. The standard script supports zip,
      tarballs, and rar archives. We recommend relying on
      archivemount` if you have it installed.
+ - SquashFS tools (mount/umount/make/destroy-squash-image):
+     These convenient set of tools allow you to easily create
+     XZ-compressed SquashFS images from existing folders to save
+     disk space. The resulting folder is still writable since it is
+     mounted using an 'overlay' system. You can use 'make-squash-image'
+     to compresses an existing folder. These folders are automatically
+     mounted when you use 'cd' to navigate to them (via an alias).
+     When using 'make-squash-image' on an already mounted folder, it will
+     instead update the existing image. As of writing, we do not have a
+     SystemD service to auto-mount, however, you cam easily add auto-mount
+     as a cron job. Here is a list of tools, they all take the same
+     folder argument:
+     > make-squash-image:    Converts the folder into a hidden image
+                             on the same disk as the folder.
+     > mount-squash-image:   Sets up a mount for the XZ image alongside
+                             directories for changes
+     > umount-squash-image:  Self-explanatory.
+     > destroy-squash-image: Extracts the image and essentially reverts
+                             everything. File changes are kept, however.
  - editx:
      Uses your standard CLI editor to create/modify a
      file and make it executable.
@@ -53,16 +72,32 @@ These are the included binaries and utilities:
      not exist yet. When the file appears on disk, the
      tool quits and simply returns the filename. This
      can be used in personal workflows to stall a longer
-     command that relies on the existence of said file.
- - newday:
-     A basic but powerful journaling system. Recommended
-     to be set up via crontab. Can be used for everything
-     from diaries to general file storage to even BTRFS
-     snapshots.
+     command that relies on the existence of said file.=    
+ - agenda:
+     Sets up a folder that is backed by a date-based tree
+     directory structure. Requires an argument for the name
+     of the folder to generate. Generates a symlink in this
+     name to a date sub-folder in a local '.daisy' folder.
+     Format is <dir> -> .daisy/<dir>/<year>/<month>/<day>.
+     Recommended to run via crontab - automatically cleans
+     up empty folders.
+     A symbolic link to the base of the folder's tree, ".tree",
+     is created in the root of the specified directly.
+     Can be used for everything you'd like to sort by date.
+     For example; a diary, browser downloads, backups, code.
  - own:
      A simple utility. It's effectively an alias for
      "sudo chown -R user:user" on the target dir/file.
      Root permissions required!
+ - sshp:
+     This is a wrapper for `ssh`, the meaning of the 'p' is "Plus".
+     Integrates SSHFS support. If both client and host have SSHFS,
+     this wrapper can be used to connect their file systems.
+     For example, if you need to move files from one machine to
+     another, you could do something like this:
+     "sshp -m /:/mnt/pc -m /home/claire:/home/claire claire@pyon.net"
+     If privilege escalation is necessary for FS access, you will
+     be asked for a password.
  - shrc:
      This tool allows you to edit the RC file for your
      shell in your preferred editor. After saving, the
@@ -74,11 +109,11 @@ These are the included binaries and utilities:
      This is a tool similar to which and others, the key
      difference is that it returns partial matches. It can
      be used to search for binaries.
- - binbox:
+ - scripbox:
      This tool can be used to pack bash scripts into one
      big megascript, much like how `busybox` works.
      You can also make symlinks to it to invoke a specific
-     script (as of writing, 11/25, symlinks do not work well).
+     script.
  - bak/unbak:
      These small utilities make backups of files by making
      a copy with a .bak suffix. Unbak reverses the process
@@ -100,12 +135,27 @@ These are the included binaries and utilities:
      Like chsh but for your editor (EDITOR env). A list
      from which you can choose an installed editor
      (CLI or GUI) is shown. This list is by no means complete.
+     The editor for LACKADAISICAL and the global editor are
+     separate. If the EDITOR variable is already defined,
+     only LD_EDITOR will be changed. LD_EDITOR is the editor
+     used by LACKADAISICAL utilities.
+     To override the global EDITOR variable, pass "-g".
+     To restore the normal behavior of checking for an earlier
+     definition of EDITOR after passing "-g", run `ched` without
+     arguments.
  - cdf:
      Use fzf to find a file and then cd to its location.
  - cdp:
      Similar to `cdf` but uses tree+peco for the query.
+ - clip:
+     An extremely simple utility that functions as a clipboard of sorts.
+     To set the variable, run "clip <data>" or provide data via stdin.
+     To get the variable, simply run clip without any arguments.
+     The variable is stored locally in the shell as "LD_CLIP".
  - ldrc:
      Edits daisy.source and re-sources it, similarly to shrc.
+     Append "-e" to edit "extra.src", to add custom functions in the
+     lackadaisical namespace.
  - daisy_reload:
      Re-sources daisy.source. Essentially `ldrc` without
      editing.
@@ -120,7 +170,10 @@ These are the included binaries and utilities:
      decoded by passing the output(s) to `daisy_dec`.
      The output of `daisy_enc` can be concatenated with the
      output of another encoded file to create a multi-file
-     base64 archive similar to `daisy_enc_multi`
+     base64 archive similar to `daisy_enc_multi`.
+     Does not support symlinks yet, and will instead treat it
+     as a full input file (reads the data of the linked file).
+     When using stdin, please provide a filename as argument.
  - daisy_enc_multi:
      A version of `daisy_enc` that encodes multiple
      files and outputs `daisy_base64_data` blocks to a file
@@ -155,5 +208,18 @@ These are the included binaries and utilities:
      `daisy_reload`
  - daisy_list:
      List all available commands without description.
+ - daisy_clear:
+     Removes all configuration, including aliases.
+     A backup is made and can be restored using "daisy_restore".
+     Triggers a reload.
+ - daisy_backup:
+     Backs up all config files. These can be restored using
+     "daisy_restore".
+ - daisy_restore:
+     Undoes "daisy_clear" by restoring config files.
+     Triggers a reload.
+ - ld_*:
+     All functions prefixed by "daisy_" are also available with
+     the prefix "ld_" via aliases provided in daisy.source.
 --- END OF DAISY HELP ---
 ```