From e71e9767098d4e761696dce478349a3a439f0ef4 Mon Sep 17 00:00:00 2001 From: Thomas Leonard Date: Sun, 31 Jul 2005 13:19:36 +0000 Subject: [PATCH] r4067: Updated manual. --- ROX-Filer/Help/Changes | 3 +- ROX-Filer/src/Docs/Manual.xml | 186 ++++++++++++++++++++++++------------------ 2 files changed, 108 insertions(+), 81 deletions(-) diff --git a/ROX-Filer/Help/Changes b/ROX-Filer/Help/Changes index 1a79977a..0678e667 100644 --- a/ROX-Filer/Help/Changes +++ b/ROX-Filer/Help/Changes @@ -6,6 +6,7 @@ ~~~~~~~~~~~ Added a button for configuring video thumbnails (with Stephen Watson's VideoThumbnail application) to the Options window (Thomas Leonard). +Manual updates. 30-Jul-2005 ~~~~~~~~~~~ @@ -50,7 +51,7 @@ Leonard; requested by Stephen Watson). 23-Jul-2005 ~~~~~~~~~~~ -Added icon for messages (Thomas Leonard). +Added icon for messages/* MIME types (Thomas Leonard). Improvements for file type guessing (Thomas Leonard): - When getting the type for a symlink, we need the absolute path now that we check file contents. diff --git a/ROX-Filer/src/Docs/Manual.xml b/ROX-Filer/src/Docs/Manual.xml index 779516dc..229e7d54 100644 --- a/ROX-Filer/src/Docs/Manual.xml +++ b/ROX-Filer/src/Docs/Manual.xml @@ -12,9 +12,6 @@ ThomasLeonard - -
tal197 at users.sourceforge.net
- 2005Thomas Leonard @@ -78,10 +75,12 @@ XDS. - Choices + Basedir spec - A simple, but flexible, system for managing user choices. See - Choices for details. + A simple, but flexible, system for managing user choices. By default, choices are + saved under ~/.config. However, you can change this by setting + the XDG_CONFIG_HOME environment variable. See + BaseDir for details. Application directories @@ -95,8 +94,7 @@ The filer can be made to display image files by using the image itself for the icon, instead of a generic `this-is-an-image' icon. Very useful for organising - a directory full of photos! See Thumbs for details - (spec is still in developement). + a directory full of photos! See Thumbs for details. Shared MIME Info Database @@ -111,7 +109,7 @@ Collections of file icons, called themes, can be installed (eg, to ~/.icons). You can switch between themes in the Options box. Once other desktops support this fully, themes - will be sharable between desktops. + will be sharable between desktops. See IconTheme for details. DNotify support (Linux only) @@ -168,7 +166,7 @@ $ rox --pinboard=MyPinboard The pinboard configuration is saved in - <Choices>/ROX-Filer/pb_MyPinboard + ~/.choices/rox.sourceforge.net/ROX-Filer/pb_MyPinboard as soon as you change it in some way (for example, by dropping a file onto the background). You can have as many pinboards as you like and switch between them by running rox again, eg: @@ -181,20 +179,16 @@ See the if you have trouble getting the icons to display correctly. The pinboard may also be turned on and off by locating - ROX-Filer in a filer window and choosing `Enable - pinboard' or `Disable pinboard' from the menu. + ROX-Filer in a filer window and choosing Enable + pinboard or Disable pinboard from the menu. <anchor id="run_pan" xreflabel="Panel support"/>Panels - Panels work just like the pinboard. You can create a panel on any - side of the screen by using the options , - and , depending on which side - of the screen the panel should appear on. On some systems, the short - (one letter) form of the options must be used. For example, to create - a panel along the bottom edge of the screen: + Panels work just like the pinboard, except that they run along the edge of the screen. + To create a panel: $ rox -b=MyPanel @@ -203,13 +197,17 @@ You can drag files onto either side of the panel to add them. Panel icons can be repositioned by dragging them with the middle mouse button. Changes to the panel are automatically saved to - <Choices>/ROX-Filer/pan_MyPanel. + ~/.choices/rox.sourceforge.net/ROX-Filer/pan_MyPanel. As with the pinboard, you can switch between panel configurations - simply by running rox again with a different panel name. Specify a - blank name to remove the panel. + simply by running rox again with a different panel name. - $ rox --bottom=MyOtherPanel -$ rox --bottom= + $ rox -b=MyOtherPanel + + You can set which edge of the screen the panel appears on using the popup menu. + You can also set the edge when enabling the panel by using the side instead of -b. + Specify a blank name to remove the panel: + + $ rox --bottom= @@ -748,17 +746,17 @@ $ rox --bottom= Sort in reverse order (newest to oldest, largest to smallest, etc). + Show Hidden + If on, files beginning with a dot are shown, otherwise they are hidden. + The titlebar shows (All) when this is on. + + Filter Files... Restrict the display to only show files with names matching the given pattern. The titlebar shows (Glob (pattern)) when this is on. - Show Hidden - If on, files beginning with a dot are shown, otherwise they are hidden. - The titlebar shows (All) when this is on. - - Show Thumbnails When on, the filer tries to load every image file and use that image as the file's icon. Useful if you have a directory full of @@ -1046,33 +1044,37 @@ $ rox --bottom= Each entry in this submenu opens a savebox for creating a new file or - directory. There are two standard entries; the others are the contents of - your <Choices>/Templates directory, if it + directory. There are three standard entries; the others are the contents of + your ~/.choices/rox.sourceforge.net/Templates directory, if it exists. EntryAction - - Directory + Directory Create a new directory. - - File + + + File Create a blank file. - - <user entries> + + + Customise Menu + Open the Templates directory so that you can + add extra items to the menu. + + + <user entries> Copy a file from your Templates directory. - To add your own entries, create a new directory called - ~/Choices/Templates - (if you have the default CHOICESPATH) and put any files you - want in there. Each file in the directory will appear on the menu and the - box that appears will copy it. For example, you could create a blank - HTML file: + To add your own entries, choose Customise Menu + and put any files you want in there. Each file in the directory will appear + on the menu and the box that appears will copy it. For example, you could + create a blank HTML file: <html> @@ -1210,8 +1212,9 @@ $ rox --bottom= The `Send To' menu provides a quick way to send some files to an application. - The filer scans all the SendTo directories in your - CHOICESPATH and lists the contents on this menu. + The filer scans all the $XDG_CONFIG_DIRS/rox.sourceforge.net/SendTo + directories (see BaseDir) and lists + the contents on this menu. To change which applications appear here you should choose the Customise item from the bottom @@ -1334,6 +1337,12 @@ $ rox --bottom= the pinboard menu. + + Panel Options... + Set the edge of the screen on which the panel is displayed. Only available from + the panel menu. + + @@ -1380,9 +1389,9 @@ $ rox --bottom= Create an executable file called AppletRun. This will be passed the XID of the panel socket window when the directory is dragged - onto the panel. You can use this to create a GtkPlug widget. An - example applet (written in python) is available at - + onto the panel. You can use this to create a GtkPlug widget. A + tutorial is available at + @@ -1530,8 +1539,8 @@ thumbnail for each file it scans. If a thumbnail exists it loads it and continues on to the next file. To generate a thumbnail for a given file of type media/subtype the filer looks -for a program <Choices>/MIME-thumb/media_subtype, -falling back to <Choices>/MIME-thumb/media if one +for a program ~/.choices/rox.sourceforge.net/MIME-thumb/media_subtype, +falling back to ~/.choices/rox.sourceforge.net/MIME-thumb/media if one cannot be found (this duplicates how run actions for files are looked up). If neither file can be found and the file is of type image/* then the internal routines are used. If the file is not of type image/* then no thumbnail is @@ -1753,7 +1762,7 @@ generated. For example, to select all files larger than 5Mb: - Open the Select If minibuffer. + Open the Select If minibuffer (bound to ? by dafault). @@ -2291,11 +2300,12 @@ generated. OK - saves the current choices into your Choices directory for next time + saves the current choices into your + ~/.choices/rox.sourceforge.net/ROX-Filer directory for next time ROX-Filer is loaded, if anything changed. Exactly where choices are loaded from and saved to is controlled by the - CHOICESPATH environment variable — see - Choices for details. + XDG_CONFIG_HOME environment variable — see + BaseDir for details. Changes made in the Options box take effect instantly, so you don't need to click on OK just to try them out. @@ -2396,7 +2406,8 @@ generated. you may specifiy an icon for one file individually (by name) as well as for all files of a particular type. When setting the icon for a single file, the filer stores the name of the file and the name of the icon inside - your Choices directory. If either moves, the icon won't be displayed. + your ~/.choices/rox.sourceforge.net/MIME-icons + directory. If either moves, the icon won't be displayed. When setting the icon for a directory, you have the additional option of storing the image inside the directory itself as a hidden file. This means @@ -2414,8 +2425,8 @@ generated. How filetypes are stored - ROX-Filer uses two sub-directories in your Choices - directory for filetypes: + ROX-Filer uses two sub-directories in your + ~/.choices/rox.sourceforge.net directory for filetypes: @@ -2447,21 +2458,33 @@ generated. MIME-icons contains the images used to display each type of file. So the filer will try to display an HTML file using the icon - MIME-icons/text_html.png. + MIME-icons/text_html.png. If no icon is set here, + the filer will use the currently selected icon theme (as set in the options + box); see IconTheme for details. - In both MIME-types and MIME-icons - directories you can also provide default actions/images for each media type. + In MIME-types can also provide default actions for each media type. For example, if text_html isn't found then the filer will try simply using text. + + + + + How the filer determines a file's type + + The filer usually works out the type for a file from its name. If this fails, + it tries to guess from the file's contents. It is possible to override this guessing + by setting an extended attribute on the file with the correct type, using the + Set Type... menu item. - The filer works out the type for a file from its name. The rules come from - various globs files — see - SharedMIME for details. + To edit the rules used to guess types, open the options box and go to the Types section. + There is a button there that will launch the MIME-Editor application. + You can also edit the rules manually — see SharedMIME for details. + @@ -2833,7 +2856,7 @@ generated. - GTK+ 2.0.1 or later (libraries and headers) — get the latest version + GTK+ 2.4.0 or later (libraries and headers) — get the latest version from GTK+, @@ -2854,7 +2877,7 @@ generated. ($ is the shell prompt): $ pkg-config --modversion gtk+-2.0 -2.0.5 +2.6.8 To compile: @@ -2883,12 +2906,6 @@ generated. doesn't work then please e-mail me and complain! Tell me what kind of system you have and what errors were reported. If you manage to fix the problem yourself then please e-mail me the fix. - - The executable file is stored inside the ROX-Filer directory in a - different subdirectory for each platform. Therefore, you can compile - the same application on several different types of machine and then - run it from any of them using the AppRun script. - This is particularly useful in a network environment. @@ -2966,7 +2983,11 @@ $ rehash - + + open PANEL. + + + open PANEL as a bottom-edge panel. @@ -3214,8 +3235,8 @@ means that only files ending in .c are shown. [Name]) Open the panel named Name on screen side Side (Top|Bottom|Left|Right). - Name can be a name in Choices (eg, - MyPanel) or a full pathname. + Name can be a name in ~/.choices/rox.sourceforge.net/ROX-Filer + (eg, MyPanel) or a full pathname. If not given, the panel on that side is turned off. @@ -3240,8 +3261,8 @@ then this must match the label of the item. If more than one item matches, only Pinboard([Name]) Display pinboard Name on the desktop background. - Name can be a name in Choices (eg, - MyPinboard) or a full pathname. + Name can be a name in ~/.choices/rox.sourceforge.net/ROX-Filer + (eg, MyPinboard) or a full pathname. If not given, the pinboard is turned off. @@ -3393,8 +3414,8 @@ then this must match the label of the item. If more than one item matches, only - ChoicesThe ROX Choices system, - + BaseDirThe freedesktop.org base directory system, + @@ -3414,12 +3435,17 @@ then this must match the label of the item. If more than one item matches, only WallpaperWallpaper backdrop control application - + + + + + SharedMIMEShared MIME-info Database (Version 0.16) + - SharedMIMEShared MIME-info Database (Version 0.8) - + IconThemeThe freedesktop.org Icon Theme specification + -- 2.11.4.GIT