Upstream tarball 20080901
[amule.git] / docs / README.Mac.txt
blob83fa47f00d9c7cf49569085783aba2f65c3a9237
1 README for aMule on the Mac
2 ===========================
4 Installation:
5 -------------
6 Just drag the aMule application to a folder of your choice (e.g., /Applications). To start aMule, double-click the application icon.
9 Documentation and help resources:
10 ---------------------------------
11 The heart of aMule's documentation is the aMule Wiki, which you can find at http://www.amule.org/wiki/index.php/Main_Page. We suggest that you start with the Getting Started Guide (http://www.amule.org/wiki/index.php/Getting_Started) and the aMule FAQ (http://www.amule.org/wiki/index.php/FAQ_aMule). These pages should give you a good idea of how to setup and use aMule.
13 If you run into any problems you can drop by at the aMule forum (http://forum.amule.org). A lot of questions have already been answered there, so it is always a good idea to start by searching the forum for your particular problem. If you don't find an answer to your problem you can post your problem on the forum and we will do our best to help you out.
15 The forum and particularly the Mac subsection of the forum (http://forum.amule.org/index.php?board=49.0) are also good places to look for usage tips and to learn about recent aMule developments (especially look at the sticky threads).
18 Right-clicking & pop-up menus on the Mac:
19 -----------------------------------------
20 aMule contains a lot of features that are only accessible through pop-up menus, which you invoke by right-clicking a certain item. For instance, if you want to pause or cancel a download, change the upload or download priority of a file, see file details, etc. you need to do this via a right-click.
22 If you haven't bought an additional multi-button mouse with your Mac, you only have one mouse button (the one that corresponds to a left-click or "normal" click on a multi-button mouse). Fortunately, you can emulate the second button by HOLDING DOWN THE CONTROL-KEY ON THE KEYBOARD WHILE YOU CLICK. For example, do a "control-click" now on a file that you are downloading and see how a pop-up menu shows up with further option.
24 If you want to discover all of aMule's hidden functionalities just try to control-click everything that moves.  
25 This includes all the lists of files, clients & servers, all the labels on the top of these lists (e.g. "File Name"), the bar "all" at the top of the download window, ...
27 By the way, these emulated right-clicks work system-wide. Just try control-clicking a file in the Finder, an icon in the Dock, a marked word in TextEdit or MS Word.
30 Handling ed2k-Links on the Mac:
31 -------------------------------
32 There are basically four ways to download files with aMule:
34 (1) Search for files using aMule's search dialog and double click those search results that you want to download.
36 (2) Copy ed2k-links from a web page into the "ED2K-Link Handler" field at the bottom of the search window of aMule and press the commit button. If the ed2k-link is longer than that text field is wide you need to make the aMule window wider until the link fits completely into the field (you can make the aMule window wider than your screen if necessary). We are working on eliminating this issue.
38 (3) Import ed2k-links directly from your browser into aMule. See http://forum.amule.org/index.php?topic=5679.msg30209#msg30209 for more details.
40 (4) Use a text editor (e.g. TextEdit) to paste ed2k-links into a "ED2Links" file inside "~/Library/Application Support/aMule/" and aMule will automatically import the links.
43 Setting up aMule's video preview feature:
44 -----------------------------------------
45 You can use a video player like VLC or Mplayer to preview incomplete downloads of video files. To set up aMule properly for this, go to Preferences -> Directories. Under "Video Player", you have to enter "/usr/bin/open -a" together with the path of your video player program.
47 For example:
48 /usr/bin/open -a "/Applications/VLC.app"
49 /usr/bin/open -a "/Applications/vlc-0.8.4a/VLC.app"
50 /usr/bin/open -a "/Applications/MPlayer OS X 2.0b8r5/MPlayer OS X 2.app"
53 Getting up-to-date snapshot builds of aMule:
54 --------------------------------------------
55 If you are interested in running aMule versions with the latest bleeding edge features or if you want to help us test the most recent changes to the aMule code-base you download up-to-date snapshot builds of aMule. More information can be found at: http://forum.amule.org/index.php?board=49.0