# CHARSEL
-A very simple shell script to make copying frequently used special characters to your clipboard easy.
+A simple bash script to make copying frequently used special characters to your clipboard easy.
-It uses a plain-text file known as a "charfile" to define shortcuts to special characters that are easy to access on the keyboard.
+It uses a plain-text file known as a "charfile" to define easy to reach shortcuts to special characters
## Installation
-Run `make install` as root to install
-Run `make uninstall` as root to remove. Will not delete your personal charfiles
+- Run `make install` as root to install
+- Run `make uninstall` as root to remove. Will not delete your personal charfiles
+- Run `make purge` as a normal user to remove charsel files from your home directory
## Dependencies
- * Posix shell
- * util-linux
- * xclip
- * A terminal with UTF-8 encoding enabled
+ * Bash
+ * Linux
+ * Xclip
+ * A terminal with UTF-8 encoding enabled
-## USAGE
-To start the program, run `charsel <charfile>`
-This will start the program with the specified charfile. There are a few installed by default, to see them, use `charsel list`.
+## Usage
+For argument usage, use `charsel -h`
-Once you have started the program, simply type the shortcut listed on the left side of the table to copy the character on the right side of the table to your clipboard. If the charfile you used has multi-character shortcut keys, then you must hit enter after using a single letter shortcut. If the only shortcuts are single-letter, however, you can simply type the shortcut without clicking enter.
+Once you [have](have) started the program, simply type the shortcut listed on the left side of the table to copy the character on the right side of the table to your clipboard. Shortcodes the same length as the longest one will automatically be entered. To quit, type ';' as a shortcode
-The default charfiles all have hidden shortcuts for capital letters that are not shown on the table. Simply type a capital version of the shortcut key to access the capital version of the special character.
+Some of the default charfiles have hidden shortcuts for capital letters that are not shown on the table. Simply type a capital version of the shortcut key to access the capital version of the special character.
-## CREATING A CHARFILE
-Make a new file in `~/.local/share/charsel/` or `/usr/share/charsel` with the name that you would like to use to call the charfile in the command.
+## Creating a charfile
+Make a new file in the `~/.local/share/charsel/charfiles/` or `/usr/share/charsel/charfiles/` directories with the name that you would like to use to call the charfile in the command.
-Fill it in, using the provided examples as a template. Hidden shortcuts go above the '---'
+Fill it in, using the provided examples as a template. Hidden shortcuts go above the '-', lines can be commented out using a '#' at the start of the line. ';' cannot be used as a shortcode, as that is used to quit the program
-## LICENSE
+## Shell completions
+There is a shell completion script provided. To install it, use `make install-completions`
+
+## License
Charfile is GNU GPLv3 licensed, see COPYING for more information
-
-Charfile is written by [Armaan Bhojwani](https://armaan.bhojwani.org), [Email](mailto:3fb650a9-b47e-4604-a282-1dd91953b2ee@anonaddy.me)
-## BRANCHES
-Development happens on the "development" branch, which then gets merged into the "master" branch once its ready for a stable release
+Charfile is written by [Armaan Bhojwani](https://armaan.bhojwani.org), [Email](mailto:3fb650a9-b47e-4604-a282-1dd91953b2ee@anonaddy.me)
projects / charsel.git / blobdiff