chmod +x charsel
if [ `whoami` == root ]; then
- mkdir -p /usr/share/charsel
- cp charfiles/* /usr/share/charsel/
+ mkdir -p /usr/share/charsel/charfiles
+ cp charfiles/* /usr/share/charsel/charfiles/
+ mkdir /usr/share/doc/charsel
+ cp README.md /usr/share/doc/charsel/
+ cp motd /usr/share/charsel
cp charsel /usr/bin/
exit
else
- mkdir -p ~/.local/share/charsel
- cp charfiles/* ~/.local/share/charsel/
+ mkdir -p ~/.local/share/charsel/charfiles
+ cp charfiles/* ~/.local/share/charsel/charfiles
+ cp motd ~/.local/share/charsel/
cp charsel ~/.local/bin/
exit
fi
-# charsel
-A very simple comand line tool to make a shortcut to a special characther.
+# CHARSEL
+A very simple shell script to make copying frequently used special characters to your clipboard easy.
-It takes the input of a charfile, then puts it into a table and waits for your input. Once you put in your shortcut key, it prints the special character then copies it to the clipboard.
+It uses a plain-text file known as a "charfile" to define shortcuts to special characters that are easy to access on the keyboard.
-A charfile is just two columns with the shortcut on the left, then a separator, then the special charachter to be copied.
+## Installation
+Running the INSTALL.sh script should work fine for most people
+If it is run as root or with sudo, the program and charfiles will be installed for all users. If it is run without elevated privileges, it will just be installed for the local user.
-## INSTALLATION
-Run the INSTALL.sh script
-If run as root, it will be installed globally, if run without root, it will be just instaled for the local user
-
-## DEPENDENCIES
-posix shell
+## Dependencies
+Posix shell
util-linux
xclip
+A terminal with UTF-8 encoding enabled
## USAGE
-charsel <charfile>
+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`.
+
+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.
+
+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.
## CREATING A CHARFILE
-Make a new file in ~/.local/share/charsel/ with the name that you want to use to call the file in the command
-Fill it in, using the provided example as a template.
+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.
+
+Fill it in, using the provided examples as a template. Hidden shortcuts go above the '---'
--- /dev/null
+A Ä
+O Ö
+U Ü
+S ẞ
+---
+a ä
+o ö
+u ü
+s ß
+
+4 €
--- /dev/null
+A,Α
+B,Β
+G,Γ
+D,Δ
+E,Ε
+Z,Ζ
+H,Η
+TH,Θ
+I,Ι
+K,Κ
+L,Λ
+M,Μ
+N,Ν
+X,Ξ
+OO,Ο
+P,Π
+R,Ρ
+S,Σ
+T,Τ
+U,Υ
+PH,Φ
+CH,Χ
+PS,Ψ
+O,Ω
+---
+a,α
+b,β
+g,γ
+d,δ
+e,ε
+z,ζ
+h,η
+th,θ
+i,ι
+k,κ
+l,λ
+m,μ
+n,ν
+x,ξ
+oo,ο
+p,π
+r,ρ
+s,σ
+t,τ
+u,υ
+ph,φ
+ch,χ
+ps,ψ
+o,ω
-A Ā
-E Ē
-I Ī
-O Ō
-U Ū
-
-a ā
-e ē
-i ī
-o ō
-u ū
-
-
+A,Ā
+E,Ē
+I,Ī
+O,Ō
+U,Ū
+---
+a,ā
+e,ē
+i,ī
+o,ō
+u,ū
--- /dev/null
+A,Ą
+C,Č
+E,Ę
+W,Ė
+I,Į
+S,Š
+U,Ų
+Y,Ų
+Z,Ž
+---
+a,ą
+c,č
+e,ę
+w,ė
+i,į
+s,š
+u,ų
+y,ū
+z,ž
+
+4,€
--- /dev/null
+A,Á
+E,É
+I,Í
+N,Ñ
+O,Ó
+U,Ú,
+Y,Ü,
+---
+a,á
+e,é
+i,í
+o,ó
+u,ú
+y,ü
+n,ñ
+
+/,¿
+1,¡
+4,€
#!/usr/bin/env sh
-
# Merge both global and local charfiles
CHARDIR=/tmp/charsel
-cp /usr/share/charsel/* $CHARDIR
-cp ~/.local/share/charsel/* $CHARDIR
-
-# Check if user provided a charfile
-[ -z "$1" ] && echo "No argument supplied" && exit 1
+cp -R /usr/share/charsel/* $CHARDIR/
+cp -R ~/.local/share/* $CHARDIR/
# Clear screen
clear
+# Check if user provided an input
+[ -z "$1" ] && echo "No argument supplied" && exit
+
+if [ $1 = "list" ]; then
+ echo "The following charfiles are installed"
+ ls $CHARDIR/charfiles
+ exit
+else
+
+# Define charfile
+CHARFILE=$CHARDIR/charfiles/$1
+
+# Define length of shortcut
+LENGTH=$(cat $CHARFILE | cut -f 1 -d ',' -s | wc -L | cut -b 1)
+
+# MOTD
+cat /tmp/charsel/motd
+
+# Main program
while :
do
-
- # Put charfile into table
- column -t $CHARDIR/$1 -N SHORT,CHAR -R SHORT,CHAR --output-separator ' | '
- read -n 1 INPUT
+ # Put charfile into table, showing only the shortcuts below the divider in the charfile
+ cat $CHARFILE | grep -A 100 - | tail -n +2 | column -t --output-separator ' | ' --separator ','
+
+ # Automatically enter input
+ read -N $LENGTH INPUT
# Navigate to the right characther
- OUTPUT=$(grep $INPUT $CHARDIR/$1 | cut -c 3)
+ OUTPUT=$(grep $INPUT $CHARFILE | cut -f 2 -d ',' -s)
# Clear screen
clear
# Copy output to clipboard
echo $OUTPUT | xclip -selection clipboard
done
+
+fi
--- /dev/null
+WELCOME TO CHARSEL!
+FOR HELP, PLEASE REFER TO /usr/share/doc/charsel/README.md
projects / charsel.git / commitdiff