adapt to cclive 0.5.6 changes: --regexp, --substitute.
[abby.git] / README
blob40b9947c2ede47eb7e3fe426dbb2864c2def2d07
4 About
5 -----
7 abby is a front-end for cclive and clive which are used to
8 download videos from Youtube and other similar video hosts.
10 abby is written in C++ and depends on the Qt framework.
12     http://abby.googlecode.com/
15 Configuration
16 -------------
18 You will need to set the path to either clive(1) or cclive(1) command.
19 You can do this by opening the preferences (Edit/Preferences). Note that
20 abby will check the path everytime it starts and prompts a notification
21 if it cannot run the c/clive command.
23 You can confirm that c/clive was found by opening the about dialog (Help/
24 About).
27 First download
28 --------------
30 Once the path is set to c/clive, you can add a new link to the download
31 list by clicking the "plus" button left to the list widget. abby will
32 prompt for a video page link. Note that before anything gets added to the
33 list, abby verifies the c/clive supports the specified video host.
35 Now that you have added a video page link to the list, you can click the
36 download button (bottom-right to the list widget). This starts the c/clive
37 process. The download progress is presented using the progressbars and
38 various labels but you can also view various process details by opening
39 the "Log" tab.
42 Feature: RSS
43 ------------
45 abby can parse RSS feeds. This feature can be accessed by clicking the
46 "RSS". Once the dialog is open, you can enter a RSS feed link, for example:
47     http://gdata.youtube.com/feeds/base/users/(username)/uploads?alt=rss
49 You can also append "&orderby=updated" to the URL.
51 And hit "Fetch". When the parsed items appear in the list, you can select
52 each item to the download list by checking the box before the video title.
53 By hitting "OK", each selected item will be added to the download list.
55 Note also the tiny button before the "Fetch" button. This opens another
56 dialog (Feed manager) that can be used to save your feed links so that you
57 can select them later without having to type them again. To re-use a link
58 from "Feed manager", select a link from the list and hit "OK".
60 Note that this feature is not Youtube specific, although the example link
61 above was for Youtube. You can use the RSS parsing feature ultimately with
62 any website that provides RSS content containing video page links to the
63 c/clive supported websites.
66 Feature: Scan
67 -------------
69 abby can scan for video page links from any URL. This feature can be accessed
70 by clicking the button underneath the "RSS" button. The interface is somewhat
71 similar to the RSS dialog except that you are presented with the "Fetch video
72 title" option box.
74 Before you can start the scan, you will need to add a link to the "Link:"
75 field. This could be, for example, the front-page of Youtube website
76 (http://youtube.com).
78 If the "Fetch video title" is checked, abby will perform the scan in two
79 steps, first it will fetch the content from specified link and parses it for
80 video page links, and then visits those links for page title information.
82 Hit the "Scan" button to start the scan process.
84 Once the process has completed, abby adds the detected video page links
85 to the list widget from which you can check those items that you wish to
86 download. Clicking the "OK" button will then transfer the selected items to
87 the download list.
89 Note that the scan feature currently supports only Youtube links. This means
90 that it only recognizes Youtube video page links from the scanned content.
92 And yes, it works with Youtube playlists.
95 Notes
96 -----
98 abby supports keyboard shortcuts. These are visible in the menu. For example,
99 Alt+A would open the "Add link" dialog.
101 You can edit list items by double clicking them. This applies to all windows
102 and dialogs with list widgets.