Showing
1 changed file
with
63 additions
and
0 deletions
1 | +# shell-tools | ||
2 | + | ||
1 | A collection of shell functions and tools I am using. | 3 | A collection of shell functions and tools I am using. |
4 | + | ||
5 | +## Synopsis | ||
6 | + | ||
7 | +Put the files under a directory in your ``${HOME}`` e.g. ``${HOME}/scripts``. | ||
8 | +Then add in your shell profile the following lines: | ||
9 | + | ||
10 | + . ${HOME}/scripts/init/tmp.sh | ||
11 | + . ${HOME}/scripts/init/keymanagement.sh | ||
12 | + . ${HOME}/scripts/init/tools.sh | ||
13 | + . ${HOME}/scripts/init/vcs.sh | ||
14 | + | ||
15 | + ssh-init-agent | ||
16 | + gpg-init-agent | ||
17 | + | ||
18 | +## Description | ||
19 | + | ||
20 | +After you added the lines above and source your shell profile you got a whole | ||
21 | +bunch of shell functions for various tasks. | ||
22 | + | ||
23 | +Well, the ssh and gpg keys need to be in a valid place and there are also | ||
24 | +other requirements. | ||
25 | + | ||
26 | +**TODO** Write a description for all and everything... | ||
27 | + | ||
28 | +## Requirements | ||
29 | + | ||
30 | + * Tested with bash but might work with other shells as well. | ||
31 | + | ||
32 | +## Dependencies | ||
33 | + | ||
34 | +The is a huge list of dependencies. Some that come in my mind are: | ||
35 | + | ||
36 | + * GnuPG | ||
37 | + * OpenSSH | ||
38 | + * ImageMagick | ||
39 | + * GnuCal | ||
40 | + * Conky | ||
41 | + * most likely lots of others... | ||
42 | + | ||
43 | +## Contributing | ||
44 | + | ||
45 | +Just write me an email. | ||
46 | + | ||
47 | +## License | ||
48 | + | ||
49 | + This program is free software: you can redistribute it and/or modify | ||
50 | + it under the terms of the GNU General Public License as published by | ||
51 | + the Free Software Foundation, either version 3 of the License, or | ||
52 | + (at your option) any later version. | ||
53 | + | ||
54 | + This program is distributed in the hope that it will be useful, | ||
55 | + but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
56 | + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
57 | + GNU General Public License for more details. | ||
58 | + | ||
59 | + You should have received a copy of the GNU General Public License | ||
60 | + along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
61 | + | ||
62 | +## Author | ||
63 | + | ||
64 | +Georg Hopp <georg@steffers.org> |
Please
register
or
login
to post a comment