Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
intnull committed Sep 15, 2011
1 parent 3759922 commit 9b3f796
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Expand Up @@ -8,15 +8,25 @@ There are two modes: command mode and browse mode.
In command mode you can search for videos by typing **:s** *VIDEOSEARCH* and hitting **ENTER**.
This will generate a list of videos and switch to browse mode.

In browse mode you can download the videos by hitting **ENTER** and play them with **p**.
You can also open the youtube page by hitting **o**.
In browse mode you can download the videos by hitting **ENTER** and play them with **p**.
To abort the download of a video select it and hit **a**. Note that this won't delete the partially downloaded file,
in fact you can resume the download if you hit **ENTER** again.
You can also open the YouTube page by hitting **o** or directly stream the video with MPlayer by hitting **s**.
**CTRL n** lists the next videos of your previous search and **CTRL r** clears the screen.

To search for the string *SOMETHING* in the current video list type **/***SOMETHING* and
hit **n** to get to the next or **N** to get to the previous item.

All downloaded videos are stored in *~/.videotop/videos*.

# Configuration
For streaming you might want to add something like this in your MPlayer config (~/.mplayer/config),
the values depend on your internet connection:

[default]
cache = 8192 # 8 mb cache
cache-min = 5 # play if 5% of the cache is loaded in memory

# Command Table
<table border='1'>
<tr><th>Command Mode</th><th>Browse Mode</th><th>Description</th></tr>
Expand All @@ -29,6 +39,7 @@ All downloaded videos are stored in *~/.videotop/videos*.
<tr><td></td><td>a</td><td>Abort downloading the selected video</td></tr>
<tr><td></td><td>o</td><td>Open the YouTube page of the selected video in your default web browser</td></tr>
<tr><td></td><td>p</td><td>Play the selected video with MPlayer</td></tr>
<tr><td></td><td>s</td><td>Stream the selected video with MPlayer</td></tr>
<tr><td></td><td>j</td><td>Move down</td></tr>
<tr><td></td><td>k</td><td>Move up</td></tr>
<tr><td></td><td>CTRL d</td><td>Move down</td></tr>
Expand All @@ -46,3 +57,8 @@ All downloaded videos are stored in *~/.videotop/videos*.
[2]: http://code.google.com/apis/youtube/1.0/developers_guide_python.html
[3]: http://rg3.github.com/youtube-dl/
[4]: http://www.mplayerhq.hu/

# Links
* [archlinux forums][5]

[5]: https://bbs.archlinux.org/viewtopic.php?id=123234/

0 comments on commit 9b3f796

Please sign in to comment.