diff --git a/AUTHORS.rst b/AUTHORS.rst index dc4c557..48e1089 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -11,7 +11,7 @@ Thanks to the following people for their contributions to this project. * `Yusuke Sakamoto `_ * `Johnathan Jenkins `_ * `tyjak `_ -* `Alexandre Kaskasoli `_ +* `alxk `_ * `Josue Ortega `_ * `mekhami `_ * `obosob `_ @@ -29,8 +29,8 @@ Thanks to the following people for their contributions to this project. * `Ryan Reno `_ * `jupart `_ * `afloofloo `_ +* `Caleb Perkins `_ * `Charles Saracco `_ * `Corey McCandless `_ * `Danilo G. Baio `_ -* `Fabio Alessandro Locati `_ -* `Hans Roman `_ \ No newline at end of file +* `Fabio Alessandro Locati `_ \ No newline at end of file diff --git a/CHANGELOG.rst b/CHANGELOG.rst index c4de868..d013771 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,6 +2,7 @@ RTV Changelog ============= +.. _1.21.0: http://github.com/michael-lazar/rtv/releases/tag/v1.21.0 .. _1.20.0: http://github.com/michael-lazar/rtv/releases/tag/v1.20.0 .. _1.19.0: http://github.com/michael-lazar/rtv/releases/tag/v1.19.0 .. _1.18.0: http://github.com/michael-lazar/rtv/releases/tag/v1.18.0 @@ -32,6 +33,22 @@ RTV Changelog .. _1.2.1: http://github.com/michael-lazar/rtv/releases/tag/v1.2.1 .. _1.2: http://github.com/michael-lazar/rtv/releases/tag/v1.2 +-------------------- +1.21.0_ (2017-12-30) +-------------------- + +Features + +* Full support for customizable themes has been added. For more information, + see the new section on themes in the README, and the ``THEMES.md`` file. + +Bugfixes + +* Fixed incorrect URL strings being sent to the **opera** web browser. +* Fixed timeout messages for the **surf** and **vimb** web browsers. +* Switched to using ``XDG_DATA_HOME`` to store the rtv browser history and + credentials file. + -------------------- 1.20.0_ (2017-12-05) -------------------- diff --git a/rtv.1 b/rtv.1 index 3cd8a02..09e878c 100644 --- a/rtv.1 +++ b/rtv.1 @@ -1,10 +1,10 @@ -.TH "RTV" "1" "December 05, 2017" "Version 1.20.0" "Usage and Commands" +.TH "RTV" "1" "December 31, 2017" "Version 1.21.0" "Usage and Commands" .SH NAME RTV - Reddit Terminal Viewer .SH SYNOPSIS -rtv [\-h] [\-s SUBREDDIT] [\-\-log FILE] [\-\-config FILE] [\-\-ascii] [\-\-monochrome] [\-\-non\-persistent] [\-\-clear\-auth] [\-\-copy\-config] [\-\-copy\-mailcap] [\-\-enable\-media] [\-V] [URL] +rtv [URL] [\-s SUBREDDIT] .SH DESCRIPTION -Reddit Terminal Viewer is a lightweight browser for https://www.reddit.com +RTV (Reddit Terminal Viewer) is a terminal interface to view and interact with reddit. .SH OPTIONS .TP \fBURL\fR @@ -34,6 +34,14 @@ Enable ascii\-only mode \fB\-\-monochrome\fR Disable color +.TP +\fB\-\-theme FILE\fR +Color theme to use, see \-\-list\-themes for valid options + +.TP +\fB\-\-list\-themes\fR +List all of the available color themes + .TP \fB\-\-non\-persistent\fR Forget the authenticated user when the program exits @@ -61,19 +69,24 @@ show program's version number and exit .SH CONTROLS Move the cursor using the arrow keys or vim style movement. +.br Press \fBup\fR and \fBdown\fR to scroll through submissions. +.br Press \fBright\fR to view the selected submission and \fBleft\fR to return. +.br Press \fB?\fR to open the help screen. .SH FILES .TP .BR $XDG_CONFIG_HOME/rtv/rtv.cfg -The configuration file can be used to customize default program settings, see -README.md for more information. +The configuration file can be used to customize default program settings. .TP -.BR $XDG_CONFIG_HOME/rtv/refresh-token +.BR $XDG_DATA_HOME/rtv/refresh-token After you login to reddit, your most recent OAuth refresh token will be stored -for future sessions. You can disable this behavior by setting the option -\fBpersistent=False\fR in your configuration file. +for future sessions. +.TP +.BR $XDG_DATA_HOME/rtv/history.log +This file stores URLs that have been recently opened in order to +visually highlight them as "seen". .SH ENVIRONMENT .TP .BR RTV_EDITOR diff --git a/rtv/__version__.py b/rtv/__version__.py index 5e44d16..30d2533 100644 --- a/rtv/__version__.py +++ b/rtv/__version__.py @@ -1,4 +1,4 @@ # -*- coding: utf-8 -*- from __future__ import unicode_literals -__version__ = '1.20.0' +__version__ = '1.21.0' diff --git a/rtv/config.py b/rtv/config.py index bbecbd1..844c375 100644 --- a/rtv/config.py +++ b/rtv/config.py @@ -34,6 +34,7 @@ def build_parser(): parser = argparse.ArgumentParser( prog='rtv', description=docs.SUMMARY, epilog=docs.CONTROLS, + usage=docs.USAGE, formatter_class=argparse.RawDescriptionHelpFormatter) parser.add_argument( 'link', metavar='URL', nargs='?', diff --git a/rtv/docs.py b/rtv/docs.py index 8ca3e23..692487e 100644 --- a/rtv/docs.py +++ b/rtv/docs.py @@ -7,7 +7,14 @@ desktop:https://github.com/michael-lazar/rtv:{version}\ """ SUMMARY = """ -Reddit Terminal Viewer is a lightweight browser for https://www.reddit.com +RTV (Reddit Terminal Viewer) is a terminal interface to view and interact with reddit. +""" + +USAGE = """\ +rtv [URL] [-s SUBREDDIT] + + $ rtv https://www.reddit.com/r/programming/comments/7h9l31 + $ rtv -s linux """ CONTROLS = """ diff --git a/RELEASE_CHECKLIST.md b/scripts/RELEASE_CHECKLIST.md similarity index 100% rename from RELEASE_CHECKLIST.md rename to scripts/RELEASE_CHECKLIST.md diff --git a/scripts/build_manpage.py b/scripts/build_manpage.py index f403a2e..732a54a 100755 --- a/scripts/build_manpage.py +++ b/scripts/build_manpage.py @@ -26,6 +26,7 @@ def main(): parser = config.build_parser() help_text = parser.format_help() help_sections = help_text.split('\n\n') + del help_sections[1] data = {} print('Fetching version') diff --git a/scripts/rtv.1.template b/scripts/rtv.1.template index 550dcb6..c743d9b 100644 --- a/scripts/rtv.1.template +++ b/scripts/rtv.1.template @@ -9,19 +9,24 @@ RTV - Reddit Terminal Viewer {options} .SH CONTROLS Move the cursor using the arrow keys or vim style movement. +.br Press \fBup\fR and \fBdown\fR to scroll through submissions. +.br Press \fBright\fR to view the selected submission and \fBleft\fR to return. +.br Press \fB?\fR to open the help screen. .SH FILES .TP .BR $XDG_CONFIG_HOME/rtv/rtv.cfg -The configuration file can be used to customize default program settings, see -README.md for more information. +The configuration file can be used to customize default program settings. .TP -.BR $XDG_CONFIG_HOME/rtv/refresh-token +.BR $XDG_DATA_HOME/rtv/refresh-token After you login to reddit, your most recent OAuth refresh token will be stored -for future sessions. You can disable this behavior by setting the option -\fBpersistent=False\fR in your configuration file. +for future sessions. +.TP +.BR $XDG_DATA_HOME/rtv/history.log +This file stores URLs that have been recently opened in order to +visually highlight them as "seen". .SH ENVIRONMENT .TP .BR RTV_EDITOR