diff --git a/README.md b/README.md index 96f17d7..45d36c5 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ # cool-retro-term +|> Default Amber|C:\ IBM DOS|$ Default Green| +|---|---|---| +|![Default Amber Cool Retro Term](https://user-images.githubusercontent.com/121322/32070717-16708784-ba42-11e7-8572-a8fcc10d7f7d.gif)|![IBM DOS](https://user-images.githubusercontent.com/121322/32070716-16567e5c-ba42-11e7-9e64-ba96dfe9b64d.gif)|![Default Green Cool Retro Term](https://user-images.githubusercontent.com/121322/32070715-163a1c94-ba42-11e7-80bb-41fbf10fc634.gif)| + ## Description cool-retro-term is a terminal emulator which mimics the look and feel of the old cathode tube screens. It has been designed to be eye-candy, customizable, and reasonably lightweight. It uses the QML port of qtermwidget (Konsole) developed by me: https://github.com/Swordfish90/qmltermwidget . -This terminal emulator works under Linux and OSX and requires Qt 5.2 or higher. +This terminal emulator works under Linux and macOS and requires Qt 5.2 or higher. ## Screenshots ![Image]() @@ -16,7 +20,9 @@ This terminal emulator works under Linux and OSX and requires Qt 5.2 or higher. ## Get cool-retro-term You can either build cool-retro-term yourself (see below) or walk the easy way and install one of these packages: -Users of Fedora and openSUSE can grab a package from [Open Build Service](http://software.opensuse.org/package/cool-retro-term). +Fedora has the `cool-retro-term` in the offcial repositories. All you have to do is `sudo dnf install cool-retro-term`. + +Users of openSUSE can grab a package from [Open Build Service](http://software.opensuse.org/package/cool-retro-term). Arch users can install this [package](https://aur.archlinux.org/packages/cool-retro-term-git/) directly via the [AUR](https://aur.archlinux.org): @@ -28,20 +34,22 @@ or use: to install precompiled from community repository. -Gentoo users can now install the first release "1.0" from a 3rd-party repository preferably via layman: +Gentoo users can now install the second release "1.0.1" from a 3rd-party repository preferably via layman: USE="git" emerge app-portage/layman wget https://www.gerczei.eu/files/gerczei.xml -O /etc/layman/overlays/gerczei.xml layman -f -a qt -a gerczei # those who've added the repo before 27/08/17 should remove, update and add it again as its source has changed - ACCEPT_KEYWORDS="~*" emerge =x11-terms/cool-retro-term-1.0.0-r1::gerczei + ACCEPT_KEYWORDS="~*" emerge =x11-terms/cool-retro-term-1.0.1::gerczei The live ebuild (version 9999-r1) tracking the bleeding-edge WIP codebase also remains available. A word of warning: USE flags and keywords are to be added to portage's configuration files and every emerge operation should be executed with '-p' (short option for --pretend) appended to the command line first as per best practice! -Ubuntu users of 14.04 LTS (Trusty) up to 15.10 (Wily) can use [this PPA](https://launchpad.net/~bugs-launchpad-net-falkensweb) +Ubuntu users of 14.04 LTS (Trusty) up to 15.10 (Wily) can use [this PPA](https://launchpad.net/~bugs-launchpad-net-falkensweb). -OSX users can grab the latest dmg from the release page: https://github.com/Swordfish90/cool-retro-term/releases +Ubuntu 17.10 can use [this PPA](https://launchpad.net/%7Evantuz/+archive/ubuntu/cool-retro-term) + +macOS users can grab the latest dmg from the release page: https://github.com/Swordfish90/cool-retro-term/releases ## Build instructions (Linux) @@ -64,13 +72,25 @@ Make sure to install these first. **Ubuntu 17.04** - sudo apt-get install build-essential libqt5qml-graphicaleffects qml-module-qt-labs-folderlistmodel qml-module-qt-labs-settings qml-module-qtquick-controls qml-module-qtquick-dialogs qmlscene qt5-default qt5-qmake qtdeclarative5-dev qtdeclarative5-localstorage-plugin qtdeclarative5-qtquick2-plugin qtdeclarative5-window-plugin + sudo apt install build-essential libqt5qml-graphicaleffects qml-module-qt-labs-folderlistmodel qml-module-qt-labs-settings qml-module-qtquick-controls qml-module-qtquick-dialogs qmlscene qt5-default qt5-qmake qtdeclarative5-dev qtdeclarative5-localstorage-plugin qtdeclarative5-qtquick2-plugin qtdeclarative5-window-plugin --- -**Debian Jessie** +**Ubuntu 17.10** - sudo apt-get install build-essential qmlscene qt5-qmake qt5-default qtdeclarative5-dev qml-module-qtquick-controls qml-module-qtgraphicaleffects qml-module-qtquick-dialogs qml-module-qtquick-localstorage qml-module-qtquick-window2 + sudo apt-get install build-essential qml-module-qtgraphicaleffects qml-module-qt-labs-folderlistmodel qml-module-qt-labs-settings qml-module-qtquick-controls qml-module-qtquick-dialogs qmlscene qt5-default qt5-qmake qtdeclarative5-dev qtdeclarative5-localstorage-plugin qtdeclarative5-qtquick2-plugin qtdeclarative5-window-plugin + +--- + +**Debian Stretch and Jessie** + + sudo apt install build-essential qmlscene qt5-qmake qt5-default qtdeclarative5-dev qml-module-qtquick-controls qml-module-qtgraphicaleffects qml-module-qtquick-dialogs qml-module-qtquick-localstorage qml-module-qtquick-window2 + +--- + +**Debian Stretch** + + sudo apt-get install build-essential qmlscene qt5-qmake qt5-default qtdeclarative5-dev qml-module-qtquick-controls qml-module-qtgraphicaleffects qml-module-qtquick-dialogs qml-module-qtquick-localstorage qml-module-qtquick-window2 qml-module-qt-labs-settings qml-module-qt-labs-folderlistmodel --- @@ -127,7 +147,7 @@ qmake && make ./cool-retro-term ``` -## Build instructions (OSX) +## Build instructions (macOS) 1. Install [Xcode](https://developer.apple.com/xcode/) and agree to the licence agreement 2. Enter the following commands into the terminal: @@ -160,6 +180,6 @@ open cool-retro-term.app ``` ## Donations -I made this project in my spare time because I love what I'm doing. If you are enjoying it and you want to buy me a beer click [here](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=flscogna%40gmail%2ecom&lc=IT&item_name=Filippo%20Scognamiglio¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted) . +I made this project in my spare time because I love what I'm doing. If you are enjoying it and you want to buy me a beer click [here](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=flscogna%40gmail%2ecom&lc=IT&item_name=Filippo%20Scognamiglio¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted). You can also add "bounties" on your favourite issues. More information on the [Bountysource](https://www.bountysource.com/teams/crt/issues) page. diff --git a/app/main.cpp b/app/main.cpp index 75525ce..491a61f 100644 --- a/app/main.cpp +++ b/app/main.cpp @@ -54,6 +54,7 @@ int main(int argc, char *argv[]) qDebug() << " --default-settings Run cool-retro-term with the default settings"; qDebug() << " --workdir Change working directory to 'dir'"; qDebug() << " -e Command to execute. This option will catch all following arguments, so use it as the last option."; + qDebug() << " -T Set window title to 'title'."; qDebug() << " --fullscreen Run cool-retro-term in fullscreen."; qDebug() << " -p|--profile <prof> Run cool-retro-term with the given profile."; qDebug() << " -h|--help Print this help."; @@ -62,7 +63,7 @@ int main(int argc, char *argv[]) } if (args.contains("-v") || args.contains("--version")) { - qDebug() << "cool-retro-term 1.0"; + qDebug() << "cool-retro-term 1.0.1"; return 0; } diff --git a/app/qml/ApplicationSettings.qml b/app/qml/ApplicationSettings.qml index d0f8beb..96297b4 100644 --- a/app/qml/ApplicationSettings.qml +++ b/app/qml/ApplicationSettings.qml @@ -24,7 +24,7 @@ import QtQuick.Controls 1.0 import "utils.js" as Utils QtObject{ - property string version: "1.0.0" + property string version: "1.0.1" // STATIC CONSTANTS //////////////////////////////////////////////////////// @@ -41,6 +41,8 @@ QtObject{ property bool fullscreen: false property bool showMenubar: true + property string wintitle: "cool-retro-term" + property real windowOpacity: 1.0 property real ambientLight: 0.2 property real contrast: 0.85 @@ -439,6 +441,11 @@ QtObject{ obj_string: '{"ambientLight":0.1,"backgroundColor":"#000000","bloom":0.15,"brightness":0.5,"flickering":0,"contrast":0.85,"fontName":"IBM_3278","fontColor":"#0ccc68","frameName":"SIMPLE_WHITE_FRAME","glowingLine":0,"horizontalSync":0,"jitter":0,"burnIn":0.6,"staticNoise":0,"rasterization":0,"screenCurvature":0.1,"windowOpacity":1,"chromaColor":0,"saturationColor":0,"rbgShift":0,"fontWidth":1.0,"useCustomCommand":false,"customCommand":""}' builtin: true } + ListElement{ + text: "Knight TV" + obj_string: '{"ambientLight":0.16,"backgroundColor":"#000000","bloom":0.45,"brightness":0.5,"burnIn":0.3,"chromaColor":0,"contrast":0.85,"customCommand":"","flickering":0.1,"fontColor":"#0ccc68","fontName":"Knight_TV","fontWidth":1,"frameName":"SIMPLE_WHITE_FRAME","glowingLine":0,"horizontalSync":0.16,"jitter":0,"rasterization":0,"rbgShift":0,"saturationColor":0,"screenCurvature":0.07,"staticNoise":0,"useCustomCommand":false,"windowOpacity":1}' + builtin: true + } ListElement{ text: "Transparent Green" obj_string: '{"ambientLight":0.2,"backgroundColor":"#000000","bloom":0.45,"brightness":0.5,"flickering":0.20,"contrast":0.85,"fontName":"TERMINUS_SCALED","fontColor":"#0ccc68","frameName":"NO_FRAME","glowingLine":0.16,"horizontalSync":0.1,"jitter":0.20,"burnIn":0.25,"staticNoise":0.20,"rasterization":0,"screenCurvature":0.05,"windowOpacity":0.60,"chromaColor":0,"saturationColor":0,"rbgShift":0,"fontWidth":1.0,"useCustomCommand":false,"customCommand":""}' @@ -480,6 +487,10 @@ QtObject{ showMenubar = false; } + if (args.indexOf("-T") !== -1) { + wintitle = args[args.indexOf("-T") + 1] + } + initializedSettings(); } Component.onDestruction: { diff --git a/app/qml/Fonts.qml b/app/qml/Fonts.qml index ad20844..7189723 100644 --- a/app/qml/Fonts.qml +++ b/app/qml/Fonts.qml @@ -204,5 +204,15 @@ QtObject{ fontWidth: 1.0 lowResolutionFont: false } + ListElement{ + name: "Knight_TV" + text: "Knight TV (1975)" + source: "fonts/1975-knight-tv/KnightTVMedium.ttf" + lineSpacing: 0.2 + pixelSize: 10 + fontWidth: 1.0 + baseScaling: 3.0 + lowResolutionFont: true + } } } diff --git a/app/qml/fonts/1971-ibm-3278/3270Medium.ttf b/app/qml/fonts/1971-ibm-3278/3270Medium.ttf index 8e7867f..02e4f19 100644 Binary files a/app/qml/fonts/1971-ibm-3278/3270Medium.ttf and b/app/qml/fonts/1971-ibm-3278/3270Medium.ttf differ diff --git a/app/qml/fonts/1971-ibm-3278/LICENSE.txt b/app/qml/fonts/1971-ibm-3278/LICENSE.txt index a32e6d9..3ca71cb 100644 --- a/app/qml/fonts/1971-ibm-3278/LICENSE.txt +++ b/app/qml/fonts/1971-ibm-3278/LICENSE.txt @@ -1,15 +1,49 @@ -Copyright (c) 2011-2016, Ricardo Banffy. +Copyright (c) 2011-2017, Ricardo Banffy. Copyright (c) 1993-2011, Paul Mattes. Copyright (c) 2004-2005, Don Russell. Copyright (c) 2004, Dick Altenbern. Copyright (c) 1990, Jeff Sparkes. Copyright (c) 1989, Georgia Tech Research Corporation (GTRC), Atlanta, GA 30332. All rights reserved. -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -Neither the names of Ricardo Banffy, Paul Mattes, Don Russell, Dick Altenbern, Jeff Sparkes, GTRC nor the names of their contributors may be used to endorse or promote products derived from this software without specific prior written permission. -THIS SOFTWARE IS PROVIDED BY RICARDO BANFFY, PAUL MATTES, DON RUSSELL, DICK ALTENBERN, JEFF SPARKES AND GTRC "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RICARDO BANFFY, PAUL MATTES, DON RUSSELL, DICK ALTENBERN, JEFF SPARKES OR GTRC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: -The Debian Logo glyph is based on the Debian Open Use Logo and is Copyright (c) 1999 Software in the Public Interest, Inc., and it is incorporated here under the terms of the Creative Commons Attribution-ShareAlike 3.0 Unported License. The logo is released under the terms of the GNU Lesser General Public License, version 3 or any later version, or, at your option, of the Creative Commons Attribution-ShareAlike 3.0 Unported License. + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + + * Neither the name of Ricardo Banffy, Paul Mattes, Don Russell, + Dick Altenbern, Jeff Sparkes, GTRC nor the names of their contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +IN NO EVENT SHALL RICARDO BANFFY, PAUL MATTES, DON RUSSELL, DICK ALTENBERN, JEFF +SPARKES OR GTRC BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT +OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +The Debian Logo glyph is based on the Debian Open Use Logo and is +Copyright (c) 1999 Software in the Public Interest, Inc., and it is +incorporated here under the terms of the Creative Commons +Attribution-ShareAlike 3.0 Unported License. The logo is released +under the terms of the GNU Lesser General Public License, version 3 or +any later version, or, at your option, of the Creative Commons +Attribution-ShareAlike 3.0 Unported License. + +Ubuntu, the Ubuntu logo and the Circle of Friends symbol are +registered trademarks of Canonical Ltd. + +The Fontforge SFD font description file is optionally licensed under +the SIL Open Font License v1.1 with no Reserved Font Name. This +license is available with a FAQ at http://scripts.sil.org/OFL. diff --git a/app/qml/fonts/1971-ibm-3278/README.md b/app/qml/fonts/1971-ibm-3278/README.md index c094795..90e87ee 100644 --- a/app/qml/fonts/1971-ibm-3278/README.md +++ b/app/qml/fonts/1971-ibm-3278/README.md @@ -16,26 +16,28 @@ hand-copied from a 3270 series terminal. I built it because I felt terminals deserve to be pretty. The .sfd font file contains a x3270 bitmap font that was used for guidance. -![Using with the cool-old-tern (now cool-retro-term) terminal program] -(https://raw.githubusercontent.com/wiki/rbanffy/3270font/cool-retro-term.png) +![Using with the cool-old-tern (now cool-retro-term) terminal program]( +https://raw.githubusercontent.com/wiki/rbanffy/3270font/cool-retro-term.png) Getting it ---------- If you are running Debian or Ubuntu and you don't want to mess with building your font files, you can simply `apt-get install fonts-3270` -(It's available from the Debian and Ubuntu package repos at +(It's available from the Debian +(https://packages.debian.org/sid/fonts/fonts-3270) and Ubuntu +(http://packages.ubuntu.com/zesty/fonts-3270) package repos at https://packages.debian.org/sid/fonts/fonts-3270 and http://packages.ubuntu.com/xenial/fonts/fonts-3270, although the packaged version may not be the latest version, but it's good enough for most purposes. For those who don't have the luxury of a proper system-managed package, Adobe Type 1, TTF, OTF and WOFF versions are available for download on -http://s3.amazonaws.com/3270font/3270_fonts_ef53755.zip (although this +http://s3.amazonaws.com/3270font/3270_fonts_d250fd9.zip (although this URL may not always reflect the latest version). -![ASCII is so 60's] -(https://raw.githubusercontent.com/wiki/rbanffy/3270font/cyrillic.png) +![ASCII is so 60's]( +https://raw.githubusercontent.com/wiki/rbanffy/3270font/cyrillic.png) The format ---------- @@ -47,18 +49,17 @@ fontforge` or even `port install fontforge`. On others, you may need to grab your copy from http://fontforge.org/. I encourage you to drop by and read the tutorials. -![Powerline-shell compatible!] -(https://raw.githubusercontent.com/wiki/rbanffy/3270font/powerline.png) +![Powerline-shell compatible!]( +https://raw.githubusercontent.com/wiki/rbanffy/3270font/powerline.png) -![Using it on OSX (don't forget to turn antialiasing on)] -(https://raw.githubusercontent.com/wiki/rbanffy/3270font/osx_terminal.png) +![Using it on OSX (don't forget to turn antialiasing on)](https://raw.githubusercontent.com/wiki/rbanffy/3270font/osx_terminal.png) If you are running Windows, you'll probably need something like Cygwin, but, in the end, the font works correctly (with some very minor hinting issues). -![Works on Windows] -(https://raw.githubusercontent.com/wiki/rbanffy/3270font/windows_7.png) +![Works on Windows]( +https://raw.githubusercontent.com/wiki/rbanffy/3270font/windows_7.png) Generating usable font files ---------------------------- @@ -73,8 +74,8 @@ slightly more condensed .sfd file with the base font narrowed to 488 units, with no glyph rescaling (or cropping - we need to fix that) and its corresponding PostScript, TTF, OTF and WOFF versions. -![For your favorite editor] -(https://raw.githubusercontent.com/wiki/rbanffy/3270font/symbols.png) +![For your favorite editor]( +https://raw.githubusercontent.com/wiki/rbanffy/3270font/symbols.png) Contributing ------------ diff --git a/app/qml/fonts/1975-knight-tv/KnightTVMedium.ttf b/app/qml/fonts/1975-knight-tv/KnightTVMedium.ttf new file mode 100644 index 0000000..4d133fb Binary files /dev/null and b/app/qml/fonts/1975-knight-tv/KnightTVMedium.ttf differ diff --git a/app/qml/main.qml b/app/qml/main.qml index 3d18a46..a164176 100644 --- a/app/qml/main.qml +++ b/app/qml/main.qml @@ -62,8 +62,10 @@ ApplicationWindow{ __contentItem.visible: mainMenu.visible } + property string wintitle: appSettings.wintitle + color: "#00000000" - title: terminalContainer.title || qsTr("cool-retro-term") + title: terminalContainer.title || qsTr(appSettings.wintitle) Action { id: newAction diff --git a/app/qml/resources.qrc b/app/qml/resources.qrc index b5639f7..a13d0b6 100644 --- a/app/qml/resources.qrc +++ b/app/qml/resources.qrc @@ -32,6 +32,7 @@ <file>fonts/1982-commodore64/C64_Pro_Mono_v1.0-STYLE.ttf</file> <file>fonts/1977-apple2/PrintChar21.ttf</file> <file>fonts/1971-ibm-3278/3270Medium.ttf</file> + <file>fonts/1975-knight-tv/KnightTVMedium.ttf</file> <file>fonts/1985-atari-st/AtariST8x16SystemFont.ttf</file> <file>fonts/modern-terminus/TerminusTTF-4.38.2.ttf</file> <file>fonts/1977-commodore-pet/COMMODORE_PET.ttf</file> diff --git a/packaging/appdata/cool-retro-term.appdata.xml b/packaging/appdata/cool-retro-term.appdata.xml index 29029f8..50d009c 100644 --- a/packaging/appdata/cool-retro-term.appdata.xml +++ b/packaging/appdata/cool-retro-term.appdata.xml @@ -16,11 +16,11 @@ <screenshots> <screenshot type="default"> <caption>Default amber look</caption> - <image width="768" height="595">https://camo.githubusercontent.com/2443e662e95733ba6ae331f391f6ec036d1ee7fd/687474703a2f2f692e696d6775722e636f6d2f4e5566766e6c752e706e67</image> + <image width="1022" height="791">https://camo.githubusercontent.com/2443e662e95733ba6ae331f391f6ec036d1ee7fd/687474703a2f2f692e696d6775722e636f6d2f4e5566766e6c752e706e67</image> </screenshot> <screenshot> <caption>Apple II look</caption> - <image width="768" height="595">https://camo.githubusercontent.com/44a19842d532555c7b02bf6b4b4684add9edf18c/687474703a2f2f692e696d6775722e636f6d2f4d4d6d4d3648742e706e67</image> + <image width="1024" height="796">https://camo.githubusercontent.com/44a19842d532555c7b02bf6b4b4684add9edf18c/687474703a2f2f692e696d6775722e636f6d2f4d4d6d4d3648742e706e67</image> </screenshot> </screenshots> diff --git a/packaging/debian/cool-retro-term.1 b/packaging/debian/cool-retro-term.1 index 8cc3b3b..beff16e 100644 --- a/packaging/debian/cool-retro-term.1 +++ b/packaging/debian/cool-retro-term.1 @@ -1,31 +1,43 @@ -.TH cool-retro-term 1 "August 22 2016" +.TH "COOL-RETRO-TERM" 1 "2017-11-06" .SH NAME -cool-retro-term \- terminal emulator mimicking the old cathode display +cool\-retro\-term \- terminal emulator mimicking an old cathode display .SH SYNOPSIS -"Usage: ./cool\-retro\-term [\-\-default\-settings] [\-\-workdir <dir>] [\-\-program <prog>] [\-p|\-\-profile <prof>] [\-\-fullscreen] [\-h|\-\-help]" +\fBcool\-retro\-term\fR [\fIOPTIONS\fR] +.br +\fBcool\-retro\-term\fR [\fIOPTIONS\fR] -e \fICOMMAND\fR [\fIARGUMENT\fR...] .SH DESCRIPTION -This manual page documents briefly the -.B cool-retro-term -command. +This manual page documents briefly the \fBcool\-retro\-term\fR command. +.PP +\fBcool\-retro\-term\fR is a terminal emulator which mimics the +look and feel of the old cathode tube screens. +It has been designed to be eye-candy, +customizable, and reasonably lightweight. .SH OPTIONS .TP \fB\-\-default\-settings\fR -Run cool\-retro\-term with the default settings +Run with the default settings. .TP -\fB\-\-workdir\fR <dir> -Change working directory to 'dir' -.TP -\fB\-e\fR <cmd> -Command to execute. This option will catch all following arguments, so use it as the last option. +\fB\-e\fR \fICOMMAND\fR +Command to execute. This should be used as the last option. +All the arguments following \fICOMMAND\fR will be passed to said command. .TP \fB\-\-fullscreen\fR -Run cool\-retro\-term in fullscreen. -.HP -\fB\-p\fR|\-\-profile <prof> Run cool\-retro\-term with the given profile. +Run in fullscreen mode. .TP -\fB\-h\fR|\-\-help -Print this help. +\fB\-h\fR, \fB\-\-help\fR +Print a help screen and exit. +.TP +\fB\-p\fR \fIPROFILE\fR, \fB\-\-profile\fR \fIPROFILE\fR +Run with the given profile. +.TP +\fB\-\-workdir\fR \fIDIR\fR +Start with \fIDIR\fR as the working directory. .TP \fB\-\-verbose\fR Print additional information such as profiles and settings. -.PP +.TP +\fB\-v\fR, \fB\-\-version\fR +Print the version number and exit. +.SH LICENCE +This program is available under the terms of the GNU General Public License, +version 3 or any later version, as published by the Free Software Foundation.