README

   1
   2 About
   3 -----
   4
   5 abby is a front-end for cclive and clive which are used to
   6 download videos from Youtube and other similar video hosts.
   7
   8 abby is written in C++ and depends on the Qt framework.
   9
  10     http://abby.googlecode.com/
  11
  12
  13 Configuration
  14 -------------
  15
  16 * abby will require path to either cclive or clive command
  17
  18 * The path is detected from the $PATH by default
  19
  20 * If the above fails, you are required to enter it manually by opening
  21 the program preferences (Edit / Preferences or ctrl-e).
  22
  23 * Use the "Verify" button to verify the path to c/clive
  24
  25 * abby uses Qt's QSettings class for storing the program settings
  26   - on Linux/FreeBSD these settings are typically found under .config/abby/
  27   - the location may vary for each platform, refer to the Qt documentation
  28
  29
  30 The essentials to get started with abby
  31 ---------------------------------------
  32
  33 If you have not configured abby already, then see the "Configuration"
  34 section above.
  35
  36 * You can add video page links by:
  37
  38   - Hitting the "+" button
  39
  40   - Dropping them onto the window
  41
  42   - Pasting them from the system clipboard
  43
  44   - Parsing RSS feeds (covered further below)
  45
  46   - Scanning video pages (covered further below)
  47
  48   - Importing them from files
  49
  50 * Each time a new link is added to the list
  51
  52   - abby verifies that the c/clive supports the website
  53
  54   - abby ignores any duplicate links
  55
  56 * Start the download by hitting the download button (or ctrl+d)
  57
  58
  59 Parsing RSS feeds
  60 -----------------
  61
  62 You can access this feature by clicking the button with the RSS icon
  63 on it or by hitting ctrl+r. Some websites like youtube.com and
  64 video.google.com provide RSS feeds that can be parsed in abby.
  65
  66 Example:
  67   http://gdata.youtube.com/feeds/base/users/communitychannel/uploads?alt=rss
  68
  69 Once the RSS dialog is open, you can add RSS feed links to the top list.
  70 As with the main window's video page link list (or download list), hit
  71 the "+" button, paste a link from the clipboard or drop links onto the
  72 dialog.
  73
  74 It's also worth noting that you can access the "Feed manager" by hitting
  75 the "Feeds..." button. The manager can be used to save frequently visited
  76 RSS feeds.
  77
  78 Hit "Fetch" to continue. Once the parsing is complete, a list of found
  79 items are displayed in the bottom list, each feed item under appropriate
  80 feed channel.
  81
  82 Check each item you want to add to the download list and hit "OK".
  83
  84
  85 Scanning for video page links
  86 -----------------------------
  87
  88 The scan feature originates from the early days of clive and the clivescan
  89 program. It can be used to scan for "regular" Youtube video page links or
  90 embedded ones. The found links can then be added to the download list in
  91 the main window and downloaded.
  92
  93 You can access the scan dialog by hitting either the scan button in the
  94 main window. Ctrl-s also opens the same dialog.
  95
  96 Once the dialog is open, enter the URL you want to scan for video page
  97 links. For example: http://youtube.com
  98
  99 If the "Fetch video title" is checked, abby will perform the scan in two
 100 steps:
 101
 102   1) First fetches the content from specified link and scans it for
 103      video page links
 104
 105   2) It then visits (fetches and parses) each found link for the page title
 106
 107 Hit the "Scan" button to start the scan process. Depending on the "Fetch
 108 video title" state, abby will either add the parsed video page title or
 109 the link itself to the list.
 110
 111 Once the process is complete, you can check each video from the list
 112 and hit "OK" to add them to the download list.
 113
 114 To those wondering if you can use this feature to scan Youtube playlists,
 115 the answer is yes. Note however that you have to scan each page manually
 116 because abby is currently unable go over the playlist pages automatically.
 117
 118
 119 Misc. notes
 120 -----------
 121
 122 * abby supports keyboard shortcuts. These are visible in the menus. For example,
 123 Alt+A would open the "Add link" dialog.
 124
 125 * You can edit list items by double clicking them. This applies to all windows
 126 and dialogs with list widgets.
 127
 128 * You can paste multiple links by separating each link with a newline
 129
 130 * Export saves all of the items in the list to a specified text file.
 131 Each link is separated with a newline.
 132
 133 * Import parses text files line by line and expects each link to be
 134 separated with a newline.
 135
 136 * Because c/clive parses input in a similar fashion, you can use the
 137 exported exported lists with c/clive, e.g.: cclive < exported.list
 138
 139