Fix possible resource leak
[claws.git] / tools / bash_completion / README
1 Bash Programmable Completion for Claws Mail
2 -------------------------------------------
3
4 This directory contains a script which provides argument completion
5 when using Claws Mail from the command line under the bash shell.
6 This is usually triggered by pressing the tab key (↹).
7
8 See bash manual (https://www.gnu.org/software/bash/manual/) for more
9 details about programmable completion.
10
11 Usage
12 -----
13
14 Examples below assume current directory is the toplevel directory of
15 either an extracted tarball or a git clone.
16
17 Single user
18 ----------
19
20 For a single user just make a directory (e.g. '.bash_completion.d')
21 on your $HOME directory and copy the completion script there:
22
23 $ mkdir ~/.bash_completion.d
24 $ cp tools/bash_completion/claws-mail ~/.bash_completion.d/
25
26 Then, source the script to enable it:
27
28 $ . ~/.bash_completion.d/claws-mail
29
30 To enable it permanently just add the command to the user's bashrc:
31
32 $ echo '. ~/.bash_completion.d/claws-mail' >> $HOME/.bashrc
33
34 All users
35 ---------
36
37 For system wide installation just copy the file to the system directory,
38 which is usually located in /etc (you need to become root for that):
39
40 $ sudo cp tools/bash_completion/claws-mail /etc/bash_completion.d/
41
42 After login in again all users should be able to use completion.