README.mkdn
1
2# screenFetch - The Bash Screenshot Information Tool
3
4## What is screenFetch?
5
6screenFetch is a "Bash Screenshot Information Tool". This handy Bash
7script can be used to generate one of those nifty terminal theme
8information + ASCII distribution logos you see in everyone's screenshots
9nowadays. It will auto-detect your distribution and display an ASCII
10version of that distribution's logo and some valuable information to the
11right. There are options to specify no ASCII art, colors, taking a
12screenshot upon displaying info, and even customizing the screenshot
13command! This script is very easy to add to and can easily be extended.
14
15## How do I get screenFetch?
16
17Please see [Installation](https://github.com/KittyKatt/screenFetch/wiki/Installation).
18
19## Running screenfetch
20
21To run screenFetch, open a terminal of some sort and type in the command `screenfetch`
22or wherever you saved the script to. This will generate an ASCII logo with the
23information printed to the side of the logo. There are some options that may be
24specified on the command line, and those are shown below or by executing `screenfetch -h`:
25
26 -v Verbose output.
27 -o 'OPTIONS' Allows for setting script variables on the
28 command line. Must be in the following format...
29 'OPTION1="OPTIONARG1";OPTION2="OPTIONARG2"'
30 -d '+var;-var;var' Allows for setting what information is displayed
31 on the command line. You can add displays with +var,var. You
32 can delete displays with -var,var. Setting without + or - will
33 set display to that explicit combination. Add and delete statements
34 may be used in conjunction by placing a ; between them as so:
35 +var,var,var;-var,var.
36 -n Do not display ASCII distribution logo.
37 -N Strip all color from output.
38 -w Wrap long lines.
39 -t Truncate output based on terminal width (Experimental!).
40 -p Output in portrait mode, with logo above info.
41 -s [-u IMGHOST] Using this flag tells the script that you want it
42 to take a screenshot. Use the -m flag if you would like
43 to move it to a new location afterwards.
44 -c string You may change the outputted colors with -c. The format is
45 as follows: [0-9][0-9],[0-9][0-9]. The first argument controls the
46 ASCII logo colors and the label colors. The second argument
47 controls the colors of the information found. One argument may be
48 used without the other.
49 -a 'PATH' You can specify a custom ASCII art by passing the path
50 to a Bash script, defining `startline` and `fulloutput`
51 variables, and optionally `labelcolor` and `textcolor`.
52 See the `asciiText` function in the source code for more
53 information on the variables format.
54 -S 'COMMAND' Here you can specify a custom screenshot command for
55 the script to execute. Surrounding quotes are required.
56 -D 'DISTRO' Here you can specify your distribution for the script
57 to use. Surrounding quotes are required.
58 -A 'DISTRO' Here you can specify the distribution art that you want
59 displayed. This is for when you want your distro
60 detected but want to display a different logo.
61 -E Suppress output of errors.
62 -C Add custom (extra) lines.
63 For example:
64 screenfetch -C 'IP WAN=192.168.0.12,IP BRIDGED=10.1.1.10'
65 ... will add two extra lines:
66 IP WAN: 192.168.0.12
67 IP BRIDGED: 10.1.1.10
68 -V, --version Display current script version.
69 -h, --help Display this help.
70
71## Contact Me
72
73If you would like to suggest something new, inform me of an issue in the
74script, become part of the project, or talk to me about anything else,
75you can either email me at `screenfetch@kittykatt.co` or you can connect
76to Rizon and reach me at `irc://irc.rizon.net/screenFetch`
77