Update README.md
This commit is contained in:
parent
d253f0b097
commit
d2630d6e4f
1 changed files with 90 additions and 2 deletions
92
README.md
92
README.md
|
|
@ -1,3 +1,91 @@
|
|||
# lackadaisical
|
||||
# LACKADAISICAL
|
||||
*This project is still under heavy development!*
|
||||
|
||||
A collection of easy-to-understand, easy-to-use scripts and functions. Designed to be beginner-friendly but also useful
|
||||
A collection of easy-to-understand, easy-to-use scripts and functions. Designed to be beginner-friendly but also useful!
|
||||
|
||||
# Contents
|
||||
*(taken from `daisy_help`)*
|
||||
|
||||
```
|
||||
===================================================================
|
||||
|
||||
Thanks for installing LACKADAISICAL!
|
||||
This project aims to provide useful utilities as well as learning
|
||||
material.
|
||||
It is still under heavy development, not all of the things on this
|
||||
list are present/implemented.
|
||||
|
||||
===================================================================
|
||||
|
||||
This suite provides a number of functions, aliases and scripts.
|
||||
They are all aimed at enhancing your efficiency.
|
||||
|
||||
===================================================================
|
||||
|
||||
These are the included binaries:
|
||||
- calm: Reduce a process niceness to 0.
|
||||
- chroot-aio: A chroot wrapper that also takes care of binding
|
||||
every required directory and has no options.
|
||||
- cdz: This utility extracts an archive to /tmp and changes
|
||||
directory to it in a new shell instance. Upon exit,
|
||||
the files are wiped.
|
||||
- editx: Uses your standard CLI editor to create/modify a
|
||||
file and make it executable.
|
||||
- filewait: This tool is given a filename of a file that does
|
||||
not exist yet. When the file appears on disk, the
|
||||
program quits and simply returns the filename. This
|
||||
can be used in personal workflows.
|
||||
- newday: A basic but powerful journaling system. Recommended
|
||||
to set up via crontab. Can be used for everything
|
||||
from diaries to BTRFS snapshots.
|
||||
- own: A simple utility. It effectively uses chown -R
|
||||
user:user on its target. Root permissions required!
|
||||
- short: This tool allows you to set up directory shortcuts.
|
||||
It enhances cd t to integrate itsef using its own
|
||||
syntax. It is similar to wd.
|
||||
- shrc: This tool allows you to edit the RC file for your
|
||||
shell in your preferred editor. After saving, the
|
||||
file is sourced by your shell.
|
||||
- sw: A basic function that swaps two files by content.
|
||||
Useful for restoring backups.
|
||||
- what: 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.
|
||||
|
||||
===================================================================
|
||||
|
||||
There are aliases and functions included within this file as well:
|
||||
- bak/unbak: These small utilities make backups of files by making
|
||||
a copy with a .bak suffix. Unbak reverses the process
|
||||
using sw and removes the backup.
|
||||
- lsa: A simple alias for ls -lah.
|
||||
- lsn: A simple alias for ls -lah --sort=time --reverse.
|
||||
- editbin: An alias for editx $(which <x>). Saves on typing.
|
||||
- ched: Like chsh but for your editor (EDITOR env). A list
|
||||
from which you can choose an installed editor
|
||||
(CLI or GUI) is shown.
|
||||
- cdf: Use fzf to find a file and then cd to its location.
|
||||
- ldrc: Edits this file and source it, similarly to shrc.
|
||||
- daisy_init: Alias for directly sourcing this file from any
|
||||
LACKADAISICAL binary. You may use this yourself.
|
||||
- daisy_cbin: Contains the name of the current LACKADAISICAL
|
||||
binary being run.
|
||||
- daisy_enc: Converts a file/stdin to a base64 block that can be
|
||||
decoded by passing the output(s) to daisy_dec.
|
||||
- *_multi: A version of daisy_enc that runs encodes multiple
|
||||
files and outputs daisy_base64_data blocks to a file
|
||||
or stdout.
|
||||
- daisy_dec: Converts daisy_base64_data blocks back to the form
|
||||
it was in originally.
|
||||
- *_multi: A version of daisy_dec that runs on multiple input
|
||||
blocks that are either stored in a file or stdin.
|
||||
|
||||
===================================================================
|
||||
|
||||
To uninstall LACKADAISICAL, simply remove the source line from your
|
||||
shell RC, and reload it. This does not remove the files!
|
||||
|
||||
To read this notice again, call the function 'daisy_help'.
|
||||
|
||||
===================================================================
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue