Skip to content
This repository has been archived by the owner on Feb 20, 2023. It is now read-only.

Commit

Permalink
Upping version
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-lazar committed Dec 31, 2017
1 parent 9eb1bde commit 5f365b8
Show file tree
Hide file tree
Showing 9 changed files with 62 additions and 18 deletions.
6 changes: 3 additions & 3 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Thanks to the following people for their contributions to this project.
* `Yusuke Sakamoto <https://github.com/yskmt>`_
* `Johnathan Jenkins <https://github.com/shaggytwodope>`_
* `tyjak <https://github.com/tyjak>`_
* `Alexandre Kaskasoli <https://github.com/alx-k>`_
* `alxk <https://github.com/sheeplepie>`_
* `Josue Ortega <https://github.com/noahfx>`_
* `mekhami <https://github.com/mekhami>`_
* `obosob <https://github.com/obosob>`_
Expand All @@ -29,8 +29,8 @@ Thanks to the following people for their contributions to this project.
* `Ryan Reno <https://github.com/rreno>`_
* `jupart <https://github.com/jupart>`_
* `afloofloo <https://github.com/afloofloo>`_
* `Caleb Perkins <https://github.com/calebperkins>`_
* `Charles Saracco <https://github.com/crsaracco>`_
* `Corey McCandless <https://github.com/cmccandless>`_
* `Danilo G. Baio <https://github.com/dbaio>`_
* `Fabio Alessandro Locati <https://github.com/Fale>`_
* `Hans Roman <https://github.com/snahor>`_
* `Fabio Alessandro Locati <https://github.com/Fale>`_
17 changes: 17 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
--------------------
Expand Down
29 changes: 21 additions & 8 deletions rtv.1
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion rtv/__version__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# -*- coding: utf-8 -*-
from __future__ import unicode_literals

__version__ = '1.20.0'
__version__ = '1.21.0'
1 change: 1 addition & 0 deletions rtv/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -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='?',
Expand Down
9 changes: 8 additions & 1 deletion rtv/docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@
"""

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 = """
Expand Down
File renamed without changes.
1 change: 1 addition & 0 deletions scripts/build_manpage.py
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
15 changes: 10 additions & 5 deletions scripts/rtv.1.template
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5f365b8

Please sign in to comment.