README.md

   1 # charsel
   2 A simple bash script to make copying frequently used special characters to your clipboard easy.
   3
   4 It uses a plain-text file known as a "charfile" to define easy to reach shortcuts to special characters
   5
   6 ## Installation
   7 - Run `make` as root to install
   8 - Run `make uninstall` as root to remove
   9 - Run `make purge` to remove charsel files from your home directory
  10 - Run `make install-completions` to install the shell completions
  11
  12 ## Dependencies
  13   * Bash
  14   * Linux
  15   * Xclip (using the -n flag bypasses this)
  16   * A terminal with UTF-8 encoding enabled (most default terminals will be fine)
  17
  18 ## Usage
  19 For argument usage, use `charsel -h`
  20
  21 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. Shortcodes the same length as the longest one will automatically be entered. To quit, type ';' as a shortcode
  22
  23 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.
  24
  25 ## Creating a charfile
  26 Make a new file in `~/.local/share/charsel/charfiles/` or `/usr/share/charsel/charfiles/` with the name that you would like to use to call the charfile in the command.
  27
  28 Fill in your shortcodes, using the provided examples in `/usr/share/charsel/charfiles` as a template. There are just 4 rules to follow.
  29   1. The pattern used is "shortcode,output"
  30   2. Hidden shortcodes go above the line with "---"
  31   3. Lines can be commented out using a "#"
  32   4. Shortcodes may not contain a semicolon or a hyphen
  33
  34 ## License
  35 Copyright Armaan Bhojwani 2020, MIT License, see the LICENSE file for more information