helpDlg 0 0 608 400 Help - aria2fe :/pixmaps/pixmaps/book.png true 0 0 590 0 0 0 0 0 12 50 true false false QTabWidget::North QTabWidget::Rounded 0 aria2fe 11 false <html><head><meta name="qrichtext" content="1" /><style type="text/css"> p, li { white-space: pre-wrap; } </style></head><body style=" font-family:'Sans Serif'; font-size:11pt; font-weight:400; font-style:italic;"> README <p style="-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; font-size:12pt; font-weight:600; font-style:normal; text-decoration: underline;"> 1. This dialog is currently under construction and replaces the "USAGE" doc in /home/user/aria2fe-0.0.X/doc/. 2. As Linux in general has no formal Help structure excepting "man" pages and scattered HTML, I wanted something that would be integrated with the application and would not require any external applications or additional software for viewing (terminal, browser, pdf reader, etc.). Additionally, this Help function "resides" with the application and does not require installation. 3. Please understand that this is work in process and most likely will not be completed prior to the next release or two of aria2fe (especially the aesthetics). 4. Since this is a somewhat different concept in Linux Help functions, I would welcome any comments or suggestions that you might have. Mike Wells Developer/Maintainer Web: http://aria2fe.com/ Forums: http://sourceforge.net/projects/aria2fe/ Email: aria2fe@cox.net "Friends don't let friends run WinDoze" </body></html> Introduction <html><head><meta name="qrichtext" content="1" /><style type="text/css"> p, li { white-space: pre-wrap; } </style></head><body style=" font-family:'Sans Serif'; font-size:12pt; font-weight:400; font-style:italic;"> INTRODUCTION <p style="-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; font-weight:600; font-style:normal; text-decoration: underline;"> ari2fe behaves like a wysiwyg editor for constructing the command line syntax for aria2. You can edit any of the options as many times as necessary before starting aria2 and the resulting syntax will be exactly what you are seeing. Additionally, there is a pre-launch intermediate dialog that lets you view the exact arguments (in their entirety) that will be passed to aria2 giving you another chance to go back and correct any mistakes. Even so, mistakes can and will be made given the complexity of the command line syntax. Should aria2 error out you can make any additional changes needed and relaunch aria2 without having to "reinvent the wheel" from scratch! For those of you that like to "squeak" every last bit of resources out of your machine when doing large downloads along with a dozen or so asundry other things aria2fe is designed such that it can be shut down once you are satisfied that your download is running smoothly. This frees up the small percentage of physical memory that was being occupied by the program. xterm will continue to "act" as console for the download until it is complete and you have exited. The scope of this document leaves no room for detailing each and every option (argument) for aria2 (I believe there are currently 63 of them). You can use the aria2 built in help (via aria2fe) and/or visit the "man" page for aria2. It is assumed that you have (or will have) a thorough understanding and good working knowledge of aria2 so that you will be able to correctly construct the command syntax for the type of download that you are executing. The subjects presented herein will deal with using aria2fe correctly and getting the most out of it. </body></html> MainWindow <html><head><meta name="qrichtext" content="1" /><style type="text/css"> p, li { white-space: pre-wrap; } </style></head><body style=" font-family:'Sans Serif'; font-size:12pt; font-weight:400; font-style:italic;"> MAIN WINDOW <p style="-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; font-weight:600; font-style:normal; text-decoration: underline;"> Using aria2fe is pretty much a point and click operation with minimal keyboard interaction and for the most part is self-explanatory. High points and nuances will be outlined here and the rest is up to you! The "Save" pixmap (icon) located on the Main MenuBar->File and the Toolbar is "darked" out (action disabled) until you open and load a .conf file. Multiple URL's on the URL edit must be separated with a space. The Target Directory edit must contain an absolute path to the directory that you want to download to (e.g., /home/username/download/). This is a condition of aria2, not aria2fe. The Target Filename edit can contain just the name of the target file (it will be placed in "~/") or you can specify an absolute path. aria2fe does not perform any contextual validity checks on the arguments you submit to aria2 with the exception of certain numeric fields. In addition, arguments entered in the "+ Opts" edit are not checked for correct syntax (other than edit format). An example would be that you are doing a Metalink download and you enter data in the Cookie File and Referer edits. aria2fe will pass these as if they belonged. However, aria2 is somewhat forgiving and may ignore some non-applicable arguments. It is up to you to insure that the arguments you submit are specifically for the type of download you are doing. If you mispell syntax (although formatted correctly) on the Additional Opts edit the chances are more likely than not that you will have to correct the mistake. All of this boils down to the same set of circumstances that you would be dealing with if you were using the CLI. It is just a whole lot easier and more convenient to use the GUI for original submission and error correction. About line edits. After entering browse for or keyboard data you do not need to press the Enter Key to "lock in" the entry. aria2fe is smarter than that and "knows" when you have entered data. Just move on to the next argument with your mouse or the Tab Key. Combo boxes for certain arguments ease the argument entry process as do checkboxes for yes/no conditions. The major edits have browse and clear buttons and there are clear buttons on a few of the minor ones. There are four buttons (in the lower right corner) for invoking intermediate dialogs that contain download "type" specific arguments. Refer to the Dialogs tab for further information. Although the Additional Options (+ Opts) edit is no longer required with the inclusion of the download "type" specific dialogs it is still included for backward compatibility with *.conf files and as an added convenience for quick option entry. Options entered via this edit must be submitted in "long option" format. That is, double hyphenation marks followed by the argument syntax followed by an equal sign then the "value" (e.g., "--file-allocation=prealloc" (no quotes)). Multiple arguments must be separated with a space between each one. If you are unsure of the syntax for a particular argument, consult aria2 Help or the aria2 man page for clarification. Last but not least, the most important button remains and that is "Run". It is emphasized with a pixmap of 3 gears and is located in MenuBar->Tools and on the ToolBar. Clicking invokes the Argument List intermediate dialog showing the arguments in their entirety. Clicking OK invokes the download process and clicking Cancel returns you to Main Window control for further editing/correction. NOTE: All of the values displayed in the widgets are defaults and are for reference only. Naturally, these are not passed (unless changed) to aria2. </body></html> Menu/Tool Bars <html><head><meta name="qrichtext" content="1" /><style type="text/css"> p, li { white-space: pre-wrap; } </style></head><body style=" font-family:'Sans Serif'; font-size:12pt; font-weight:400; font-style:italic;"> MENU/TOOL BARS File->Open: Used to open a .conf (configuration) file via a (Ctrl+O) browse dialog. File->Save: Used to save the loaded .conf file. (Ctrl+S) File->Save As: Used to save the loaded .conf file to a different (Ctrl+A) location/name. File->Quit: Quit (exit) aria2fe. (Ctrl+Q) Tools->Restore Defaults: Clears widgets and argument list and restores (Ctrl+D) default values. Tools->Run: Invokes/executes xterm/aria2. (Ctrl+R) Help->aria2fe Help: Work in process. (Alt+H + Alt+H) (you are currently viewing it) Help->aria2 Help: Brings up the help feature for aria2 via xterm. (Alt+H + Alt+R) Help->aria2 Configuration: Brings up the Version/Configuration information (Alt+H + Alt+N) for aria2 via xterm. Help->About aria2fe: A little about the program that I hope you are (Alt+H + Alt+A) getting ready to use in just a few moments! Help->About Qt A little about Qt, the RAD tool used to design (Alt+H + Alt+Q) and construct this program using C++ and the Qt GUI Toolkit. </body></html> Context Menu <html><head><meta name="qrichtext" content="1" /><style type="text/css"> p, li { white-space: pre-wrap; } </style></head><body style=" font-family:'Sans Serif'; font-size:12pt; font-weight:400; font-style:italic;"> CONTEXT MENU Right clicking any of the edit widgets invokes a popup context menu with the following actions: Undo (Ctrl+Z): Undoes the last popup menu action invoked. Redo (Ctrl+Y): Redoes the last popup menu action invoked. Cut (Ctrl+X): Cuts the contents of the edit widget to the clipboard. Copy (Ctrl+C): Copies the contents of the edit widget to the clipboard. Paste (Ctrl+V): Copies the contents of the clipboard into the edit widget. Delete: Clears the edit widget. Select All: Selects the entire contents of the edit widget. </body></html> conf Files <html><head><meta name="qrichtext" content="1" /><style type="text/css"> p, li { white-space: pre-wrap; } </style></head><body style=" font-family:'Sans Serif'; font-size:12pt; font-weight:400; font-style:italic;"> conf Files <p style="-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; font-weight:600; font-style:normal; text-decoration: underline;"> About .conf (configuration) files. These are the file types that you will/can use for saving/reusing your configuration information. Especially useful if you do the same type of downloads frequently. There is no limit to the number of .conf files you can have and addtionally, they can be stored anywhere in your ~/ directory. A browse dialog facilitates locating and loading the files. Once a file has been loaded you can, at your discretion, "overlay" it with another without having to close the first. Subtle changes to a .conf file can be handled with the Save action whereas complete rework is done through the Save As action. You do not need to be involved in a download to work with .conf files and this feature acts as a tool for becoming more familiar with the various aria2 arguments. Create your first .conf file by executing aria2fe, setting up all of the various options that you would normally use and then do a Save As giving the file a name and a "home". This can serve as a template for future .conf files. NOTE: Do not edit the .conf files manually (to do so will most likely corrupt the file(s) and render them useless). Instead, use aria2fe to regen them. There is a widget located on the far right side of the aria2fe Status Bar that shows the location and name of the currently loaded .conf file. Other Status Bar messages are generated upon loading/saving .conf files. NOTE: When naming and saving .conf files be sure to include the ".conf" (no quotes) file suffix. Suggestion: Create a "template" .conf file for each of the following type of downloads; URL, URI, HTTP(S), FTP, Metalink and BitTorrent. </body></html> Dialogs <html><head><meta name="qrichtext" content="1" /><style type="text/css"> p, li { white-space: pre-wrap; } </style></head><body style=" font-family:'Sans Serif'; font-size:12pt; font-weight:400; font-style:italic;"> DIALOGS <p style="-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; font-weight:600; font-style:normal; text-decoration: underline;"> NOTE: Each dialog contains a button (lower left corner) for restoring defaults and clearing the dialog argument list. The internal argument list is managed separately (as it should be) for the Main Window and each of the dialogs. In other words, restoring defaults to one parent widget does not interfere with the argument list for the other parent widgets. NOTE: When saving .conf files that contain argument (option) changes to a specific download type dialog NEVER save the configuration data with non-default values for more than 1 download type. It is not nice to fool with mother nature, and in this case, mother nature is aria2! Refer to the "Suggestion" in the "conf Files" tab. More to come... </body></html> aria2 <html><head><meta name="qrichtext" content="1" /><style type="text/css"> p, li { white-space: pre-wrap; } </style></head><body style=" font-family:'Sans Serif'; font-size:12pt; font-weight:400; font-style:italic;"> aria2 <p style="-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; font-weight:600; font-style:normal; text-decoration: underline;"> More to come...</body></html> xterm <html><head><meta name="qrichtext" content="1" /><style type="text/css"> p, li { white-space: pre-wrap; } </style></head><body style=" font-family:'Sans Serif'; font-size:12pt; font-weight:400; font-style:italic;"> xterm <p style="-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; font-weight:600; font-style:normal; text-decoration: underline;"> More to come...</body></html>