├── .github
└── ISSUE_TEMPLATE.md
├── CHANGELOG
├── COPYING
├── README.mkdn
├── TODO
├── screenfetch-dev
├── screenfetch.1
└── update-manpage.sh
/.github/ISSUE_TEMPLATE.md:
--------------------------------------------------------------------------------
1 |
4 |
5 | **I'm submitting a ...** (check one with "x")
6 | ```
7 | [ ] bug report
8 | [ ] new distro request
9 | ```
10 |
11 | **Bug report**
12 | ```
13 | => search Github for a similar issue or PR before submitting
14 | => download the latest revision from Github and check if the bug is still present
15 | -> https://github.com/KittyKatt/screenFetch/raw/master/screenfetch-dev
16 | => Show us the output of: screenfetch -v
17 | ```
18 |
19 | **New distro request**
20 | ```
21 | Distro name:
22 | Homepage:
23 | Distro logo:
24 | Package manager:
25 |
26 | Show us the output of
27 | => lsb_release -sirc
28 | => cat /etc/os-release
29 | => ls -1 /etc/*-release
30 | ```
31 |
32 |
--------------------------------------------------------------------------------
/CHANGELOG:
--------------------------------------------------------------------------------
1 | **** **** **** ****
2 | screenFetch
3 | changelog
4 | **** **** **** ****
5 |
6 | v3.9.9
7 | - I'm not sure what happened in the last 5 years. Here's a release.
8 | - This will be the last release of screenFetch unless I decide to pick it back up.
9 |
10 | v3.9.1
11 | - Fix GTK3 detection issues
12 | - LXQt proper detection and theme detection
13 | - Updated README to point to new wiki pages
14 | - Some miscellanious awk fixes
15 | - OpenBSD disk fix
16 | - Added EndeavourOS
17 | - MacOS Mojave color detection
18 | - Miscellanious spacing fixes
19 |
20 | v3.9.0
21 | - Lots, don't even try.
22 |
23 | v3.8.0
24 | - Additional Intel GPU checks
25 | - Gentoo release check (whether it's stable/testing/experimental)
26 | - Chromebrew detection for Chrome OS pkgs
27 | - OpenBSD fixes
28 | - Manjaro logo updated
29 | - Added Fux logo
30 | - Enable easily addable custom lines through customlines() function
31 | - Line wrapping with '-w' command line option
32 | - Fix issue with extra space and host variable
33 | - Improvements to OS X font detection
34 | - Fixed package count, shell detection and colors on NetBSD
35 | - Added pkgsrc support for OS X
36 | - Use new NixOS logo
37 | - Use new KaOS logo
38 | - PCLinuxOS logo added
39 | - pomf host removed (does not exist anymore)
40 | - Display the package count, resolution, GPU and OS version on Haiku
41 | - Display release version and package count on TinyCore Linux
42 | - Display exact release version on Windows 10
43 | - Use modern logo on Windows 10 and Windows 8
44 | - Support for Blackbox on Windows
45 | - Improve BusyBox shell detection
46 | - Added detection for Trinity/TWin, chromeos-wm, FLWM, howm, sway, LXQt and Deepin [DEs/WMs]
47 | - Added detection for Alpine, BunsenLabs, Chrome OS, Chromium OS, Devuan, Fux, GrombyangOS, KDE neon, Kogaion, Mer, Msys, Netrunner, Oracle Linux, PCLinuxOS, Qubes OS, Parrot Security, Pardus, Red Star OS, ROSA, SailfishOS, SparkyLinux, SteamOS, SUSE Linux Enterprise and SwagArch
48 |
49 | v3.7.0
50 | - Show RAM in IEC units (MiB instead of MB)
51 | - Count Chocolatey packages in Cygwin if present
52 |
53 | v3.6.8
54 | - Added classic Mac OS logo
55 | - Added generic Unix logo for unknown non-Linux distros
56 | - Added an option to display ASCII distribution logo only
57 | - Fixed total memory detection on OpenBSD
58 | - Fixed package detection in Solus and in apt/dpkg distros
59 | - Fixed xmonad detection
60 | - Added detection for Sabayon, Haiku, Logos, Chapeau, BLAG, Dragora, gNewSense, NixOS, Crux, Lunar and GNU/Hurd (generic)
61 | - Added detection for CDE/dtwm, Lumina and 9wm
62 | - Added ChromeOS logo (without distro detection)
63 | - Use Ubuntu-3color logo by default, remove old yellow logo
64 | - Added an option to supply custom ASCII art
65 | - Combine GTK 2/3 themes if they are the same
66 | - Reimplement '-d' (allows for setting what information is displayed on the command line)
67 |
68 | v3.6.5
69 | - Fixed RAM usage on OS X
70 | - Added old FreeBSD logo
71 | - Added portrait mode output
72 | - Simplify Scientific Linux detection
73 | - Added '--version' command line longoption as an alternative to '-v'
74 | - Added Evolve OS detection
75 | - Added imgur to configured upload hosts
76 | - Fine tuned more of the upload function
77 | v3.6.2
78 | - Added upload support via -u flag
79 | - Added pre-configured hosts for -u uploading: teknik, pomf, hmp, and mediacrush
80 | - Added a configurable section for an scp upload to a specified destination
81 | - Removed -m flag
82 | v3.6.0
83 | - Added PowerPC support for OS X
84 | - Added support for Korora and Void Linux
85 | - Readme: added installation instruction for Debian
86 |
87 | v3.5.0
88 | - update list of supported systems
89 | - Fix Parabola pkg detection.
90 | - Adding support for the echinus (dwm fork) WM.
91 | - Add 2bwm support.
92 | - Various Parabola GNU/Linux-libre aesthetic fixes.
93 | - Adding NetBSD to supported distros in --help.
94 | - Fix OpenBSD total RAM output.
95 | - Un-camelCase the *box WMs, matching the documentation for the *box WMs.
96 | - Added support for Windows 8.1 (Cygwin)
97 | - Removed resolution from screenfetch when resolution cannot be found (Win8.1 cygwin)
98 | - Fix detection of PowerPC G3 to be more exact instead of triggering on UltraSparcs
99 | - Fixing shrx's URL.
100 | - add manpage
101 | - update header license text to GPLv3
102 | - Red Hat Linux -> Red Hat Enterprise Linux
103 | - Fix Parabola in --help.
104 | - improved GPU detection formatting, fixed dual GPU detection formatting
105 | - Fixes for OS X
106 | - Fix Arch Linux detection for updated lsb_release
107 | - Fix for Debian
108 | - Added support for Raspbian, Antergos and KaOS
109 | - Fixes for Cinnamon
110 | - Fix for Android being detected if getprop exists. Disabling Android support until I figure out a better detection method.
111 | - Redirect STDERR to function to make errors prettier.
112 | - Commenting gsettings usage for GTK3 theme detection. Causes glib core dump in some places. Removed until I figure out why.
113 |
114 | v3.2.2
115 | - Adding a 256 support for Ubuntu logo
116 | - gpu_info code is still present but no longer in use
117 | - OSX: Fix X11.app from launching, add Theme Name, GTK fix, fix for Mac's version of sed to fix cpu detection
118 | - Fix for LXDE detection related things.
119 | - Fixes for elementary OS detection.
120 | - Adding Jiyuu Linux detection and ASCII.
121 | - Fix for Funtoo detection and Funtoo-text.
122 |
123 | v3.2.0
124 | - Add Support to Kali Linux.
125 | - Possible fix for distro detection with cases.
126 | - Fixes for CentOS detection.
127 | - Fix for bspwm.
128 | - Removing disk from DISPLAY.
129 | - Fixes for Mutter/GNOME Shell
130 | - Fixing spacing issues in new eOS ASCII.
131 |
132 | v3.1.0
133 | - Fixing some stuff for FreeBSD GPU detection.
134 | - Add alternate Manjaro art. Use with -A 'Manjaro-tree'.
135 | - Fixed funtoo detection
136 | - Added Sabayon
137 | - Tweaked Fedora art
138 | - Adding Notion WM to detected window managers
139 | - Adding GPU detection to display and Cygwin GPU detection
140 | - Color centralization. All logos and labels use color aliases now (i.e. blue/light blue).
141 | - Fix for verbose output with error suppressing (-E).
142 | - Fix for *BSD detectdisk.
143 | - Fixing a problem with _net_wm_name
144 | - Fix for elementary OS detection
145 | - Fix for the BASH pre 4.0-ish lower-to-upper in WM detection.
146 |
147 | v3.0.5
148 | - OS X GPU detection added.
149 | - Fix for -n.
150 | - FreeBSD portmaster support for pkg detection.
151 | - Switching to printf in various places. Part of a big printf move.
152 | - Removal of -e and theme exporting.
153 | - detectdisk added.
154 | - Fix for WM detection in OS X.
155 |
156 |
157 | v3.0.0
158 | - Colors bugfixes/changes.
159 | - -l disabled FOREVER.
160 | - Various *BSD bugfixes.
161 | - Funtoo detection added.
162 | - -c now allows 256 colors.
163 | - Fix Scientific Linux detection.
164 | - Moving of functions for cleanup.
165 | - Added -d back in for now.
166 | - OS X bugfixes.
167 | - WM non-case-sensitive now.
168 | - ppc cpu detection fixes.
169 |
170 |
171 | v2.9.0
172 | - Started work on re-adding Cygwin detection.
173 | - Cleaning up above.
174 | - Cygwin logo fixed.
175 | - Many Cygwin bugfixes/additions.
176 |
177 |
178 | v2.8.4
179 | - GTK detection bugfixes.
180 | - Cygwin logo changed.
181 | - E17 detection added.
182 | - Updated --help.
183 | - BackTrack Linux detection added.
184 | - OpenBSD shell detection fix.
185 | - *BSD bugfixes.
186 | - Fixes for cpu speed detection.
187 | - Changed Android logo.
188 | - Changed CrunchBang logo.
189 | - Added -N to strip all colors.
190 | - Actually added --help. -h still works.
191 | - Sabayon Linux detection added.
192 | - GPU detection added (Very Experimental!!!)
193 | - Many tweaks on above.
194 | - Adding -E to suppress all errors (STDERR).
195 |
196 |
197 | v2.8.1
198 | - *BSD shell detection fix.
199 | - Unity detection added.
200 | - Experimental Android support.
201 | - Various WM/DE bugfixes.
202 | - Closing up outstanding issues/pulls.
203 | - If "Not Found", continue. Do Not Display.
204 | - Scientific Linux detection added.
205 | - Manjaro logo changed.
206 |
207 |
208 | v2.7.7
209 | - KWin detection fixes.
210 | - KDE detection fixes.
211 | - Manjaro Linux ASCII changed.
212 | - Attempts at automated truncating.
213 | - Organization of WM names in functions.
214 | - Compiz detection fixes.
215 | - CrunchBang Waldorf detection fix.
216 | - Shell version detection. Also, SHELL DETECTION.
217 | - Formatting fixes.
218 | - Basic razorqt detection.
219 | - Fixing RHEL detection.
220 | - No displaying of X-dependent info if X isn't found to be running.
221 | - Remove -l flag.
222 | - Lotsa OS X detection bugfixes.
223 | - FluxBox detection fix.
224 | - FreeBSD uptime bugfix.
225 |
226 |
227 | v2.7.5
228 | - Adding Cinnamon detection.
229 | - Updated README for how to.
230 | - *BSD memory detection bugfixes.
231 | - Other miscellanious *BSD bugfixes.
232 | - Optimizations and code cleanup.
233 | - README changes.
234 | - gsettings detection fix.
235 | - RHEL detection fix.
236 | - /etc/os-release detection fix.
237 | - BASH optimizations.
238 | - Huge detectdistro overhaul.
239 | - More tweaks on above.
240 | - detectgtk optimization/cleanup/fixes.
241 |
242 |
243 | v2.5.5
244 | - herbstluftwm detection.
245 | - Added Manjaro Linux detection.
246 | - NetBSD detection and fixes.
247 | - Cleanup and fixes for DE detection.
248 |
249 |
250 | v2.5.3 (lots of stuff)
251 | - GTK3 bugfixes.
252 | - Fuduntu detection added.
253 | - OS X memory bugfixes.
254 | - Fragmented BSD flavors like they should be.
255 | - FreeBSD bugfixes.
256 | - Added DragonFlyBSD detection.
257 | - xmonad detection bugfix.
258 | - Fix CrunchBang detection.
259 | - Add Trisquel detectin.
260 |
261 |
262 | v2.5.0
263 | - Mac OS X detection added.
264 | - Lots of tweaking on OS X detection.
265 | - Fixes for distro detection.
266 | - Change for BSD logo.
267 | - Script now exits with 0 status.
268 | - macports and homebrew detection for OS X.
269 | - Experimental Cygwin detection. Commented out until cleaned.
270 |
271 |
272 | v2.4.7
273 | - KWin detection bugfixes.
274 | - Fixed non-ascii output.
275 | - Fix for Frugalware pkg detection.
276 | - Fix Gentoo detection.
277 | - Proper GTK3 detection for GNOME.
278 | - DE detection cleanup.
279 | - GNOME Shell detection.
280 | - Various code cleanups.
281 |
282 |
283 | v2.4.5
284 | - Added Chakra detection.
285 | - GTK detection bugfixes.
286 | - Experimental GTK3 detection.
287 |
288 |
289 | v2.4.4
290 | - SpectrWM added. Kept old ScrotWM for legacy.
291 | - Colors bugfixes.
292 | - Fixed LinuxDeepin and Parabola detection/logos.
293 |
294 |
295 | v2.4.3
296 | - Woo! Colors! Define colors with -c.
297 |
298 |
299 | v2.4.2
300 | - Added Viperr detection.
301 | - Added LinuxDeepin detection.
302 |
303 |
304 | v2.4.1
305 | - Spacing fixes
306 | - Added ParabolaGNU detection.
307 | - Fixed list of supported distributions in --help.
308 |
309 |
310 | v2.4.0
311 | - New SolusOS logo and fixed detection
312 | - Added CPU detection.
313 | - Added Memory detection.
314 | - Added Package Count detection (only working on Arch and SolusOS).
315 |
316 |
317 | v2.3.9
318 | - Fixed SolusOS detection.
319 | - Added MATE detection, theme detection possibly not working yet. Fixed WindowMaker detection.
320 | - Getting a DEB out! \o/
321 |
322 | v2.3.8
323 | - Adding tentative dminiwm support.
324 | - net-tools deprecated. Relying on /proc/sys/kernel/hostname from now on.
325 | - Adding tentative monsterwm support.
326 | - Fixing openSUSE detection
327 |
328 | v2.3.7
329 | - Correctly tabulated and added Mageia distro detection and ASCII.
330 | - Adding tentative SolusOS detection via /etc/issue
331 | - Adding SolusOS logo and colors.
332 |
333 | v2.3.6
334 | - Adding tentative PeppermintOS detection.
335 | - A couple of attempted KDE/KWin fixes.
336 | - Fixed /etc/os-release detection
337 | - Updating Frugalware detection with /etc/os-release.
338 |
339 | v2.3.5
340 | - Adding tentative Frugalware detection.
341 | - Adding 256 color support.
342 | - suse and version fix
343 | - Fixed a couple logo spacing issues. Added spaceing insensitivity to the -D flag.
344 | - Added / fixed LXDE support.
345 |
346 | v2.3.4
347 | - Fixed an error causing stuff to not be detected.
348 | - e17 support
349 | - Several other fixes an revertions
350 |
351 | v2.3.2
352 | - Adding new Slackware ASCII art and detection.
353 |
354 | v2.3.1
355 | - Fixing 'n/a' displaying of release/codename in my_distro.
356 |
357 | v2.3.0
358 | - Added SuSe detection and made an ASCII logo for it.
359 |
360 | v2.2.9
361 | - Attempting to fix DE detection with new GDM3
362 |
363 | v2.2.8
364 | - Fixing some quotes errors and LMDE detection.
365 |
366 | v2.2.7
367 | - Fixed a few space errors in Debian logo and added new LMDE logo.
368 | - Removing official Compiz support. That should straighten a few things out.
369 |
370 | v2.2.4
371 | - Temporarily re-enabling bg support via -B flag.
372 |
373 | v2.2.3
374 | - Removing showing background by default by request.
375 | - Correction in WM name (subtle)
376 |
377 | v2.2.1
378 | - Added a couple of WMs: subtle, e16, and sawfish
379 |
380 | v2.2.0
381 | - Deleted extra ASCII stuff and completely rewrote output stuff.
382 |
383 | v2.1.7
384 | - Added a few changes and lsb_release support.
385 |
386 | v2.1.5
387 | - Fixed multi-monitor resolution detection and modified default screenshot filename.
388 | - Lots of capitalization errors in WM detection were brought to my attention. Fixed.
389 | - Attempting to fix detection of Crunchbang Statler.
390 |
391 | v2.1.4
392 | - Commented out the DISPLAY setting on commandline until its stable.
393 |
394 | v2.1.3 (HOLY SHIT BIG CHANGES)
395 | - Added shitload of new features. Keep reading.
396 | - Added function to set script variables on commandline execution. (i.e. screenfetch-dev -o 'baseurl="http://www.example.com"')
397 | - Added function to set display info on commandline execution. (i.i. screenfetch-dev -d 'Host, OS, Kernel, Uptime, Theme, Icons')
398 | - Added function to export theme if wanted upon execution. Currently only supports the following window managers: PekWM, OpenBox, BlackBox, FluxBox, Metacity (kind of), Xfwm4 (kind of). This is a really big addition, and quite experimental. Things that are currently sought out and exported are the following: GTK Theme Folder, Icon Theme Folder, WM Theme Folder, Background Image, and screenshot taken by screenfetch. If you would like anything else exported with this let me know and I'll see what I can do.
399 | - Added function to upload screenshot taken to server you have ssh access on after info is displayed. MUST set baseurl, serveraddr, and serverdir variables for this to work. See -o flag.
400 | - Added new support for detecting the following window managers: Musca, i3, Ratpoison, wmii, Wmfs, ScrotWM, and Beryl.
401 | - Attempted to fix XFCE detection by limiting the processes that result in XFCE to only "xfce4-desktop". Dunno if this will work or not. Email me.
402 | - Added function to detect hostname and user. Displayed in info output.
403 | - Added function to detect resolution. Displayed in info output. Untested, and possibly not working, on multiple monitor setups. Email me.
404 | - Added function to detect working shell. Might also add function to detect terminal type in the future.
405 | - Fixed bug in GNOME background output. Was outputing entire pathname. Now only outputs the filename of the image.
406 | - Replaced old Arch Linux logo with new updated one. Don't really like the new one, but it was popular demand. Old one is still available through -D with the 'Arch Linux - Old' argument for those of us that are old school.
407 |
408 | v2.0.3
409 | - Adding XMonad detection.
410 |
411 | v2.0.1
412 | - Fixing some spelling errors and added a few minor things.
413 | - Experimental truncating based upon terminal width.
414 | - Changed default Arch Linux ASCII logo due to popular demand. Old one is still available.
415 |
416 | v1.8.4
417 | - Added experimental Compiz detection (WM and theme)
418 | - Added experimental StumpWM detection (Just WM). Thanks to gtklocker for this part.
419 |
420 |
421 | v1.8.3
422 | - Added the groundwork for background support, terminal width detection (and thus truncating upon being over this width), and a couple other things I can't remember at the moment.
423 | - Gonna update a couple of the ASCII arts. :D
424 |
425 |
426 | v1.7.9
427 | - Added support to DETECT the following window managers: dwm, awesome, and WindowMaker
428 | - Added support for lighter backgrounds. If you have a lighter background, specify -l as a flag on the command-line. This will turn all white output to dark gray output.
429 | - screenFetch was featured in the ALM (Arch Linux Magazine)! The issue can be found and downloaded at http://www.archlinux.org/static/magazine/2010/ALM-2010-Apr.pdf
430 |
431 |
432 | v1.7.7
433 | - Added FVWM support per request of goran'agar on the Arch forums.
434 |
435 |
436 | v1.7.6.5
437 | - Fixed broken -s flag to take screenshot.
438 | - Put calling for verbose function back into other functions.
439 |
440 |
441 | v1.7.6 (important)
442 | - Working distribution detection! Most of the distributions I've included have been untested as of yet. Which means I could REALLY use some testers for these distros. The ones that still need testing are as follows: SUSE, Mandriva/Mandrake, Gentoo, Fedora, Red Hat Linux, and BSD. If you would like to help test these distributions, let me know by emailing me at kittykatt@archlinux.us
443 | - Reworked a lot of the code to be functions instead of repeating parts. Looks a lot cleaner now.
444 | - This update was mainly Kingdomcome's doing. So thank him profusely.
445 |
446 |
447 | v1.7.5 (HUGE)
448 | - Massive rewrite, cleaning up a huge portion of the code.
449 | - Made several repeating parts of the code into functions.
450 | - Learned getopts. Rewrote flag support with it. Flags now supported are as follows:
451 | ~ -D 'DISTRO NAME' Specify distribution name
452 | ~ -c 'command' Specify custom screenshot command.
453 | ~ -V Print current version of script.
454 | ~ -v Turn on verbose output.
455 | ~ -s Take screenshot.
456 | ~ -n Display info only and no ASCII logo.
457 | ~ -h Display help menu.
458 | - Added version number to DE reporting. Except LXDE. Because they fail.
459 | - Thanks to h2 for many, many, many suggestions and a lot of help. This update would most likely not have been possible without him.
460 |
461 |
462 | v1.4.5
463 | - Cleaned up WM Theme detection code.
464 |
465 |
466 | v1.4.4
467 | - Changed version system
468 | - Fixed if statement for "Not Present" or "LXDE" DE (Thanks to ArcherSeven for pointing it out)
469 |
470 |
471 | v1.4.3 (big)
472 | - Complete rewrite of DE and WM detection (Once again thanks to King)
473 | - Implemented LXDE support (Yay!)
474 | - Discussed ideas for "united" DE detection
475 |
476 |
477 | v1.4
478 | - Complete rewrite of the uptime field (Thanks a bunch Kingdomcome)
479 |
480 |
481 | v1.3
482 | - Added some flag support (notably --version, --screen, and --help)
483 | - Added commented lines for --distro and --command flags (future use)
484 | - Fixed another color escape sequence.
485 |
486 |
487 | v1.2
488 | - Fixed uptime errors when uptime > 1 day
489 |
490 |
491 | v1.1
492 | - Fixed color closing in the generic tux ASCII logo (thanks Suhana)
493 | - Changed architecture detection to "uname -m" across the board (thanks ikey for that one)
494 |
495 |
496 | v1.0
497 | - First version. Let's start! :D
498 |
--------------------------------------------------------------------------------
/COPYING:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.mkdn:
--------------------------------------------------------------------------------
1 |
2 | # screenFetch - The Bash Screenshot Information Tool
3 |
4 | ## Important!
5 |
6 | Please see [this discussion](https://github.com/KittyKatt/screenFetch/discussions/805) on the current state of screenFetch.
7 |
8 | ## What is screenFetch?
9 |
10 | screenFetch is a "Bash Screenshot Information Tool". This handy Bash
11 | script can be used to generate one of those nifty terminal theme
12 | information + ASCII distribution logos you see in everyone's screenshots
13 | nowadays. It will auto-detect your distribution and display an ASCII
14 | version of that distribution's logo and some valuable information to the
15 | right. There are options to specify no ASCII art, colors, taking a
16 | screenshot upon displaying info, and even customizing the screenshot
17 | command! This script is very easy to add to and can easily be extended.
18 |
19 | ## How do I get screenFetch?
20 |
21 | Please see [Installation](https://github.com/KittyKatt/screenFetch/wiki/Installation).
22 |
23 | ## Running screenfetch
24 |
25 | To run screenFetch, open a terminal of some sort and type in the command `screenfetch`
26 | or wherever you saved the script to. This will generate an ASCII logo with the
27 | information printed to the side of the logo. There are some options that may be
28 | specified on the command line, and those are shown below or by executing `screenfetch -h`:
29 |
30 | -v Verbose output.
31 | -o 'OPTIONS' Allows for setting script variables on the
32 | command line. Must be in the following format...
33 | 'OPTION1="OPTIONARG1";OPTION2="OPTIONARG2"'
34 | -d '+var;-var;var' Allows for setting what information is displayed
35 | on the command line. You can add displays with +var,var. You
36 | can delete displays with -var,var. Setting without + or - will
37 | set display to that explicit combination. Add and delete statements
38 | may be used in conjunction by placing a ; between them as so:
39 | +var,var,var;-var,var.
40 | -n Do not display ASCII distribution logo.
41 | -N Strip all color from output.
42 | -w Wrap long lines.
43 | -t Truncate output based on terminal width (Experimental!).
44 | -p Output in portrait mode, with logo above info.
45 | -s [-u IMGHOST] Using this flag tells the script that you want it
46 | to take a screenshot. Use the -m flag if you would like
47 | to move it to a new location afterwards.
48 | -c string You may change the outputted colors with -c. The format is
49 | as follows: [0-9][0-9],[0-9][0-9]. The first argument controls the
50 | ASCII logo colors and the label colors. The second argument
51 | controls the colors of the information found. One argument may be
52 | used without the other.
53 | -a 'PATH' You can specify a custom ASCII art by passing the path
54 | to a Bash script, defining `startline` and `fulloutput`
55 | variables, and optionally `labelcolor` and `textcolor`.
56 | See the `asciiText` function in the source code for more
57 | information on the variables format.
58 | -S 'COMMAND' Here you can specify a custom screenshot command for
59 | the script to execute. Surrounding quotes are required.
60 | -D 'DISTRO' Here you can specify your distribution for the script
61 | to use. Surrounding quotes are required.
62 | -A 'DISTRO' Here you can specify the distribution art that you want
63 | displayed. This is for when you want your distro
64 | detected but want to display a different logo.
65 | -E Suppress output of errors.
66 | -C Add custom (extra) lines.
67 | For example:
68 | screenfetch -C 'IP WAN=192.168.0.12,IP BRIDGED=10.1.1.10'
69 | ... will add two extra lines:
70 | IP WAN: 192.168.0.12
71 | IP BRIDGED: 10.1.1.10
72 | -V, --version Display current script version.
73 | -h, --help Display this help.
74 |
75 | ## Contact Me
76 |
77 | If you would like to suggest something new, inform me of an issue in the
78 | script, become part of the project, or talk to me about anything else,
79 | you can either email me at `screenfetch@kittykatt.co` or you can connect
80 | to Rizon and reach me at `irc://irc.rizon.net/screenFetch`
81 |
--------------------------------------------------------------------------------
/TODO:
--------------------------------------------------------------------------------
1 | **##** *#* TO DO LIST *#* **##**
2 |
3 | This small list will be the central place where I will list ideas and
4 | things I want to happen with screenFetch.
5 |
6 | Obvious Things:
7 |
8 | 1) Add any and all suggested WMs.
9 | 2) More distros! Suggest them and I'll add them. Or I'll add them as I find them.
10 |
11 | Other Things:
12 |
13 | 1) Better GTK3 detection. Fix for gsettings stuff.
14 | 2) Better -c. Support setting of all available colors in an ascii logo.
15 | 3) Centralized color setting. c{1,2,3,etc} and lablecolors all set in one place.
16 | 4) Better disk detection. Fix problems with it.
17 | 5) Cleanup detectuptime, detectcpu, *
18 | 6) Custom logos file. Source logos file with -C flag is present. -A will act normally
19 | if -C is present as well.
20 |
21 | That's about it for now. If you can help with any of these, please
22 | please PLEASE let me know by emailing me at kittykatt@kittykatt.us or by
23 | stopping by SilverIRC on your favorite IRC client. The network can be
24 | accessed by pointing your IRC client to kittykatt.silverirc.com. #me0wz
25 | is my home channel. If you don't have an IRC client, head on over to
26 | http://www.silverirc.com/index.php?page=chat and that'll join
27 | you to #randomz, where I can be reached as well.
28 |
29 | Thank you for any help.
30 |
31 | ~KittyKatt (Brett Bohnenkamper)
32 |
--------------------------------------------------------------------------------
/screenfetch.1:
--------------------------------------------------------------------------------
1 | .TH SCREENFETCH "1" "Juni 2018" "3.9.9" "User Commands"
2 | .\" Don't remove the lines starting with ».\" @supported_« !
3 | .\" They're important for update-manpage.sh.
4 |
5 | .SH NAME
6 | screenFetch \- The Bash Screenshot Information Tool
7 |
8 | .SH SYNOPSIS
9 | .B screenfetch \fR[OPTIONAL FLAGS]
10 |
11 | .SH DESCRIPTION
12 | This handy Bash script can be used to generate one of those
13 | nifty terminal theme information + ASCII distribution logos you
14 | see in everyone's screenshots nowadays. It will auto-detect your
15 | distribution and display an ASCII version of that distribution's
16 | logo and some valuable information to the right. There are options
17 | to specify no ASCII art, colors, taking a screenshot upon displaying
18 | info, and even customizing the screenshot command!
19 | This script is very easy to add to and can easily be extended.
20 | .PP
21 | Supported GNU/Linux Distributions:
22 | .IP
23 | .\" @supported_distros_start@
24 | ALDOS, Alpine Linux, Amazon Linux, Antergos, Arch Linux (Old and Current Logos), Artix Linux, blackPanther OS, BLAG, BunsenLabs, CentOS, Chakra, Chapeau, Chrome OS, Chromium OS, CrunchBang, CRUX, Debian, Deepin, DesaOS, Devuan, Dragora, elementary OS, Evolve OS, Exherbo, Fedora, Frugalware, Fuduntu, Funtoo, Fux, Gentoo, gNewSense, Guix System, Hyperbola GNU/Linux-libre, Jiyuu Linux, Kali Linux, KaOS, KDE neon, Kogaion, Korora, LinuxDeepin, Linux Mint, LMDE, Logos, Mageia, Mandriva/Mandrake, Manjaro, Mer, Netrunner, NixOS, OBRevenge, openSUSE, OS Elbrus, Oracle Linux, Parabola GNU/Linux-libre, Pardus, Parrot Security, PCLinuxOS, PeppermintOS, Proxmox VE, PureOS, Qubes OS, Raspbian, Red Hat Enterprise Linux, ROSA, Sabayon, SailfishOS, Scientific Linux, Siduction, Slackware, Solus, Source Mage GNU/Linux, SparkyLinux, SteamOS, SUSE Linux Enterprise, SwagArch, TeArch, TinyCore, Trisquel, Ubuntu, Viperr, Void and Zorin OS.
25 | .\" @supported_distros_end@
26 | .PP
27 | Other Supported Systems:
28 | .IP
29 | .\" @supported_other_start@
30 | Dragonfly/Free/Open/Net BSD, Haiku, Mac OS X, Windows+Cygwin and Windows+MSYS2.
31 | .\" @supported_other_end@
32 | .PP
33 | Supported Desktop Managers:
34 | .IP
35 | .\" @supported_dms_start@
36 | KDE, GNOME, Unity, Xfce, LXDE, Cinnamon, MATE, Deepin, CDE, RazorQt and Trinity.
37 | .\" @supported_dms_end@
38 | .PP
39 | Supported Window Managers:
40 | .IP
41 | .\" @supported_wms_start@
42 | 2bwm, 9wm, Awesome, Beryl, Blackbox, Cinnamon, chromeos-wm, Compiz, deepin-wm, dminiwm, dwm, dtwm, E16, E17, echinus, Emerald, FluxBox, FLWM, FVWM, herbstluftwm, howm, IceWM, KWin, Metacity, monsterwm, Musca, Gala, Mutter, Muffin, Notion, OpenBox, PekWM, Ratpoison, Sawfish, ScrotWM, SpectrWM, StumpWM, subtle, sway, TWin, WindowMaker, WMFS, wmii, Xfwm4, XMonad and i3.
43 | .\" @supported_wms_end@
44 |
45 | .SH OPTIONS
46 | .TP
47 | .B \-v
48 | Verbose output.
49 | .TP
50 | .B \-o 'OPTIONS'
51 | Allows for setting script variables on the
52 | command line. Must be in the following format:
53 | \&'OPTION1="OPTIONARG1";OPTION2="OPTIONARG2"'
54 | .TP
55 | .B -d '+var;-var;var'
56 | Allows for setting what information is displayed on the command line. You can
57 | add displays with +var,var. You can delete displays with -var,var. Setting
58 | without + or - will set display to that explicit combination. Add and delete
59 | statements may be used in conjunction by placing a ; between them as so:
60 | +var,var,var;-var,var.
61 | .TP
62 | .B \-n
63 | Do not display ASCII distribution logo.
64 | .TP
65 | .B \-L
66 | Display ASCII distribution logo only.
67 | .TP
68 | .B \-N
69 | Strip all color from output.
70 | .TP
71 | .B \-w
72 | Wrap long lines.
73 | .TP
74 | .B \-t
75 | Truncate output based on terminal width (Experimental!).
76 | .TP
77 | .B \-p
78 | Output in portrait mode, with logo above info.
79 | .TP
80 | .B \-s [-u IMGHOST]
81 | Using this flag tells the script that you want it
82 | to take a screenshot. Use the \fB\-u\fR flag if you would like
83 | to upload the screenshots to one of the pre-configured
84 | locations. These include: teknik, imgur, mediacrush and hmp.
85 | .TP
86 | .B \-c string
87 | You may change the outputted colors with \fB\-c\fR. The format is
88 | as follows: [0\-9][0\-9],[0\-9][0\-9]. The first argument controls the
89 | ASCII logo colors and the label colors. The second argument
90 | controls the colors of the information found. One argument may be
91 | used without the other.
92 | .TP
93 | .B \-a 'PATH'
94 | You can specify a custom ASCII art by passing the path to a Bash script,
95 | defining \fBstartline\fR and \fBfulloutput\fR variables, and optionally
96 | \fBlabelcolor\fR and \fBtextcolor\fR. See the \fBasciiText\fR function
97 | in the source code for more information on the variables format.
98 | .TP
99 | .B \-S 'COMMAND'
100 | Here you can specify a custom screenshot command for
101 | the script to execute. Surrounding quotes are required.
102 | .TP
103 | .B \-D 'DISTRO'
104 | Here you can specify your distribution for the script
105 | to use. Surrounding quotes are required.
106 | .TP
107 | .B \-A 'DISTRO'
108 | Here you can specify the distribution art that you want
109 | displayed. This is for when you want your distro
110 | detected but want to display a different logo.
111 | .TP
112 | .B \-E
113 | Suppress output of errors.
114 | .TP
115 | .B \-V, \-\-version
116 | Display current script version.
117 | .TP
118 | .B \-h, \-\-help
119 | Display this help.
120 |
121 | .SH "SEE ALSO"
122 | http://github.com/KittyKatt/screenFetch
123 |
124 | .SH AUTHOR
125 | Created by and licensed to Brett Bohnenkamper .
126 | OS X porting done almost solely by shrx and John D. Duncan, III .
127 | .PP
128 | This manual page was written by djcj
129 |
130 | .SH REPORTING BUGS
131 | Report bugs to
132 |
133 | .SH COPYRIGHT
134 | This is free software; you can redistribute it and/or modify
135 | it under the terms of the GNU GPL version 3 or (at your option) any later version.
136 | There is NO warranty; not even MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
137 |
--------------------------------------------------------------------------------
/update-manpage.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | LANG=C
4 | LANGUAGE=C
5 | LC_ALL=C
6 |
7 | man=screenfetch.1
8 | script=screenfetch-dev
9 |
10 | version=$(grep 'scriptVersion=' $script | cut -d'"' -f2)
11 | date=$(date +"%B %Y")
12 |
13 | mv $man $man.old
14 |
15 | echo ".TH SCREENFETCH \"1\" \"$date\" \"$version\" \"User Commands\"" > $man
16 | grep -v -e '^.TH ' $man.old >> $man
17 |
18 | for s in supported_distros supported_other supported_dms supported_wms ; do
19 | sed -i "/@${s}_start@/,/@${s}_end@/{/@${s}_start@/!{/@${s}_end@/!d}}" $man
20 | list="$(sed -e :a -e '/\\$/N; s/\\\n//; ta' $script | grep "${s}=" | cut -d'"' -f2)"
21 | sed -i "s:@${s}_start@:@${s}_start@\n${list}:" $man
22 | done
23 |
24 |
--------------------------------------------------------------------------------