1 <?xml version="1.0" standalone="no"?>
2 <?xml-stylesheet href="to_html.xsl" type="text/xml"?>
3 <!-- vim: set sw=1 sts=1 : -->
4 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
5 "/usr/share/sgml/docbook/dtd/xml/4.1.2/docbookx.dtd">
11 <ulink url="http://rox.sourceforge.net"/>
14 <firstname>Thomas</firstname><surname>Leonard</surname>
16 <address><email>tal197@users.sourceforge.net</email></address>
19 <copyright><year>2002</year><holder>Thomas Leonard</holder></copyright>
21 <title>Conditions</title>
23 This program is free software; you can redistribute it and/or modify
24 it under the terms of the GNU General Public License as published
25 by the Free Software Foundation; either version 2 of the License,
26 or (at your option) any later version.
28 This program is distributed in the hope that it will be useful, but
29 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
30 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
33 You should have received a copy of the GNU General Public License
34 along with this program; if not, write to the Free Software Foundation,
35 Inc., 59 Temple Place, Suite 330, Boston, MA, 02111-1307, USA.
41 <application>ROX-Filer</application> is a graphical file manger for the X
42 Window System. Its user interface is based on the RISC OS filer and it
43 supports similar features such as application directories and drag-and-drop
44 loading and saving of files. The filer can also act as a pinboard, allowing
45 you to pin frequently used files onto the desktop background.
51 <title>Introduction</title>
53 <application>ROX-Filer</application> is a simple and easy to use graphical
54 file manager for X11 — the windowing system used on Unix and Unix-like
55 operating systems. It is also the core component of the ROX Desktop
56 <citation>ROX</citation>. Many of the filer's features were inspired by RISC
57 OS <citation>RISC OS</citation>. `ROX' stands for `RISC OS–On–X'.
61 <title>Features</title>
66 <varlistentry><term>XDND</term>
68 A common drag-and-drop protocol used, for example, by the GNOME
69 desktop<citation>GNOME</citation>. This allows data to be loaded into an
70 application by dragging it from a filer window to a program. The full
71 specification is given in <citation>DND</citation>.
72 </para></listitem></varlistentry>
74 <varlistentry><term>XDS</term>
76 An extension to XDND that allows applications to save data by
77 dragging an icon back to a filer window. The full specification is given in
78 <citation>XDS</citation>.
79 </para></listitem></varlistentry>
81 <varlistentry><term>Choices</term>
83 A simple, but flexible, system for managing user choices. See
84 <citation>Choices</citation> for details.
85 </para></listitem></varlistentry>
87 <varlistentry><term>Application directories</term>
89 Self contained relocatable applications, where installation is as simple as
90 copying it to where you want it and uninstalling it is just a matter of
91 deleting a directory. Described later in this documentation.
92 </para></listitem></varlistentry>
94 <varlistentry><term>Thumbnails</term>
96 The filer can be made to display image files by using the image itself for the
97 icon, instead of a generic `this-is-an-image' icon. Very useful for organising
98 a directory full of photos! See <citation>Thumbs</citation> for details
99 (spec is still in developement).
100 </para></listitem></varlistentry>
102 <varlistentry><term>Shared MIME Info Database</term>
104 In the past, each desktop had its own database of rules for determining the
105 type of files. The Shared MIME Info Database<citation>SharedMIME</citation>
106 unifies these into a single system shared by all desktops.
107 </para></listitem></varlistentry>
116 <chapter id="compiling">
117 <title>Compiling</title>
120 If you've just got hold of the filer by downloading the source archive
121 then you'll need to compile it before you can use it. If you downloaded
122 and installed a binary package, or if <application>ROX-Filer</application>
123 was included with your system, then you can skip this section. If you got
124 here by clicking on the `i' symbol in a filer window, or if typing
125 <command>rox</command> at a shell prompt works, then you don't need to
128 <itemizedlist><title>To compile, you will need the following:</title>
131 Unix or Linux (root access is not required),
135 The X Window system (supplied as standard on all modern systems),
139 GTK+ 2.0.1 or later (libraries and headers) — get the latest version
140 from <citation>GTK+</citation>,
144 LibXML 2.0.0 or later (libraries and headers) — get the latest
145 version from <citation>libxml</citation>,
149 A C compiler, such as `gcc' (standard on most systems).
154 All of the above are standard on most modern Linux distributions.
155 To check which version of GTK+ you have installed, run the
156 <command>pkg-config</command> command, like this
157 (<prompt>$</prompt> is the shell prompt):
159 <screen>$ pkg-config --modversion gtk+-2.0
163 <procedure><title>To compile:</title>
166 The filer now uses the Shared MIME Database<citation>SharedMIME</citation>
167 to work out the types of files. You need to install this before the
168 filer will work properly (ROX-Filer will warn you if it's not installed
173 Change to the directory containing the ROX-Filer subdirectory.
177 Run the <command>install.sh</command> script, like this:
179 <screen>$ ./install.sh</screen>
184 <application>ROX-Filer</application> will perform various checks to find
185 out what kind of system it is being run on and will then compile. If it
186 doesn't work then please e-mail me and complain! Tell me what kind of
187 system you have and what errors were reported. If you manage to fix the
188 problem yourself then please e-mail me the fix.
190 The executable file is stored inside the ROX-Filer directory in a
191 different subdirectory for each platform. Therefore, you can compile
192 the same application on several different types of machine and then
193 run it from any of them using the <filename>AppRun</filename> script.
194 This is particularly useful in a network environment.
198 Once the filer has compiled you will be asked where you want to install
199 it. If you want to do a system-wide installation as root, you may
200 want to stop here, <command>su</command> to root and rerun the install
203 If you don't have the root password then don't worry — just follow
204 the instructions for installing into your home directory.
209 You can now run the filer by running the <command>rox</command> script
210 without any options, like this:
212 <screen>$ rox</screen>
214 A window should appear and display the contents of the current directory.
216 If you installed the script into your home directory then you may
217 need to set your <envar>PATH</envar> environment variable so that the shell can
218 find it. For example, if you installed it into a directory called
219 <filename>bin</filename> in your home directory, use this:
221 <screen>$ PATH=$HOME/bin:$PATH; export PATH</screen>
223 or (if you are using the <citerefentry><refentrytitle>csh</refentrytitle>
224 <manvolnum>1</manvolnum></citerefentry> shell):
226 <screen>$ setenv PATH $HOME/bin:$PATH
233 <chapter id="invoking">
234 <title>Invoking</title>
237 By default, <application>ROX-Filer</application> will start by displaying
238 the current directory. You can get it to display other directories instead
239 by listing them after the command:
241 <screen>$ rox /home /usr /usr/local</screen>
243 You can also use it to open files, like this:
245 <screen>$ rox README</screen>
247 The filer supports various options; use <option>-h</option> for a list.
248 All options have long and short forms (eg <option>-h</option> and
249 <option>--help</option>) — although on some systems you can only use the
252 Note that if the same version of the filer is already running on this
253 machine then, by default, it will be used to open the directories.
254 You can override this (perhaps because the old copy has stopped responding for
255 some reason) using the <option>--new</option> option.
257 For a complete list of command-line options, see <xref linkend="manpage"/>
261 <title><anchor id="run_pin" xreflabel="Pinboard support"/>Pinboard support</title>
264 If you want the filer to manage your desktop background then you use
265 the <option>--pinboard</option> option and supply a name for the pinboard,
268 <screen>$ rox --pinboard=MyPinboard</screen>
270 The pinboard configuration is saved in
271 <filename><Choices>/ROX-Filer/pb_MyPinboard</filename>
272 as soon as you change it in some way (for example, by dropping a file
273 onto the background). You can have as many pinboards as you like and
274 switch between them by running rox again, eg:
276 <screen>$ rox --pinboard=MyOtherPinboard</screen>
278 To turn off the pinboard again, set the name to an empty string:
280 <screen>$ rox --pinboard=</screen>
282 See the <xref linkend="winman"/> if you have trouble getting the icons to
283 display correctly. The pinboard may also be turned on and off by locating
284 <filename>ROX-Filer</filename> in a filer window and choosing `Enable
285 pinboard' or `Disable pinboard' from the menu. </para>
289 <title><anchor id="run_pan" xreflabel="Panel support"/>Panels</title>
292 Panels work just like the pinboard. You can create a panel on any
293 side of the screen by using the options <option>--left</option>, <option>--right,</option>
294 <option>--top</option> and <option>--bottom</option>, depending on which side
295 of the screen the panel should appear on. On some systems, the short
296 (one letter) form of the options must be used. For example, to create
297 a panel along the bottom edge of the screen:
299 <screen>$ rox -b=MyPanel</screen>
301 The panel should be displayed in a window without a title bar. If
302 this does not work then see the <xref linkend="winman"/> for some ideas.
303 You can drag files onto either side of the panel to add them. Panel icons
304 can be repositioned by dragging them with the middle mouse button.
305 Changes to the panel are automatically saved to
306 <filename><Choices>/ROX-Filer/pan_MyPanel</filename>.
307 As with the pinboard, you can switch between panel configurations
308 simply by running rox again with a different panel name. Specify a
309 blank name to remove the panel.
311 <screen>$ rox --bottom=MyOtherPanel
312 $ rox --bottom=</screen>
317 <title id="winman" xreflabel="window manager notes">Window manager notes</title>
319 You may have to play around with your window manager a bit to get
320 the pinboard icons and panels to display correctly (eg, without borders
321 and underneath all other windows). In particular, try setting the
322 stacking level / depth to low (or a negative value). Make sure any
323 'Keep transients above other windows' type options are turned off!
326 <sect2><title>Sawfish / sawmill</title>
328 Sawfish tries to guess whether you are using GNOME at start-up and only
329 provides support if so. You may need to add the line
330 <programlisting>(require 'gnome)</programlisting>
331 to your <filename>.sawfishrc</filename> file (see the sawfish manual
336 <sect2><title>IceWM</title>
339 Paste these configuration settings into
340 <filename>~/.icewm/preferences</filename>:
343 # Manage root window (EXPERIMENTAL - normally enabled!)
344 GrabRootWindow=1 # 0/1
345 # Bitmask of root window button click to use in window manager
346 UseRootButtons=3 # [0-255]
347 # Desktop mouse-button click to show the menu
348 DesktopWinMenuButton=1 # [0-20]
349 # Desktop mouse-button click to show the window list
350 DesktopWinListButton=2 # [0-5]
351 # Desktop mouse-button click to show the window list menu
352 DesktopMenuButton=0 # [0-20]</programlisting>
353 Paste these into <filename>~/.icewm/winoptions</filename>:
356 # ROX-Filer pinboard and panel
357 ROX-Filer.icon: folder
358 ROX-Panel.layer: Dock
359 ROX-Panel.doNotCover: 1
360 ROX-Panel.ignoreWinList: 1
361 ROX-Panel.ignoreTaskBar: 1
362 ROX-Panel.ignoreQuickSwitch: 1
363 ROX-Pinboard.layer: Below
364 ROX-Pinboard.ignoreWinList: 1
365 ROX-Pinboard.ignoreTaskBar: 1
366 ROX-Pinboard.ignoreQuickSwitch: 1
367 ROX-Filer.layer: Normal</programlisting>
368 Restart IceWM and the filer for the new settings to take effect.
373 <sect2><title>Window Maker</title>
375 <step><para>Run the filer using <userinput>rox -p=Default</userinput>.</para></step>
377 Press <keycap>Control</keycap>+<keycap>Escape</keycap>, or
378 [RightButtonDown] on any window's titlebar.
379 Choose <guimenuitem>Attributes...</guimenuitem> from the menu.
383 The Attributes Inspector window appears. From the pulldown menu
384 at the top, choose <guimenuitem>Window Specification</guimenuitem>
389 Press the <guibutton>Select window</guibutton> button.
390 The cursor changes to a double crosshair. Select one of the
391 <application>ROX-Filer</application> pinboard icons. The radio buttons
392 in the <guilabel>Window Specification</guilabel> frame should change
393 their labels to include <userinput>ROX-Pinboard.ROX-Filer</userinput>
394 as the first item. Select that radio button.
398 Choose <guimenuitem>Window Attributes</guimenuitem> from the pulldown
399 menu. In the <guilabel>Attributes</guilabel> frame, choose the
400 features you want the pinboard icons to have; I recommend the
403 <listitem><para>Disable titlebar</para></listitem>
404 <listitem><para>Disable resizebar</para></listitem>
405 <listitem><para>Disable close button</para></listitem>
406 <listitem><para>Disable miniaturize button</para></listitem>
407 <listitem><para>Keep at bottom (sunken)</para></listitem>
408 <listitem><para>Omnipresent</para></listitem>
414 Choose <guimenuitem>Advanced Options</guimenuitem> from the pulldown
415 menu. In the <guilabel>Advanced</guilabel> frame, choose the advanced
416 features you wish; I recommend the following:
419 <listitem><para>Do not show in the window list</para></listitem>
420 <listitem><para>Ignore 'Hide Others'</para></listitem>
421 <listitem><para>Ignore 'Save Session' (possibly)</para></listitem>
426 When you're finished selecting window attributes, press the
427 <guibutton>Save</guibutton> button, and then close the Attributes
428 Inspector window using the <guibutton>X</guibutton> button in the titlebar.
433 <sect2><title>Others</title>
436 If all else fails, try running rox with the <option>-n</option> and
437 <option>-o</option> options; this overrides window manager control of the
438 icons altogether (<option>-n</option> forces the filer to start a new
446 <title>Running as root</title>
449 If you run the filer as the `root' user then the filer will display
450 a message at the top of each window to remind you. The root user has
451 permission to access or change any file in the system, so be very
452 careful when using the filer like this.
454 Normally, you should log in as an ordinary user and only change to
455 root when you need to. If you have <command>sudo</command> installed
456 and set up then you can run the filer like this:
458 <screen>$ sudo rox</screen>
460 Remember, any file operations you perform and any programs you run from
461 these windows will run as root too! Be careful!
463 You may find that the X server won't allow root (or other users) to
464 connect. Reading the manual pages for <command>xauth</command> and
465 <command>xhost</command> may give you some hints, but it varies
466 between systems (which is why this isn't built in to the filer!).
473 <chapter id="keys" xreflabel="mouse and key bindings">
474 <title>Mouse button and key bindings</title>
476 <itemizedlist><title>Quick start:</title>
478 <listitem><para>Click the left
479 <footnote><para>This documentation assumes that button–1 is the left
480 button, button–2 is the middle button and button–3 is the
481 right button. This is not always the case — for example, in a
482 left-handed setup.</para></footnote> mouse button to open files and
483 directories.</para></listitem>
486 Click the right button to get a menu. Click over a file to perform an action on that file.
490 Drag files between windows with the left button to copy them, or with
491 the middle button to get a menu of possible actions (copy, move, link,
498 By default, the mouse button bindings are designed to fit in with X
499 conventions. However, the behaviour is highly configurable — have a play in
500 the Options window if you don't like the normal settings. The normal settings
506 <thead><row><entry>Key or mouse button</entry><entry>Action</entry></row></thead>
510 <row><entry>Left button click</entry><entry>
511 Open the file or directory clicked on. Hold down <keycap>Control</keycap>
512 to select things instead of opening them. Hold down <keycap>Shift</keycap>
513 to look inside applications, treat files as text, follow symlinks or
517 <row><entry>Middle button click</entry><entry>
518 Same as left click, but open a directory in a new window or close the viewer
522 <row><entry>Right button click</entry><entry>
523 Open the main menu. Hold down <keycap>Control</keycap> while clicking to go
524 directly to the Selection submenu. Hold down <keycap>Shift</keycap> to get the
525 <guimenu>Send To</guimenu> menu (see the <xref linkend="SendTo"/> section).
528 <row><entry>Drag an item (left mouse button)</entry><entry>
529 Copy the file(s) to the destination (an application or another filer
530 window). Hold down <keycap>Shift</keycap> to move the file,
531 <keycap>Control</keycap>+<keycap>Shift</keycap> to create
532 a symbolic link, or <keycap>Alt</keycap> to get a menu of possible actions.
535 <row><entry>Drag an item (middle mouse button)</entry><entry>
536 When you let go, display a menu of possible actions.
537 There is an option to make this move the files rather than open the menu.
540 <row><entry>Drag (not over an item)</entry><entry>
541 Select a group of items by dragging a box around them. With the left
542 mouse button, only the files in the box will be selected. If you hold
543 down <keycap>Control</keycap> then the boxed items are added to the selection.
544 If you use the middle button then the boxed items switch between being selected
548 <row><entry>Double-click background</entry><entry>
549 Resize the window to a sensible size.
552 <row><entry><keycap>Backspace</keycap></entry><entry>
553 Change to viewing the parent directory.
556 <row><entry>Cursor keys</entry><entry>
557 Move the cursor around.
561 <keycap>Page Up</keycap>, <keycap>Page Down</keycap></entry><entry>
562 Move the cursor up and down a page at a time.
565 <row><entry><keycap>Home</keycap>, <keycap>End</keycap></entry><entry>
566 Move to the first/last entry in the directory.
569 <row><entry><keycap>Return</keycap></entry><entry>
570 Acts like clicking on the file. You may hold down Shift for other
571 effects, as with clicking.
574 <row><entry><keycap>Spacebar</keycap></entry><entry>
575 Toggles the item under the cursor between being selected and unselected,
576 and moves to the next item.
579 <row><entry><keycap>Tab</keycap>, <keycap>Shift</keycap>+<keycap>Tab</keycap></entry><entry>
580 Moves the cursor to the next/previous selected item.
583 <row><entry>Hold mouse over an item</entry><entry>
584 Shows a tooltip containing a brief description of an application (if
585 available), the target of a symbolic link, and the full name of a file,
586 if it's too long to show in the main window.
589 </tbody></tgroup></informaltable>
592 If you have user-defineable key-bindings enabled, then other keys can easily
593 be set by opening the menu, moving the pointer over the item you want to use
594 and pressing a key. The key will appear in the menu and can be used from
595 then on. Key bindings are automatically saved when the filer quits.
596 You can use an XSettings manager, such as ROX-Session, to turn this feature
597 on for all Gtk+-2.0 applications.
601 <chapter id="selection">
602 <title>The selection and file groups</title>
604 When you select items in a <application>ROX-Filer</application> window,
605 the filer takes the <emphasis>primary selection</emphasis>. You can then paste
606 into another window to get the pathnames of the selected files.
610 <title>Example: loading a file into an application that doesn't support
611 drag-and-drop:</title>
613 <step><para>Open the application's Open dialog box.</para></step>
616 <keycap>Control</keycap>-click on the file in
617 <application>ROX-Filer</application> to select it.</para></step>
620 Click the middle button in the filename box in the application to paste the
626 Note that clicking the middle mouse button in the main area of most web-browsers
627 will open the selected file.
629 If you select something else (eg, some text in another program), the selected
630 items in the filer window will be shown shaded (the filer no longer has the
631 primary selection). Clicking on one of the shaded items will cause the
632 filer to regain the primary selection.
635 <sect1><title>Saving and restoring the selection</title>
637 It is sometimes useful to save the current selection for later. You can
638 save the current selection to one of ten numbered groups by pressing
639 <keycap>Control</keycap>+<keycap><number></keycap>.
640 You can restore a saved group by pressing the group number on its own. You
641 can do this from a different directory, or even a different filer window.
643 Saving is also useful even if there is no selection, since it still saves
644 the current directory.
646 <procedure><title>Example: saving a directory and returning to it later:</title>
647 <step><para>You are looking at a directory, and wish to remember it.
648 Press <keycap>Control</keycap>+<keycap>1</keycap>.</para></step>
649 <step><para>Move to another directory, or close the window, etc.</para></step>
650 <step><para>Press <keycap>1</keycap> in any filer window to return
651 to the first directory.</para></step> </procedure>
652 <para>The groups are saved automatically for next time the filer is loaded.
656 <chapter id="toolbar">
657 <title><anchor id="Toolbar" xreflabel="Toolbar"/>The toolbar</title>
660 By default, each window has a toolbar along the top. You can disable
661 this (or make it larger) from the Options window, as well as set which
662 tools appear on the toolbar. Normally, you should click with the left
663 mouse button (1). However, many tools can perform a related function
664 if clicked on with buttons 2 or 3 (middle or right).
667 <informaltable><tgroup cols="3">
672 Mouse button 1</entry><entry>
681 Close the window</entry><entry>
683 </entry></row><row><entry>
684 Up arrow</entry><entry>
685 Change to parent directory</entry><entry>
686 Show parent in a new window <xref linkend="newwin_fn"/>
687 </entry></row><row><entry>
689 Change to home directory</entry><entry>
690 Show home in a new window <xref linkend="newwin_fn"/>
691 </entry></row><row><entry>
692 Looping arrows</entry><entry>
693 Reread the directory contents</entry><entry>
695 </entry></row><row><entry>
696 Magnifying glass</entry><entry>
697 Make icons bigger</entry><entry>
699 </entry></row><row><entry>
701 Hide or show extra details</entry><entry>
703 </entry></row><row><entry>
704 Dot files</entry><entry>
705 Toggle the display of hidden file (those with names starting with a dot)</entry><entry>
707 </entry></row><row><entry>
708 Information</entry><entry>
709 Show <application>ROX-Filer</application>'s help files</entry><entry>
710 Show help files and close window
712 </tbody></tgroup></informaltable>
715 <anchor id="newwin_fn" xreflabel="[1]"/>[1]
716 If the 'New window on button 1' option is turned on
717 then the default is to open a new window — clicking with the other
718 button reuses the same window instead.
722 Dragging files to the Up or Home icons acts just like dragging them
723 into the directory which the button leads to.
725 The toolbar can also show the number of files in the directory, and
726 information about the selection. This can be turned on or off in the
734 <title>The menus</title>
736 By default, you can open a menu by right clicking over a pinboard, panel or
739 In filer windows, you may also press <keycap>\</keycap> to open the menu. As
740 a shortcut, you can open the File submenu directly by holding down the
741 <keycap>Control</keycap> key when opening the menu. Here is a full
742 description of each menu item:
744 <informaltable><tgroup cols="2">
746 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
749 <row><entry><guimenuitem>Display</guimenuitem></entry><entry>
750 Change the display settings.
753 <row><entry><guimenuitem>File</guimenuitem></entry><entry>
754 Operations on the selected items.
757 <row><entry><guimenuitem>Select</guimenuitem></entry><entry>
758 Control which items are selected.
761 <row><entry><guimenuitem>Options...</guimenuitem></entry><entry>
762 Configure <application>ROX-Filer</application>.
765 <row><entry><guimenuitem>New</guimenuitem></entry><entry>
766 Create a new file or subdirectory inside this directory.
769 <row><entry><guimenuitem>Window</guimenuitem></entry><entry>
770 Operations on the window as a whole.
773 </tbody></tgroup></informaltable>
778 <title>The display menu</title>
781 <informaltable><tgroup cols="2">
783 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
786 <row><entry><guimenuitem>Huge Icons</guimenuitem></entry><entry>
787 Extra large icons (mainly useful with thumbnails, see below).
788 </entry></row><row><entry>
790 <guimenuitem>Large Icons</guimenuitem></entry><entry>
791 Each object in the directory is shown as a large icon with its name
793 </entry></row><row><entry>
795 <guimenuitem>Small Icons</guimenuitem></entry><entry>
796 Items are drawn smaller than usual, allowing you to see more files
798 </entry></row><row><entry>
800 <guimenuitem>Huge, With...</guimenuitem></entry><entry>
801 As for <guimenuitem>Large, With...</guimenuitem>, but with extra large icons.
802 </entry></row><row><entry>
804 <guimenuitem>Large, With...</guimenuitem></entry><entry>
805 <para>Entries are displayed along with some extra details:</para>
808 <listitem><para><guimenuitem>Summary</guimenuitem>
809 shows the file permissions, owner, group, size and modification time.
812 <listitem><para><guimenuitem>Sizes</guimenuitem>
813 shows just the size of each file (not directories).
816 <listitem><para><guimenuitem>Permissions</guimenuitem>
817 shows just the permissions and owner.
820 <listitem><para><guimenuitem>Type</guimenuitem>
821 shows the MIME type of each file.
824 <listitem><para><guimenuitem>Times</guimenuitem>
825 shows the times the file was last accessed, modifed and changed.
826 Reading a file's contents or listing a directory updates the
827 <emphasis>access time</emphasis>; modifying the contents of a file or
828 the list of files in a directory updates the <emphasis>modification
829 time</emphasis>; changing a file's owner or permissions updates the
830 <emphasis>change time</emphasis>.
835 </entry></row><row><entry>
837 <guimenuitem>Small, With...</guimenuitem></entry><entry>
838 As above, but with a smaller icon and all on one line.
839 </entry></row><row><entry>
841 <guimenuitem>Sort by Name</guimenuitem></entry><entry>
842 Items are arranged by name. The default sort mode is case-insensitive
843 and deals with numbers sensibly. There is an option to use straight
845 </entry></row><row><entry>
847 <guimenuitem>Sort by Type</guimenuitem></entry><entry>
848 Items are grouped by their types and then sorted by name within the
850 </entry></row><row><entry>
852 <guimenuitem>Sort by Date</guimenuitem></entry><entry>
853 Most recently modified first.
854 </entry></row><row><entry>
856 <guimenuitem>Sort by Size</guimenuitem></entry><entry>
858 </entry></row><row><entry>
860 <guimenuitem>Show Hidden</guimenuitem></entry><entry>
861 If on, files beginning with a dot are shown, otherwise they are hidden.
862 The titlebar shows <guilabel>(All)</guilabel> when this is on.
863 </entry></row><row><entry>
865 <guimenuitem>Show Thumbnails</guimenuitem></entry><entry>
866 When on, the filer tries to load every image file and use that
867 image as the file's icon. Useful if you have a directory full of
868 photos and can't remember which is which!
869 The thumbnails are saved in <filename>~/.thumbnails</filename> for
870 quick loading next time.
871 While loading thumbnails, a progress bar appears at the bottom of
872 the window. Clicking on the <guibutton>Cancel</guibutton> button
873 beside the bar stops the scan.
874 The titlebar shows <guilabel>(Thumbs)</guilabel> when this is on.
875 </entry></row><row><entry>
877 <guimenuitem>Refresh</guimenuitem></entry><entry>
878 Rereads the contents of the directory and details of all the files
879 in it. Use this if the display becomes out-of-date.
882 </tbody></tgroup></informaltable>
886 <sect2><title><anchor id="Permissions" xreflabel="Permissions"/>
891 The permissions field, when shown, is made up of four groups of three
892 flags. Each flag is displayed as a letter if it is on and a dash (–)
893 if not. The first three characters show the permissions for the owner
894 of the file, the second for other members of the file's group and
895 the third for everyone else. Whichever group applies to the
896 <application>ROX-Filer</application> process itself is shown underlined.
897 The fourth group shows any special flags.
899 The meanings of the characters are:
903 <listitem><para><computeroutput>r</computeroutput> —
904 Permission to read the contents of a file, or the names of files
905 in a directory.</para></listitem>
907 <listitem><para><computeroutput>w</computeroutput> —
908 Permission to alter the contents of a file, or change which names
909 appear in a directory.</para></listitem>
911 <listitem><para><computeroutput>x</computeroutput> —
912 Permission to run the file as a program, or refer to the files
913 listed within the directory.</para></listitem>
915 <listitem><para><computeroutput>U</computeroutput> —
916 This program executes with the <emphasis>effective user ID</emphasis> of its
917 owner rather than the person who ran it.</para></listitem>
919 <listitem><para><computeroutput>G</computeroutput> —
920 This program executes with the <emphasis>effective group ID</emphasis> of its
921 group, regardless of who ran it.</para></listitem>
923 <listitem><para><computeroutput>T</computeroutput> —
924 Entries in this directory can only be altered or removed by the
925 people who own the files even if they have write permission on the
926 directory itself.</para></listitem>
931 <emphasis role="underline">rwx</emphasis>,rwx,r-x/---</programlisting>
932 means that the owner of the file is the same as the effective user of
933 <application>ROX-Filer</application> (basically, you own the file), you and
934 members of the file's group have read, write and execute permission and other
935 people have only read and execute permission. There are no special flags set.
937 The rules which determine which permissions apply may vary slightly between
938 operating systems, but a rough guide is:
942 <listitem><para>If the <emphasis>effective user ID</emphasis> of the
943 process is equal to the file's owner, then the owner permissions apply.
946 <listitem><para>Otherwise, if the <emphasis>effective group ID</emphasis>
947 of the process is equal to the file's group OR the file's group is one
948 of the process's <emphasis>supplemental groups</emphasis> then the
949 group permissions apply.
952 <listitem><para>Otherwise, the `other' permissions apply. The
953 <emphasis>real user ID</emphasis> and <emphasis>real group
954 ID</emphasis> have no effect (except that a process may set its real
955 IDs to its effective IDs).
965 <title>The file menu</title>
967 All of these work in the same way — if you open the menu with some
968 items selected then the operation applies to those items. If you open
969 then menu over an item while there is no selection then that item
970 is temporarily selected.
972 If you choose one of these while there is no selection at all then the
973 window goes into `target mode'; the operation happens to the next item you
974 click on. Click on the window background, press <keycap>Escape</keycap>, or
975 click with the right mouse button to cancel target mode. Target mode is
976 mainly useful with the <guilabel>Single-click navigation in filer
977 windows</guilabel> option and keys bound to the various menu entries.
979 Note that individual applications may add extra menu items to the
980 top of this submenu when you click over them — see
981 <xref linkend="AppDir"/> for details.
983 <informaltable><tgroup cols="2">
984 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
988 <guimenuitem>Copy...</guimenuitem></entry><entry>
989 Make a copy of this object.
993 <guimenuitem>Rename...</guimenuitem></entry><entry>
994 Change the name used for this object, or move it between directories.
998 <guimenuitem>Link...</guimenuitem></entry><entry>
999 Create a symbolic link to this name.
1003 <guimenuitem>Shift Open</guimenuitem></entry><entry>
1004 Opens applications as directories, files as text/plain, mount points by
1005 mounting or unmounting them and symlinks by opening the directory containing
1006 the thing they point to. This is the same effect as clicking with
1007 <keycap>Shift</keycap> held down. The text of the menu entry changes
1008 to show which action will be performed.
1012 <guimenuitem>Help</guimenuitem></entry><entry>
1013 Explain what kind of thing is selected. For applications, display
1018 <guimenuitem>Info</guimenuitem></entry><entry>
1019 Display extra information about this object.
1023 <guimenuitem>Set Run Action...</guimenuitem></entry><entry>
1024 Allows you to set the default program to use when opening files of
1025 this type. See <xref linkend="RunAction"/> section for details.
1029 <guimenuitem>Set Icon...</guimenuitem></entry><entry>
1030 You can give each file or directory its own special icon using this
1031 feature — simply drag a suitable image onto <xref linkend="SetIcon"/>.
1035 <guimenuitem>Open AVFS</guimenuitem></entry><entry>
1036 Open the file as if it was a directory — see the
1037 <xref linkend="vfs"/> section.
1041 <guimenuitem>Send To...</guimenuitem></entry><entry>
1042 Opens the `Send To' menu, allowing you to send the selected files
1043 to one of a list of applications. See the
1044 <xref linkend="SendTo"/> section.
1048 <guimenuitem>Delete</guimenuitem></entry><entry>
1049 Remove all the selected entries from the directory. Subdirectories
1050 will have their contents deleted first. Deleting symlinks only removes
1051 the link, not the thing it points to.
1055 <guimenuitem>Disk Usage</guimenuitem></entry><entry>
1056 Count the sizes of all the selected items. Directories also have their
1057 contents counted. Symlinks count themselves, not the things they point
1062 <guimenuitem>Permissions</guimenuitem></entry><entry>
1063 Allows you to change the permissions for the selected files.
1067 <guimenuitem>Find</guimenuitem></entry><entry>
1068 Search for files by specifying various conditions — see the
1069 <xref linkend="Searching"/> section.
1072 </tbody></tgroup></informaltable>
1075 <formalpara><title>Note about symlinks:</title>
1077 A symbolic link stores the <emphasis>location</emphasis>
1078 of another file. Deleting the symlink doesn't affect the other file.
1079 Deleting the other file means that the symlink won't work. There are
1080 two types of symbolic link — Relative and Absolute. An absolute
1081 link stores the path from the root directory to the target file (eg
1082 <filename>/home/fred/MyFile</filename>).
1084 A relative path stores the path from the symlink
1085 to the target (eg <filename>../fred/MyFile</filename>).
1086 If the target file is never going to move then you want an absolute link,
1087 but if the target may move (and the symlink will be moved with it) then
1088 you want a relative link.
1094 <title>The select menu</title>
1096 This menu allows you to select and unselect files in various ways. See the
1097 <xref linkend="keys"/> section for other ways to select files.
1099 <informaltable><tgroup cols="2">
1100 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
1103 <guimenuitem>Select All</guimenuitem></entry><entry>
1104 Select every item in this window.
1107 <row><entry><guimenuitem>Clear Selection</guimenuitem></entry><entry>
1108 Unselect every item in this window.
1111 <row><entry><guimenuitem>Invert Selection</guimenuitem></entry><entry>
1112 Every selected file becomes unselected, and every unselected file
1117 <guimenuitem>Select If...</guimenuitem></entry><entry>
1118 Select just those files that match the given pattern —
1119 see the <xref linkend="SelectIf"/> section.
1122 </tbody></tgroup></informaltable>
1128 <title>The new menu</title>
1131 Each entry in this submenu opens a savebox for creating a new file or
1132 directory. There are two standard entries; the others are the contents of
1133 your <filename><Choices>/Templates</filename> directory, if it
1137 <informaltable><tgroup cols="2">
1138 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
1141 Directory</entry><entry>
1142 Create a new directory.
1143 </entry></row><row><entry>
1145 Create a blank file.
1146 </entry></row><row><entry>
1147 <user entries></entry><entry>
1148 Copy a file from your Templates directory.
1150 </tbody></tgroup></informaltable>
1153 To add your own entries, create a new directory called
1154 <filename>~/Choices/Templates</filename>
1155 (if you have the default <envar>CHOICESPATH</envar>) and put any files you
1156 want in there. Each file in the directory will appear on the menu and the
1157 box that appears will copy it. For example, you could create a blank
1163 <title>My Page</title>
1168 </html></programlisting>
1170 Save this as <filename>index.html</filename> inside the
1171 <filename>Templates</filename> directory and you can easily create new
1172 HTML files. You can also save blank documents from various applications
1173 into here (eg, a blank spreadsheet, a blank letter, etc).
1175 Note that you cannot set keyboard shortcuts for these user-defined
1182 <title>The window menu</title>
1186 <informaltable><tgroup cols="2">
1187 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
1190 <guimenuitem>Parent, New Window</guimenuitem></entry><entry>
1191 Open a new window displaying this window's parent.
1195 <guimenuitem>Parent, Same Window</guimenuitem></entry><entry>
1196 As above, but reuse this window.
1200 <guimenuitem>New Window</guimenuitem></entry><entry>
1201 Open another window onto this directory.
1205 <guimenuitem>Home Directory</guimenuitem></entry><entry>
1206 Change to your home directory.
1210 <guimenuitem>Follow Symbolic Links</guimenuitem></entry><entry>
1211 Converts the path shown in the window's titlebar to its canonical form.
1212 For example, if <filename>/home/fred/link</filename> is a symlink
1213 pointing to <filename>/usr/share/doc/</filename> then clicking on the symlink
1214 will take you to that directory and going `up' will take you back to
1215 <filename>/home/fred</filename>.
1216 If you'd used <guimenuitem>Follow Symbolic Links</guimenuitem>, you would
1217 have ended up in <filename>/usr/share</filename> instead.
1221 <guimenuitem>Resize Window</guimenuitem></entry><entry>
1222 Set the window to a sensible size for its contents.
1226 <guimenuitem>Close Window</guimenuitem></entry><entry>
1231 <guimenuitem>Enter Path...</guimenuitem></entry><entry>
1232 Open the path-entry box (see the the <xref linkend="mini"/> section).
1236 <guimenuitem>Shell Command...</guimenuitem></entry><entry>
1237 Open the shell command box (see the <xref linkend="mini"/> section).
1240 <row><entry><guimenuitem>Xterm Here</guimenuitem></entry><entry>
1241 Open an xterm with its current directory set to this directory.
1244 <row><entry><guimenuitem>Switch to xterm</guimenuitem></entry><entry>
1245 Open an xterm with its current directory set to this directory, and close the
1246 filer window at the same time.
1250 <guimenuitem>Show ROX-Filer Help</guimenuitem></entry><entry>
1251 Same as selecting ROX-Filer and choosing
1252 <guimenuitem>Help</guimenuitem> from the menu.
1255 </tbody></tgroup></informaltable>
1262 <title><anchor id="SendTo" xreflabel="Send To menu"/>The send to menu</title>
1265 The `Send To' menu provides a quick way to send some files to an application.
1266 The filer scans all the <filename>SendTo</filename> directories in your
1267 <envar>CHOICESPATH</envar> and lists the contents on this menu.
1269 To change which applications appear here you should choose the
1270 <guimenuitem>Customise</guimenuitem> item from the bottom
1271 of the menu to create and open your own <filename>SendTo</filename>
1272 directory. Applications can be symlinked into this directory by dragging
1273 them in with <keycap>Control</keycap> and <keycap>Shift</keycap> held down.
1275 Opening the Send To menu via the main menu is rather slow, so it is
1276 normally opened by clicking the Menu mouse button over a file while
1277 holding the <keycap>Shift</keycap> key down.
1280 <title>Showing different applications for different types</title>
1282 You may want to set things up so that, for example, the Gimp is
1283 only shown when an image is selected. To do this, create a
1284 hidden directory inside <filename>SendTo</filename> called
1285 <filename>.image</filename>, or whatever type you want to use.
1286 You can use either the complete type (eg <filename>.image_png</filename>)
1287 or just the media type. Use <guimenuitem>Info</guimenuitem> over a file to
1288 find out its MIME type.
1291 Entries in these hidden directories are shown only for files of
1292 the appropriate type. If multiple files are selected, the
1293 <filename>.group</filename> directory is used instead.
1300 <chapter id="icons">
1301 <title>The pinboard and panels</title>
1304 The <xref linkend="run_pin"/> and <xref linkend="run_pan"/> sections explain
1305 how to turn the pinboard and panels on. Once on, you may drop items from filer
1306 windows onto the them to pin them up. Clicking on a pinned item acts just like
1307 clicking on it in a filer window. You can drag pinned icons just like normal
1308 icons and you can right-click on one to see the popup menu.
1310 Drag panel icons with the middle mouse button to move them around.
1311 In previous versions of the filer, pinboard icons were also moved using the
1312 middle mouse button. This may still work (depending on your window manager),
1313 but using the left mouse button is now preferred.
1315 Changes to the pinboard and panel are automatically saved. Clicking on pinned
1316 icons with <keycap>Control</keycap> held down selects and unselects them.
1317 Click on the background to unselect them all.
1319 If the panel has so many icons that they can't all be shown at once
1320 then you can scroll it by dragging the blank area in the middle.
1324 Pinning a file does <emphasis>not</emphasis> copy it, it merely
1325 creates a shortcut to the original file. If you delete the file, then
1326 you've lost it! Removing a pinned file from its pinboard or panel
1327 only removes the link. This is different to most other filers...
1331 <title>The pinboard and panel menus</title>
1334 <informaltable><tgroup cols="2">
1335 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
1339 <guimenuitem>ROX-Filer</guimenuitem></entry><entry>
1340 Show the filer's help, edit the options or open your home directory.
1344 <guimenuitem>File `file'</guimenuitem></entry><entry>
1345 Offers a smaller version of the filer's submenu of the same name.
1349 <guimenuitem>Edit Item</guimenuitem></entry><entry>
1350 Change the name displayed under the icon, or the pathname the item
1355 <guimenuitem>Show Location</guimenuitem></entry><entry>
1356 Open a directory viewer showing where the file is stored.
1360 <guimenuitem>Remove Item(s)</guimenuitem></entry><entry>
1361 Remove the selected items from the pinboard or panel.
1365 <guimenuitem>Backdrop...</guimenuitem></entry><entry>
1366 Set the desktop backdrop image (see below). Only available from
1370 </tbody></tgroup></informaltable>
1373 If you are setting up the defaults for multiple users and
1374 you wish to create a `Home' icon that leads to each user's home directory
1375 then you should first create a new icon and then use
1376 <guimenuitem>Edit Icon</guimenuitem> to change the location to
1377 <filename>~</filename> and the name to `Home'.
1379 Note that individual applications may add extra menu items to the
1380 top of this menu when you click over them — see <xref linkend="AppDir"/>
1386 <title>Panel applets</title>
1389 <application>ROX-Filer</application> allows you to run small programs
1390 inside the panel — such programs are called
1391 <emphasis>applets</emphasis>. To run an applet, drag it onto the panel from
1392 a filer window and instead of the applet's icon being shown, the applet
1396 <procedure><title>To create your own applets (programmers only!):</title>
1399 Create a directory for the applet (eg <filename>MyApplet</filename>).
1403 Use the <guimenuitem>Set Icon...</guimenuitem> feature to create an icon
1404 called <filename>.DirIcon</filename> inside it (so the directory appears
1409 Make a <filename>Help</filename> directory inside it for when the user
1410 chooses <guimenuitem>Help</guimenuitem> from the menu.
1414 Create an executable file called <filename>AppletRun</filename>. This will be
1415 passed the XID of the panel socket window when the directory is dragged
1416 onto the panel. You can use this to create a GtkPlug widget. An
1417 example applet (written in python) is available at
1418 <ulink url="http://rox.sourceforge.net/applets.php3"/>
1425 <title><anchor id="iconify" xreflabel="Iconified windows"/>Iconified windows on the pinboard</title>
1427 When the pinboard is in use, ROX-Filer can be used to display an icon for each iconified
1428 (or 'minimised') window. You can turn this on or off from the Options box. Iconified window icons
1429 highlight when you move the mouse over them and can be dragged around.
1430 Clicking on one will expand it back into the window it represents. Some older window managers do not
1431 support this, and no icons will be shown.
1436 <title><anchor id="backdropapp" xreflabel="Backdrop applications"/>The pinboard backdrop image</title>
1438 You can set any image for the backdrop by choosing <guimenuitem>Backdrop...</guimenuitem>
1439 from the pinboard menu (right-click over the desktop background when the pinboard is turned on).
1442 To set an image, select <guilabel>Centred</guilabel>, <guilabel>Scaled</guilabel> or
1443 <guilabel>Tiled</guilabel> to set the style, and then drag an image onto the marked area.
1444 To return to a solid colour backdrop (as set in the Options box), click on
1445 <guibutton>Clear</guibutton>.
1447 <formalpara><title>For programmers...</title>
1449 If you want to create an application to set the backdrop (eg, to choose a
1450 random image, or a slideshow) you need to first create an application directory
1451 (see <xref linkend="AppDir"/>).
1454 When run without arguments, the application should invoke the
1455 <function>SetBackdropApp</function> SOAP method (see <xref
1456 linkend="soap"/>). The filer will immediately run the application again,
1457 this time with the <option>--backdrop</option> option.
1459 When run with <option>--backdrop</option>, the program should write the style and name of
1460 the image file to display to its standard output stream, eg:
1461 <screen>tile /tmp/image.png</screen>
1462 <userinput>centre</userinput> and <userinput>scale</userinput> are the other possible
1463 styles. The filer will then load this image and display it. The application does not
1464 set the backdrop itself, it only tells the filer what to display.
1466 In the case of a random backdrop chooser, the program may then quit immediately. If
1467 the application created a temporary image then it should read the line "ok\n" from its
1468 standard input before deleting the image.
1470 If the application wishes to show a sequence of images it should still read "ok\n",
1471 then wait until it's time to display the next image and then write that filename, and
1474 The filer will indicate that the program should stop running by closing the two
1475 streams. The program should clean up and exit at this point. Be sure to catch
1476 SIGPIPE when writing to standard output if you need to delete any temporary files.
1478 This example program will display an image of the Earth on the backdrop, updating it
1479 once a minute. Note the three places we check for the filer closing its connection with
1480 us: when sending the image, when waiting for acknowledgement, and while sleeping.
1481 This file should be saved as <filename>AppRun</filename> inside your new application
1482 directory. To set the backdrop, run the application (eg, by clicking on it).
1483 <programlisting><![CDATA[
1484 #!/usr/bin/env python
1488 if len(sys.argv) == 1:
1489 # Become the backdrop application
1490 app = os.path.abspath(os.path.dirname(sys.argv[0]))
1491 cin = os.popen('rox -R', 'w')
1492 cin.write("""<?xml version="1.0"?>
1493 <env:Envelope xmlns:env="http://www.w3.org/2001/12/soap-envelope">
1494 <env:Body xmlns="http://rox.sourceforge.net/SOAP/ROX-Filer">
1495 <SetBackdropApp><App>""" + app + """</App></SetBackdropApp>
1500 elif len(sys.argv) != 2 or sys.argv[1] != '--backdrop':
1501 sys.stderr.write("Usage: %s [--backdrop]\n" % sys.argv[0])
1504 # If we get here, we've been run by the filer.
1505 # Generate a sequence of images, sending them to the filer one by one.
1507 import tempfile, time, signal
1508 from select import select
1510 time_between_updates = 60
1513 # Write image to a temporary file
1514 path = tempfile.mktemp('.ppm')
1517 fd = os.open(path, os.O_CREAT | os.O_WRONLY | os.O_TRUNC, 0600)
1519 os.execvp("xearth", ["xearth", "-ppm"])
1521 pid, status = os.waitpid(child, 0)
1523 break # xearth didn't work
1525 # Send message to filer
1528 print "centre " + path
1530 if sys.stdin.readline() != 'ok\n':
1531 quit = 1 # filer closed connection
1533 quit = 1 # filer closed connection
1534 # Delete temporary file
1539 # Wait until the next image is due, or the filer tells us to quit
1540 ready = select([sys.stdin], [], [], time_between_updates)[0]
1542 # filer closed connection while we were waiting
1550 <chapter id="virtual">
1552 <anchor id="vfs" xreflabel="Virtual file systems"/>Virtual file systems
1555 Some types of file can be represented as a directory. A typical example
1556 is a zip file, which contains an entire directory structure in compressed
1557 form. It is often useful to be able to open up such a file as if it
1558 was a real directory, and the VFS system allows you to do this.
1560 To use this feature you must have a system such as
1561 AVFS<citation>AVFS</citation> installed, which causes the kernel to support
1562 various Virtual File Systems directly.
1567 <chapter id="minibuffer">
1568 <title><anchor id="mini" xreflabel="Minibuffer"/>The mini-buffer</title>
1571 The mini-buffer is a white bar that appears along the bottom of the
1572 window and allows you to enter some text. Press <keycap>Escape</keycap> to
1573 get rid of it again. It behaves in different ways depending on how you
1578 <title>The path-entry box</title>
1581 This allows you to type in a path directly. As you type the display
1582 is updated to show the item entered visually. The main use is to find
1583 a file in a large directory quickly, but you can also use it for navigating
1584 between directories, or for selecting a full pathname from somewhere
1585 else and pasting it directly into the path-entry box.
1588 <informaltable><tgroup cols="2">
1589 <thead><row><entry>Key</entry><entry>Action</entry></row></thead>
1593 <keycap>Return</keycap></entry><entry>
1594 Open the currently selected item.
1598 <keycap>Tab</keycap></entry><entry>
1599 Shell-style tab completion.
1603 <keycap>Up</keycap>, <keycap>Down</keycap></entry><entry>
1604 Select the previous/next matching entry.
1606 </tbody></tgroup></informaltable>
1611 If you start entering a name beginning with a `.' then the `Show Hidden'
1612 feature is temporarily turned on so that the file can be shown.
1616 Tab completion tries to fill in as many characters for you as it can.
1617 For example, if there are two files in a directory called
1618 <filename>save-mail-nov-1999</filename> and
1619 <filename>save-mail-dec-1999</filename> then typing
1620 <userinput>save</userinput> and pressing <keycap>Tab</keycap> will expand
1621 <userinput>save</userinput> to <userinput>save-mail-</userinput> and beep
1622 to indicate that the match is not complete. If you use tab completion on a
1623 directory and it is unique then the filer will automatically change into
1624 the directory. This behavior should be familiar to shell users.
1627 <informalexample><para>
1628 Let's say you want to locate the documentation for Wine in the directory
1629 <filename>/usr/share/doc</filename> (which is usually very large).
1630 Here's how you could do it:
1635 Open the minibuffer by choosing <guimenuitem>Enter
1636 Path...</guimenuitem> from the <guimenu>Window</guimenu> menu, or
1637 by pressing the slash (<keycap>/</keycap>) key.
1641 Press <keycap>CTRL</keycap>+<keycap>A</keycap> to select the existing
1647 <userinput>u<Tab>sh<Tab>do<Tab>wi<Tab></userinput>.
1648 As you type, the cursor will move to the correct subdirectory.
1649 If it beeps when you press <keycap>Tab</keycap> then you need to supply
1650 more letters, or press <keycap>Return</keycap>.
1655 </para></informalexample>
1659 <title>The shell command box</title>
1662 This provides a quick way of entering shell commands if you don't
1663 want to open an xterm. If you don't know what shell commands are,
1666 Just type in the command and press <keycap>Return</keycap> to execute it.
1667 <keycap>Up</keycap> and <keycap>Down</keycap> arrows move through previously
1669 <keycap>Tab</keycap> does shell-style completion.
1670 Clicking on an item inserts its name into the minibuffer.
1671 If some items are selected then they are assigned to the positional
1672 parameters <userinput>$1</userinput>, <userinput>$2</userinput>, etc.
1674 Opening the minibuffer with a selection adds <computeroutput>"$@"</computeroutput>
1675 to the end of the command — this expands to all the selected files.
1678 <informalexample><para>Examples:
1680 <orderedlist><title>To untar a <filename>.tgz</filename> archive:</title>
1683 Open the minibuffer by choosing <guimenuitem>Shell Command...</guimenuitem> from
1684 the <guimenu>Window</guimenu> menu.
1685 I usually bind this to the bang (<keycap>!</keycap>) key.
1689 Type <userinput>tar xzf</userinput> and click on the file.
1690 The leading space is automatically inserted.
1694 Press <keycap>Return</keycap> to execute it.
1699 <orderedlist><title>To print all the selected files:</title>
1702 Open the shell command minibuffer.
1706 Type <userinput>lpr</userinput> at the beginning of the line and press
1707 <keycap>Return</keycap>.
1712 </para></informalexample>
1714 <itemizedlist><title>Notes</title>
1717 Be careful; you will not be asked to confirm! If in doubt, start the
1718 command with <userinput>xmessage</userinput> so that it will be displayed
1719 rather than executed.
1723 <citerefentry><refentrytitle>sh</refentrytitle></citerefentry>
1724 is always used as the name of the shell to run (mainly because
1725 <citerefentry><refentrytitle>bash</refentrytitle></citerefentry> and
1726 <citerefentry><refentrytitle>csh</refentrytitle></citerefentry> treat
1727 positional parameters differently).
1728 However, <envar>PATH</envar> is searched to find it so you can still use
1729 another shell if you want by naming it sh and putting it in your path.
1733 Commands execute in the background, so you can say:
1735 <command>sleep 240; xmessage Time to go!</command>
1742 <title><anchor id="SelectIf" xreflabel="Select If"/>The conditional
1743 selection box</title> <para>
1745 Use this if you want to automatically select all files in the directory
1746 which match a condition.
1748 <orderedlist><title>For example, to select all files larger than 5Mb:</title>
1751 Open the Select If minibuffer.
1755 Type <userinput>Size > 5Mb</userinput> and press <keycap>Return</keycap>.
1760 Just those files over 5 Mb in size will be selected. The expressions
1761 you can enter are in the same form as described in the
1762 <xref linkend="Searching"/> section, except that
1763 <userinput>prune</userinput> has no effect since the contents of
1764 directories are never checked anyway. You can press <keycap>Tab</keycap>
1765 to jump to each selected file in turn.
1771 <chapter id="actions">
1772 <title>Action windows</title>
1774 Action windows are those boxes that appear while you're doing a
1775 Copy/Move/Link/etc operation. The status line at the top of the window shows
1776 the current directory or object that the window is processing. The scrolling
1777 area below is the log area — it shows what has been done, and questions
1778 may be displayed here.
1781 <imagedata align="center" format="PNG" fileref="../Action.png"/>
1783 <textobject><para>Can't display image.</para></textobject>
1786 Below this are four buttons and some options. All windows have the
1787 <guilabel>Quiet</guilabel> option. When this is on the filer will only
1788 confirm some operations (such as deleting a non-writeable file). Otherwise,
1789 all operations are confirmed.
1791 The buttons work as follows:
1795 <varlistentry><term><guibutton>Yes</guibutton></term><listitem><para>
1796 answers yes to the question displayed in the log area.
1797 </para></listitem></varlistentry>
1799 <varlistentry><term><guibutton>No</guibutton></term><listitem><para>
1800 answers no to the question displayed in the log area.
1801 </para></listitem></varlistentry>
1803 <varlistentry><term><guibutton>Cancel</guibutton></term><listitem><para>
1804 kills the current operation (if any) and closes the action
1806 </para></listitem></varlistentry>
1808 <varlistentry><term><guibutton>Quiet</guibutton></term><listitem><para>
1809 is a quick way to turn <guilabel>Quiet</guilabel> on and click
1810 <guibutton>Yes</guibutton>.
1811 </para></listitem></varlistentry>
1816 You can control which actions get started automatically (without you
1817 having to click on <guibutton>Quiet</guibutton> at the start) from the
1822 <title>Action window options</title>
1825 Some actions have options, which appear as option boxes at the bottom
1826 of the window. They are:
1831 <guilabel>Force</guilabel> means that the filer won't treat non-writeable
1832 files as special. Normally, it confirms the deletion even if
1833 <guibutton>Quiet</guibutton> is pressed.
1834 Note that you still can't remove files from non-writeable directories because
1835 in that case you really don't have permission.
1839 <guilabel>Brief</guilabel> prevents the filer logging a message every time it
1840 does something. Use this to speed things up if large numbers of messages are
1845 <guilabel>Recurse</guilabel> means that doing something to a directory will
1846 also do the same thing to all its contents, and the contents of any
1847 subdirectories, and so on.
1851 <guilabel>Newer</guilabel> will automatically copy a file over an existing one
1852 if the file is newer than the one it replaces (later modification time).
1858 You can set the defaults for these options from the Options box.
1863 <chapter id="searching">
1864 <title><anchor id="Searching" xreflabel="Searching"/>Searching</title>
1867 The Find feature looks through all the selected files and directories
1868 and any subdirectories (recursively) looking for items that match
1869 a particular expression.
1871 If you know the name of a file then just enter it in the `Expression:'
1872 box, enclosed in single quotes. For example, to find a file called
1873 <filename>log</filename> you would enter <userinput>'log'</userinput>.
1875 Remember to use normal quotes, not double quotes (") or back-quotes (`).
1877 As the filer finds matching files they are added to the results list.
1878 Double-clicking on an entry in the list opens a viewer showing that file.
1879 The filer will use the same window to view other results (so, if you want
1880 the results shown in separate windows you must explicitly create a new
1881 window from the <guimenu>Window</guimenu> menu).
1885 <title>Wildcards</title>
1888 You can also put shell-style wildcard characters inside the quotes,
1893 <member><command>'*.html'</command></member>
1894 <member><command>'Report.*'</command></member>
1895 <member><command>'Draft[1-5]'</command></member>
1896 <member><command>'main.[ch]'</command></member>
1901 <citerefentry><refentrytitle>glob</refentrytitle>
1902 <manvolnum>7</manvolnum></citerefentry>
1903 manpage if you want to know more about shell wildcards.
1905 If the pattern you enter contains a slash (`/') character then the
1906 pattern is matched against the file's full path, otherwise only the
1907 leafname is used. That is, <userinput>'*tmp*'</userinput> will find
1908 <filename>tmp</filename> and <filename>tmpfile</filename> but not
1909 <filename>/tmp/file</filename> — <userinput>'/*tmp*'</userinput> will find
1915 <title>Simple tests</title>
1917 As well as finding files by their names you can also find them by
1918 various other attributes. Note that <emphasis>file</emphasis> is used here to
1919 mean anything that can appear in the filesystem — including directories,
1922 You can also use a short form for each test; these are shown in brackets.
1923 You can combine multiple tests — `<userinput>-rw</userinput>' is
1924 the same as `<userinput>IsReadable and IsWriteable</userinput>'.
1927 <itemizedlist><title>These look at the type of the item being checked:</title>
1930 <userinput>IsReg (-f)</userinput> matches any regular (ie, normal) file.
1934 <userinput>IsLink (-l)</userinput> matches symlinks.
1938 <userinput>IsDir (-d)</userinput> matches directories.
1942 <userinput>IsChar (-c)</userinput> matches character device files.
1946 <userinput>IsBlock (-b)</userinput> matches block device files.
1950 <userinput>IsDev (-D)</userinput> matches block or character device files.
1954 <userinput>IsPipe (-p)</userinput> matches pipes.
1958 <userinput>IsSocket (-S)</userinput> matches sockets.
1963 <itemizedlist><title>These look at the permissions set on the file —
1964 see the <xref linkend="Permissions"/> section.</title>
1967 <userinput>IsSUID (-u)</userinput> matches files which have the Set-UID
1968 bit set.</para></listitem>
1971 <userinput>IsSGID (-g)</userinput> matches files which have the Set-GID
1972 bit set.</para></listitem>
1975 <userinput>IsSticky (-k)</userinput> matches files with the sticky bit
1976 set.</para></listitem>
1979 <userinput>IsReadable (-r)</userinput> matches files which you can read
1980 from.</para></listitem>
1983 <userinput>IsWriteable (-w)</userinput> matches files which you can write to.
1987 <userinput>IsExecutable (-x)</userinput> matches files which you can execute.
1992 <itemizedlist><title>And a couple of other useful ones:</title>
1995 <userinput>IsEmpty (-z)</userinput> finds empty files (ie, those whose
2000 <userinput>IsMine (-o)</userinput> finds files which you own.
2008 <title>Logic operators</title>
2010 You can combine the above tests in various ways to perform more advanced
2012 An expression is actually made up of a list of <emphasis>cases</emphasis>,
2013 separated by commas. The filer will try to match each case in turn
2014 until one matches or there are no more cases left. For example, to
2015 search for files with several possible endings:
2017 <screen>'*.gif', '*.htm', '*.html'</screen>
2019 Further, each of the cases is actually a list of conditions. The case
2020 only matches if all of its conditions are met. So, to find a directory
2021 called <filename>lib</filename> or a regular file ending in
2022 <filename>.so</filename>:
2024 <screen>IsDir 'lib', IsReg '*.so'</screen>
2026 You can negate a condition by putting a <userinput>!</userinput> in front
2027 of it and you can use a sub-expression as a condition by bracketing it,
2035 Not isdir and not isreg
2038 All four do the same thing.
2043 <title>Comparisons</title>
2045 You can also compare various values using the operators
2046 <userinput><</userinput>,
2047 <userinput><=</userinput>,
2048 <userinput>=</userinput>,
2049 <userinput>!=</userinput>,
2050 <userinput>></userinput>, and
2051 <userinput>>=</userinput>
2052 (for less-than, less-than-or-equal-to, equal-to,
2053 not-equal-to, greater-than and greater-than-or-equal-to).
2055 When comparing times, you may find it helpful to use
2056 <userinput>after</userinput> and <userinput>before</userinput> instead of
2057 <userinput>></userinput> and <userinput><</userinput> to make things
2061 <itemizedlist><title>
2062 The following are read from the file being checked and may be used
2063 for the values being compared:
2067 <userinput>atime</userinput> The time that the file was last accessed.
2071 <userinput>ctime</userinput> The time that the file's status was last changed.
2075 <userinput>mtime</userinput> The time that the file's contents were last modified.
2079 <userinput>size</userinput> The size of the file.
2083 <userinput>inode</userinput> The file's inode (index) number.
2087 <userinput>nlinks</userinput> The number of links to this file. That is,
2088 the number of directory entries which refer to this file. Note that
2089 symlinks don't count as references.
2093 <userinput>uid</userinput> The User ID of the file.
2097 <userinput>gid</userinput> The Group ID of the file.
2101 <userinput>blocks</userinput> The number of disk blocks being used by the file.
2107 Times are measured as seconds since the Unix Epoch (00:00:00 UTC,
2108 January 1, 1970). Sizes are in bytes. When specifying constants to
2109 compare these values with you may use various keywords to scale the
2115 <userinput>Byte(s)</userinput> has no effect, but looks better.
2119 <userinput>Kb</userinput> multiplies by 1024, so 2Kb is the same as 2048.
2123 <userinput>Mb</userinput> multiplies by 1024<superscript>2</superscript>,
2128 <userinput>Sec(s)</userinput> has no effect, but looks nice.
2132 <userinput>Min(s)</userinput> multiplies by 60 to get minutes.
2136 <userinput>Hour(s), Day(s), Week(s), Year(s)</userinput> likewise
2137 convert to the relevant unit.
2141 <userinput>Ago</userinput> makes the time in the past relative to when
2146 <userinput>Hence</userinput> makes the time in the future.
2150 <userinput>Now</userinput> is short for <userinput>0 Secs Hence</userinput>.
2155 Some examples should make this all a bit clearer!
2158 mtime after 1 day ago
2162 IsReg and nlinks > 1</screen>
2163 The first finds files modified within the last 24 hours. You could
2164 use <userinput>></userinput> instead of <userinput>after</userinput>,
2165 but it's not so clear what is meant.
2167 The second finds files larger than 10 Mb. The last finds regular files with
2168 more than one directory entry.
2170 Be careful though — the filer doesn't check the context of the
2171 modifiers, so <userinput>size > 1 day ago</userinput> is allowed,
2172 although it doesn't make much sense!
2174 Also, forgetting to use <userinput>ago</userinput> or
2175 <userinput>hence</userinput> will cause odd effects (the time will be
2176 measured relative to the Epoch rather than the current time).
2177 Finally, don't use <userinput>=</userinput> with times —
2178 <userinput>atime = 1 day ago</userinput> looks for a file accessed
2179 <emphasis>exactly</emphasis> 86400 seconds ago...
2185 <title>Specials</title>
2191 <userinput>System(Command)</userinput> executes `Command' on the file.
2192 The test succeeds if the command returns an exit status of zero. A `%'
2193 character in `Command' is replaced by the full path of the file being
2194 checked. <userinput>System</userinput> is a very slow test to perform,
2195 so do it last if possible. For example, if you're looking for a
2196 <filename>.c</filename> file containing the word `main', do:
2198 <screen>'*.c' system(grep -q main "%")</screen>
2199 so that the grep is only performed for files ending in <filename>.c</filename>
2200 (as opposed to only checking that the file ends in <filename>.c</filename> if
2201 it contains the word `main').
2205 <userinput>Prune</userinput> Always fails!
2206 <footnote><para>Note that this is the opposite of the
2207 <citerefentry><refentrytitle>find</refentrytitle><manvolnum>1</manvolnum>
2208 </citerefentry> command.</para></footnote>
2210 However, if it gets evaluated at all then it prevents the filer
2211 from checking inside the current directory. Remember the order in which
2212 the filer checks the expression!
2220 '*.old' system(rm '%')
2222 'src' prune, '*.c'</screen>
2223 The first deletes each file ending in <filename>.old</filename>.
2224 The second looks for <filename>.c</filename> files, but does not bother
2225 checking inside directories called <filename>src</filename>.
2226 The expression is evaluated like this:
2228 If file is named <filename>src</filename> then `Prune'.
2229 Either way, check if it ends in <filename>.c</filename> and include
2230 it in the results if so.
2235 <chapter id="options">
2236 <title>Options</title>
2239 You can configure various aspects of <application>ROX-Filer</application>
2240 from the Options box.
2241 Choose <guimenuitem>Options...</guimenuitem> from a filer window menu to
2242 open it. The list on the left of the window lists the various sections —
2243 click on one to see its options.
2245 At the bottom of the window are two buttons:
2250 <guibutton>OK</guibutton>
2251 saves the current choices into your Choices directory for next time
2252 <application>ROX-Filer</application> is loaded, if anything changed.
2253 Exactly where choices are loaded from and saved to is controlled by the
2254 <envar>CHOICESPATH</envar> environment variable — see
2255 <citation>Choices</citation> for details.
2256 Changes made in the Options box take effect instantly, so you don't need to
2257 click on <guibutton>OK</guibutton> just to try them out.
2261 <guibutton>Revert</guibutton>
2262 Restores all choices to how they were when the options box was opened.
2263 This button is shown shaded if you haven't made any changes.
2264 The Options window is not closed when this is used.
2269 Many of the options in the Options window have tooltips — hold the
2270 mouse pointer over the option to find out what it does.
2275 <title>Translation options</title>
2278 You can choose which language the filer will display messages in from
2279 here, or get it to read the LANG environment variable to get the desired
2286 <title>Filer window options</title>
2290 <listitem><para><guilabel>Automatically resize filer windows</guilabel> can be
2291 used to control when windows are automatically resized:
2294 <listitem><para><guilabel>Never automatically resize</guilabel>
2295 turns off auto-resizing. Windows must be resized manually.
2298 <listitem><para><guilabel>Resize when changing the display style</guilabel>
2299 will resize the window automatically when you change the icon size or
2300 the type of details to be displayed.
2303 <listitem><para><guilabel>Always resize</guilabel>
2304 causes the window to resize whenever it seems useful (that is, when
2305 changing to a different directory or when switching between display
2312 <listitem><para> <guilabel>Largest window size</guilabel> sets the largest size
2313 (as a percentage of the screen size) that the auto-resizer will resize windows
2317 <listitem><para> <guilabel>Change from Large icons to Small automatically</guilabel>
2318 allows the filer to choose the size when changing directory. The
2319 switching threshold is set using the number entry below.
2322 <listitem><para> <guilabel>Short titlebar flags</guilabel> abbreviates
2323 the All, Thumbs and Scanning titlebar indicators to single letters.
2326 <listitem><para> <guilabel>Unique windows</guilabel> prevents you from having
2327 two windows showing the same directory. Opening a second view onto a directory
2328 simply reshows the first one.
2331 <listitem><para> <guilabel>New window on button 1</guilabel> swaps the
2332 actions of the two non-menu buttons when opening directories. This is
2333 provided for people who are used to the RISC OS mouse bindings.
2336 <listitem><para> <guilabel>Single-click navigation in filer windows</guilabel>
2337 means that clicking on a file or directory will open it. If off, clicking on
2338 files selects them instead — you must double click on a file to open it.
2345 <title>Display options</title>
2349 <listitem><para><guilabel>Intelligent sorting</guilabel>
2350 treats upper and lower case letters as equivalent when sorting, ignores
2351 punctuation, and sorts numbers numerically. If this is off then
2352 <filename>Zoo</filename> comes before <filename>animal</filename>, for
2356 <listitem><para><guilabel>Directories always come first</guilabel> means that
2357 all directories are sorted and displayed at the top, then all the other items
2358 are sorted and displayed below. With this option off, directories are mixed in
2359 with the other files.
2362 <listitem><para><guilabel>Large wrap width</guilabel> sets the maximum width
2363 for a file's name in `Large Icons' display mode before the text will wrap onto
2364 two lines. In `Huge Icons' mode, the wrap width is 50% larger than this value.
2367 <listitem><para><guilabel>Max Small Icons width</guilabel> — in
2368 `Small Icons' mode, any text longer than this is chopped off (a red bar
2369 indicates that some text is not shown). You can hold the mouse over the
2370 truncated name to see the full text.
2373 <listitem><para><guilabel>Default settings for new windows</guilabel> —
2374 these options provide the default settings for newly opened
2375 windows. They correspond to choosing styles from the
2376 <guimenuitem>Display</guimenuitem> menu.
2377 If <guilabel>Inherit options from source window</guilabel>
2378 is on then opening a new window from an existing window
2379 (eg, by clicking the middle button over a directory) gives the new window
2380 the same options (icon size, sort order, etc) as the old window. If
2381 off, the new window has the default settings chosen here.
2388 <sect2><title>Toolbar options</title>
2390 The toolbar is described in the <xref linkend="Toolbar"/> section.
2392 <listitem><para> <guilabel>Unshade the tools you want:</guilabel> allows
2393 you to set which tools should appear on the toolbar. Click on the
2394 buttons below to shade and unshade them — shaded tools will not be
2395 shown on filer window toolbars.
2398 <listitem><para> <guilabel>Toolbar type</guilabel> allows you to choose
2399 what kind of toolbars you want.
2400 <guimenuitem>None</guimenuitem> means that windows will not have a
2402 <guimenuitem>Icons only</guimenuitem> provides a small bar of icons,
2403 <guimenuitem>Text under icons</guimenuitem> displays larger buttons,
2404 with textual labels below, and
2405 <guimenuitem>Text beside icons</guimenuitem> displays wider buttons,
2406 with textual labels next to the icons.
2409 <listitem><para> <guilabel>Show totals of items</guilabel> shows the
2410 number of items displayed in a filer window, as well as the number of
2411 hidden items (if any) on the toolbar. When there's a selection, it
2412 shows the number of selected items and their combined size (excluding
2421 <sect2><title>Minibuffers</title>
2423 These two options control what happens when you press <keycap>Tab</keycap>
2424 in the path entry minibuffer:
2428 <listitem><para> <guilabel>Beep if Tab-completion fails</guilabel> — beep
2429 if there is no match, or there are several possible completions, each starting
2433 <listitem><para> <guilabel>Beep if there are several matches</guilabel> —
2434 beep if there are several matches, even though some letters were added.
2443 <title>Pinboard options</title>
2445 See the <xref linkend="run_pin"/> section for instructions on enabling the
2450 <listitem><para><guilabel>Colours</guilabel>
2451 sets the colours used for the text under the icons, and the background colour
2452 (if no background image is set).
2455 <listitem><para><guilabel>Single-click to open</guilabel>
2456 allows you to open a file or directory just by clicking on it. Hold down
2457 <keycap>Control</keycap> to select things. If this is off, clicking selects
2458 and double-clicking opens.
2461 <listitem><para><guilabel>Pass button-3 clicks to window manager</guilabel>
2462 may be needed if your window manager uses button-3 clicks on the desktop
2463 for an important function. Normally, clicking button-3 will display
2464 the filer's pinboard menu.
2467 <listitem><para><guilabel>Keep icons within screen limits</guilabel>
2468 prevents icons from going partly off the side of the screen.
2471 <listitem><para> <guilabel>Icon grid step</guilabel> controls how finely
2472 the icons may be positioned.
2475 <listitem><para> <guilabel>Iconified windows</guilabel> controls how the
2476 filer deals with iconified (or 'minimised') windows. If
2477 <guilabel>Show iconified windows</guilabel> is on then the filer shows
2478 an icon on the pinboard for each iconified window. The other two options
2479 let you choose the method of placing the icons. See <xref linkend="iconify"/>
2489 <title>Panel options</title>
2492 If you are using panels (see the <xref linkend="run_pan"/> section)
2493 then this section lets you choose which icons will have textual labels
2495 You can have labels on all icons, on no icons, or on all icons except
2502 <title>Action window options</title>
2505 You can choose to start some operations automatically, without waiting
2506 for you to click on <guibutton>Quiet</guibutton>.
2507 Select each operation that you want to auto-start here. You can also set
2508 the default state for each of the options that appear inside action
2515 <title>Drag-And-Drop options</title>
2519 <listitem><para><application>ROX-Filer</application> uses the standard
2520 XDND protocol for drag-and-drop. This protocol recommends that URIs
2521 should contain the hostname of the computer that the resource is on so
2522 that the program receiving the data can determine whether it can get the
2523 data directly or whether it must go via the X-server. However, many
2524 older programs (particularly GNOME applications) get confused by the
2525 hostname and fail to load the data correctly. If <guilabel>Don't use
2526 hostnames</guilabel> is on then the hostname part is omitted and
2527 <application>ROX-Filer</application> will work with these applications
2528 BUT you can't drag data to a program running on a different machine.
2531 <listitem><para><guilabel>Allow dragging to icons in filer
2532 windows</guilabel> controls what happens when you drop files onto icons
2533 in filer windows. If on then drops onto directories will save the data
2534 inside the directory, while dropping onto programs will invoke the
2535 program on that data. If off then drops anywhere inside a filer window
2536 act like drops onto the window background — that is, the data will
2537 be saved into the directory being displayed.
2540 <listitem><para><guilabel>Directories spring open</guilabel> controls what
2541 happens when you hold a file over a directory while dragging it. If on,
2542 the directory will `spring open' after a short pause, allowing you to
2543 navigate to any directory during a drag. You can also hold the pointer
2544 over the Home and Up buttons on the toolbar for a similar effect. You
2545 need to have the previous option enabled for this to have any effect on
2546 files displayed in a directory.
2549 <listitem><para><guilabel>Spring delay</guilabel> sets how long, in
2550 thousanths of a second, the filer will wait before spring opening a
2551 directory as described above. If the above option is turned off, then
2555 <listitem><para><guilabel>Dragging files with the middle mouse button</guilabel>
2556 you can choose whether this displays a menu (like <keycap>Alt</keycap>
2557 dragging) or moves the files (like <keycap>Shift</keycap> dragging).
2566 <title>Menu options</title>
2571 <listitem><para><guilabel>Menu on button 2</guilabel> swaps the actions
2572 of buttons 2 and 3 so that the middle button brings up the menus. This
2573 is provided for people who are used to the RISC OS mouse bindings.
2575 As an alternative to using the options window to put menu on button-2,
2576 some people prefer to use the command <command>xmodmap -e "pointer
2577 = 1 3 2"</command>, which makes the right mouse button button-2 and
2578 the middle one button-3 (this affects all programs, not just
2579 <application>ROX-Filer</application>).
2582 <listitem><para><guilabel>Size of icons in menus</guilabel> controls the
2583 size of the icons in the <guimenuitem>Send To</guimenuitem> and
2584 <guimenuitem>New</guimenuitem> menus.</para></listitem>
2586 <listitem><para><guilabel>Xterm here program</guilabel> is the command
2587 used when you choose <guimenuitem>Xterm here</guimenuitem> from the
2588 menu. You can replace it with another command such as
2589 <command>gnome-terminal</command>, <command>konsole</command>, or
2590 anything else.</para></listitem>
2597 <title>Types</title>
2599 <guilabel>Ignore eXecutable bit for known extensions</guilabel> means that
2600 when a file has a known extension (eg <filename>.gif</filename>) the
2601 executable bit is ignored. This is useful if you have files on a
2602 Windows-type filesystem which are being shown as executable programs.
2603 However, it prevents a file such as <filename>script.sh</filename> from
2604 being treated as a program.
2606 The MIME type system used in the filer is described more fully in
2607 <xref linkend="types"/>.
2609 <listitem><para><guibutton>Show name-to-type rules</guibutton>
2610 opens the directories containing the files which tell the filer what
2611 type to give each file.</para></listitem>
2613 <listitem><para><guibutton>Re-read files</guibutton> causes the filer to
2614 reread these files after you've finished changing them.
2619 <sect2><title>Colours</title>
2621 <guilabel>Colour files based on their types</guilabel>. If on, each
2622 file's name is coloured depending on what kind of thing it is (regular
2623 file, directory, executable, etc). You can choose the colours from the
2630 <chapter id="types">
2631 <title>Filetypes</title>
2634 All files have a MIME type in the form <emphasis>text/plain</emphasis>. Here,
2635 <emphasis>text</emphasis> is the <emphasis>media type</emphasis> and
2636 <emphasis>plain</emphasis> is the <emphasis>sub-type</emphasis>.
2638 <application>ROX-Filer</application> uses a file's name to decide what its MIME
2639 type is, and then uses the MIME type to decide what icon to give it and what
2640 program to use when you open the file.
2644 <title><anchor id="RunAction" xreflabel="the Set Run Action box"/>
2649 This box appears when you choose <guimenuitem>Set Run Action...</guimenuitem>
2650 from the File menu, and is used to set which application is loaded when you click
2653 For example, let's say you want to set things up so that opening a
2654 <filename>.gif</filename> file loads it into the Gimp.
2655 First, right-click over a gif image to open the menu and choose
2656 <guimenuitem>Set Run Action...</guimenuitem> from the
2657 <guimenuitem>File</guimenuitem> submenu.
2658 Then, you have a choice of two methods to set the run action:
2661 <sect2><title>Setting the run action by drag-and-drop</title>
2663 Drag the Gimp (from a filer window, a panel or the pinboard) onto
2664 the area marked <guilabel>Drop a suitable application here</guilabel>.
2665 From now on, clicking on a GIF file will load it into the Gimp.
2669 <sect2><title>Setting the run action by entering a shell command</title>
2671 Type: <userinput>gimp "$1"</userinput>
2672 into the box labelled <guilabel>Enter a shell command</guilabel> and press
2673 <keycap>Return</keycap>. <userinput>$1</userinput>
2674 will be replaced by the name of the file you click on when this command
2675 is used. As before, clicking on any GIF image will now load it into
2680 <sect2><title>Setting the default media-type handlers</title>
2682 Whichever method you use to set the action you have the choice of
2683 setting the run action just for that type, or setting the default
2684 for all files with that media-type which don't already have a specific
2687 Since the Gimp can load many types of image, it makes sense
2688 to select the <guilabel>Set default for all `image/<anything>'</guilabel>
2689 option so you don't have to do it again for image/jpeg files and so on. However,
2690 this only affects types that don't already have a specific action
2691 (ie, those that would have brought up an error box if you tried to
2698 <title><anchor id="SetIcon" xreflabel="the Set Icon box"/>
2703 This box appears when you choose <guimenuitem>Set Icon...</guimenuitem>
2704 from the File menu, and is used to set which image to use to represent
2707 It works much like the Set Run Action box described above, except that
2708 you may specifiy an icon for one file individually (by name) as well as
2709 for all files of a particular type. When setting the icon for a single
2710 file, the filer stores the name of the file and the name of the icon inside
2711 your Choices directory. If either moves, the icon won't be displayed.
2713 When setting the icon for a directory, you have the additional option of
2714 storing the image inside the directory itself as a hidden file. This means
2715 that other users will see the icon too, and you can safely delete the original
2716 image after the copy (note that the image is scaled down if needed, and converted
2719 The directory icon inside the <guilabel>Drop an icon here</guilabel>
2720 area allows you to quickly get to a directory from which you are already
2721 using one or more icons.
2726 <title>How filetypes are stored</title>
2729 <application>ROX-Filer</application> uses two sub-directories in your Choices
2730 directory for filetypes:
2734 <varlistentry><term><filename>MIME-types</filename></term><listitem><para>
2735 contains symlinks, one for each MIME type, which point
2736 to programs that can handle files of that type. To set what program
2737 is run when you click on the file you should normally use the <guimenuitem>Set
2738 Run Action...</guimenuitem> feature (see the <xref linkend="RunAction"/> section).
2739 However, you can also set the actions manually — for example, to make
2740 opening an HTML file load it into Netscape:
2744 Find the Netscape application and go to <guimenuitem>Link...</guimenuitem>
2749 Enter <userinput>text_html</userinput> as the name for the link and drag the
2750 icon from the Link box into the <filename>MIME-types</filename> directory.
2755 You can also put actual programs in here as well as links if you want
2757 </para></listitem></varlistentry>
2759 <varlistentry><term><filename>MIME-icons</filename></term><listitem><para>
2760 contains the images used to display each type of file.
2761 So the filer will try to display an HTML file using the icon
2762 <filename>MIME-icons/text_html.png</filename>.
2763 </para></listitem></varlistentry>
2767 In both <filename>MIME-types</filename> and <filename>MIME-icons</filename>
2768 directories you can also provide default actions/images for each media type.
2769 For example, if <filename>text_html</filename> isn't found then the filer
2770 will try simply using <filename>text</filename>.
2774 The filer works out the type for a file from its name. These are specified by
2775 `.mimeinfo' files — see <citation>SharedMIME</citation> for details.
2780 <chapter id="appdirs">
2781 <title><anchor id="AppDir" xreflabel="Application directories"/>
2782 Application directories
2785 An application directory is a directory which can be run as an application.
2786 It contains all the resources of an application — source code, binaries,
2787 documentation and so on. Keeping everything in one place make installation
2788 and uninstallation much easier for users. You can also keep multiple
2789 versions of a program by simply having several application directories.
2790 You may move and rename them as you please. Application directories
2791 make programs easier to use and install.
2793 They're more secure too, because you can compile an application as a user and
2794 then simply copy it as root. Since you don't have to run an install script
2795 you are free from the danger of running untrusted code as root. All you have
2796 to watch out for is setuid binaries.
2799 The following files are treated as special by
2800 <application>ROX-Filer</application>:
2805 <filename>AppRun</filename>
2806 is executed when you click on the directory — make sure
2807 it is executable (use the Permissions box)!
2811 <filename>.DirIcon</filename>
2812 is the image used to represent the directory (this works even if
2813 there is no <filename>AppRun</filename>).
2817 <filename>Help</filename>
2818 is the directory to be opened when you choose <guimenuitem>Help</guimenuitem>
2823 <filename>AppInfo.xml</filename>
2824 contains extra information about an application (see below).
2828 <filename>AppIcon.xpm</filename>
2829 is used if <filename>.DirIcon</filename> is missing (for backwards
2830 compatibility; not to be used anymore).
2835 Have a look at the <filename>ROX-Filer</filename> application directory for a
2840 <note><para>For security reasons, an application directory must have the
2841 same owner as the <filename>AppRun</filename> file inside.</para></note>
2844 <title>The AppInfo file</title>
2847 <filename>AppInfo.xml</filename> is an XML file with the following structure
2848 (any elements may be omitted, and the file itself is optional):
2851 <?xml version="1.0"?>
2853 <Summary>A graphical file manager</Summary>
2855 <Purpose>File manager</Purpose>
2856 <Version>1.1.3 (07-May-2001)</Version>
2857 <Authors>Thomas Leonard and others</Authors>
2858 <License>GNU General Public License</License>
2859 <Homepage>http://rox.sourceforge.net</Homepage>
2862 <Item label="Enable pinboard" option="-p=Default"/>
2863 <Item label="Disable pinboard" option="-p="/>
2865 </AppInfo></screen>
2870 <userinput>Summary</userinput>
2871 is displayed in a tooltip when the mouse is held over the application.
2875 <userinput>About</userinput>
2876 contains a list of fields which are shown in the `File Info'
2877 box for the application (any element names may be used, but the above
2882 <userinput>AppMenu</userinput>
2883 is a list of extra menu items to display for the application.
2884 When one is chosen, <filename>AppRun</filename> is called with
2885 <userinput>option</userinput> as its only argument. You can nest
2886 AppMenus inside other AppMenus.
2896 <title>Internationalisation</title>
2902 <title><anchor id="LANG" xreflabel="Translations"/>
2903 Selecting a translation
2907 <application>ROX-Filer</application> is able to translate many of its messages,
2908 provided suitable translation files are provided:
2911 <listitem><para>Open the Options box from the menu,</para></listitem>
2912 <listitem><para>Select a language from the menu at the top,</para></listitem>
2913 <listitem><para>Click on <guibutton>Save</guibutton> and restart the filer
2914 for the new setting to take full effect.</para></listitem>
2921 <title>Creating a new translation</title>
2925 <listitem><para>Go into the <filename>src</filename> directory and create
2926 the file <filename>messages.pot</filename>:
2930 $ make messages.pot</screen>
2934 <listitem><para>Copy the file into the <filename>po</filename>
2935 subdirectory under <filename>src</filename> as
2936 <filename><name>.po</filename>. Eg, if your
2937 language is referred to as `ml' (`my language'):
2939 <screen>$ cp messages.pot po/ml.po</screen>
2942 <listitem><para>Load the copy into a text editor.</para></listitem>
2944 <listitem><para>Fill in the translations, which are all blank to start with.
2947 <listitem><para>Run the <filename>make-mo</filename> script to create the
2948 binary file which <application>ROX-Filer</application> can use.
2949 You will need the GNU gettext package for this.
2950 If you don't have it then just send me the <filename>.po</filename> file
2951 and I'll convert it for you.
2954 $ cd ROX-Filer/src/po
2956 Created file ../../Messages/ml.gmo OK</screen>
2959 <listitem><para>Edit <filename>ROX-Filer/Options.xml</filename> so that
2960 your language is listed, restart the filer and select it from the Options box
2961 (see the <xref linkend="LANG"/> section).
2964 <listitem><para>Submit the <filename>.po</filename> file to me so that I
2965 can include it in future releases of the filer.
2973 <title>Updating an existing translation</title>
2977 <listitem><para>Go into the directory containing the <filename>.po</filename>
2978 files and run the <filename>update-po</filename> script.
2979 This checks the source code for new and changed strings and updates all
2980 the translation files.
2983 $ cd ROX-Filer/src/po
2984 $ ./update-po</screen>
2987 <listitem><para>Edit the file by hand as before, filling in the new blanks
2988 and updating out-of-date translations.
2989 Look out for <computeroutput>fuzzy</computeroutput> entries where
2990 <command>update-po</command> has made a guess; check it's correct and
2991 remove the <computeroutput>fuzzy</computeroutput> line.
2994 <listitem><para>Run <command>make-mo</command> as before.</para></listitem>
2996 <listitem><para>Submit the updated file to me.</para></listitem>
3000 See the <command>gettext</command> info page for more instructions on creating
3007 <chapter id="hacking">
3008 <title>Hacking</title>
3010 This is a quick start guide for people who want to modify the source
3011 code. If you make useful changes or fix bugs, please send patches
3012 to me or to the mailing list. Tell me which version you're using!
3016 <title>Compiling</title>
3018 The first time you compile the program you need to do <command>AppRun
3019 --compile</command>, but in future you only need to run <command>make</command>
3020 in the <filename>src</filename> directory when you change the
3021 <filename>.c</filename> and <filename>.h</filename> files.
3022 You might want to run <command>make depend</command> too.
3027 <title>Creating and applying patches</title>
3029 When people make small modifications to the sources they will often
3030 distribute them as <emphasis>patch files</emphasis> — usually on the
3033 To apply a patch, go into the <filename>src</filename> directory and run
3034 <command>patch</command> with the patch file. Then recompile, like this:
3038 $ patch < patchfile
3039 $ ../AppRun --compile</screen>
3041 You can remove the patch by simply repeating the above sequence —
3042 <command>patch</command> will detect that the patch is already applied
3043 and offer to remove it.
3045 To create a patch you should first get the latest version of the filer
3046 from CVS (instructions on using CVS can be found on the web-site).
3047 Modify the program as you please. Create the patch using
3048 <command>cvs diff</command> from the appropriate directory:
3050 <screen>$ cvs diff -u > my_patch</screen>
3052 This creates a human– and machine-readable patch file. Submit this
3053 to the mailing list. The are many reasons for posting patches rather
3054 that the modified files:
3057 <listitem><para>They are smaller, and hence shouldn't bounce.
3058 They are also quicker to download for people with slow connections.
3061 <listitem><para>People can see what they're getting into before applying them!
3064 <listitem><para>Patches can (usually) be applied to slightly modified
3065 versions of the sources. This means that people can apply several patches
3066 without each new one overwriting the others.
3075 <title>Autoconf</title>
3077 Here's a quick explanation of the autoconf system in case you haven't
3078 used it before. See <command>info autoconf</command> for full details.
3080 There's a file called <filename>configure.in</filename> which contains
3081 various tests (<command>info autoconf</command>).
3082 You run <command>autoconf</command> and it reads through the file
3083 and generates a shell script to perform the tests, saving it as
3084 <filename>configure</filename>.
3085 <filename>configure</filename> is normally distributed with the program because
3086 not everyone has autoconf.
3088 You then run <filename>configure</filename> (in fact, let the
3089 <filename>AppRun</filename> script do it because
3090 it passes it some arguments), which performs all the tests. It reads
3091 in <filename>Makefile.in</filename> and <filename>config.h.in</filename>
3092 and fills in the missing values with the test results to produce
3093 <filename>Makefile</filename> and <filename>config.h</filename>.
3095 You run <command>make</command>, which creates <filename>.o</filename>
3096 files from the <filename>.c</filename> files and links to produce
3097 <filename>ROX-Filer</filename>.
3101 <sect1><title>Data-structures</title>
3103 The <filename>global.h</filename> file lists each major data-structure used
3104 in the filer and explains its purpose. This is a good place to start reading
3105 if you want to know how the filer works.
3109 In summary, each window has its own <classname>FilerWindow</classname>
3111 This structure has pointers to a <classname>Collection</classname>
3112 (which is the widget which actually displays the files) and to a
3113 <classname>Directory</classname>, which is used to cache the directory
3116 Both <classname>Collection</classname> and
3117 <classname>Directory</classname> have pointers to (the same)
3118 <classname>DirItem</classname>s, each of which corresponds to one filesystem
3121 Several <classname>FilerWindow</classname>s may share the same
3122 <classname>Directory</classname>.
3124 While scanning is in progress the <classname>Directory</classname>
3125 keeps a list of the new items it has found
3126 (<emphasis>new_items</emphasis>) and the items which have changed in some way
3127 (<emphasis>up_items</emphasis>). It periodically notifies the filer window of
3128 the changes-so-far by calling all the functions in the
3129 <emphasis>users</emphasis> list (use <function>attach()</function>
3130 and <function>detach()</function> to add and remove functions to or from
3136 <appendix id="manpage"><title>Manual page</title>
3141 <refentrytitle>ROX</refentrytitle>
3142 <manvolnum>1</manvolnum>
3146 <refname>ROX-Filer</refname>
3147 <refpurpose>a simple graphical file manager</refpurpose>
3152 <command>rox</command>
3153 <arg choice="opt" rep="repeat"><option>OPTION</option></arg>
3154 <arg choice="opt" rep="repeat">FILE</arg>
3158 <refsect1><title>DESCRIPTION</title>
3160 ROX-Filer is a simple and easy to use graphical file manager for X11, the
3161 windowing system used on Unix and Unix-like operating systems.
3163 It is also the core component of the ROX Desktop:
3164 <ulink url="http://rox.sourceforge.net"/>
3166 Invoking <command>rox</command> opens each directory or file listed,
3167 or the current working directory if no arguments are given.
3171 <refsect1><title>COMMAND-LINE OPTIONS</title>
3175 <varlistentry><term><option>-b</option></term><term><option>--bottom=PANEL</option></term>
3176 <listitem><para>open PANEL as a bottom-edge panel.
3177 </para></listitem></varlistentry>
3179 <varlistentry><term><option>-c</option></term><term><option>--client-id=ID</option></term>
3180 <listitem><para>used for session management.
3181 </para></listitem></varlistentry>
3183 <varlistentry><term><option>-d</option></term><term><option>--dir=DIR</option></term>
3184 <listitem><para>open DIR as directory (not as an application, even if it looks like one).
3185 </para></listitem></varlistentry>
3187 <varlistentry><term><option>-D</option></term><term><option>--close=DIR</option></term>
3188 <listitem><para>close DIR and all its subdirectories.
3189 </para></listitem></varlistentry>
3191 <varlistentry><term><option>-h</option></term><term><option>--help</option></term>
3192 <listitem><para>display help about the various options.
3193 </para></listitem></varlistentry>
3195 <varlistentry><term><option>-l</option></term><term><option>--left=PANEL</option></term>
3196 <listitem><para>open PANEL as a left-edge panel.
3197 </para></listitem></varlistentry>
3199 <varlistentry><term><option>-m</option></term><term><option>--mime-type=FILE</option></term>
3200 <listitem><para>print MIME type of FILE and exit.
3201 </para></listitem></varlistentry>
3203 <varlistentry><term><option>-n</option></term><term><option>--new</option></term>
3204 <listitem><para>start a new filer, even if one already seems to be running. This also prevents the filer from forking (running in the background), which is useful for debugging.
3205 </para></listitem></varlistentry>
3207 <varlistentry><term><option>-o</option></term><term><option>--override</option></term>
3208 <listitem><para>override window manager control of panels.
3209 </para></listitem></varlistentry>
3211 <varlistentry><term><option>-p</option></term><term><option>--pinboard=PIN</option></term>
3212 <listitem><para>use pinboard PIN as the pinboard.
3213 </para></listitem></varlistentry>
3215 <varlistentry><term><option>-r</option></term><term><option>--right=PANEL</option></term>
3216 <listitem><para>open PANEL as a right-edge panel.
3217 </para></listitem></varlistentry>
3219 <varlistentry><term><option>-R</option></term><term><option>--RPC</option></term>
3220 <listitem><para>read and invoke SOAP RPC from standard input (see <xref linkend="soap"/>).
3221 </para></listitem></varlistentry>
3223 <varlistentry><term><option>-s</option></term><term><option>--show=FILE</option></term>
3224 <listitem><para>open a directory showing FILE.
3225 </para></listitem></varlistentry>
3227 <varlistentry><term><option>-t</option></term><term><option>--top=PANEL</option></term>
3228 <listitem><para>open PANEL as a top-edge panel.
3229 </para></listitem></varlistentry>
3231 <varlistentry><term><option>-u</option></term><term><option>--user</option></term>
3232 <listitem><para>show user name in each window.
3233 </para></listitem></varlistentry>
3235 <varlistentry><term><option>-v</option></term><term><option>--version</option></term>
3236 <listitem><para>display the version information and exit.
3237 </para></listitem></varlistentry>
3239 <varlistentry><term><option>-x</option></term><term><option>--examine=FILE</option></term>
3240 <listitem><para>FILE has changed; re-examine it.
3241 </para></listitem></varlistentry>
3247 <refsect1><title>NOTES</title>
3249 The main documentation for ROX-Filer is available by choosing
3250 <guimenuitem>Show ROX-Filer Help</guimenuitem> from the
3251 popup menu, or by clicking on the <guibutton>i</guibutton>
3256 <refsect1><title>LICENSE</title>
3257 <para>Copyright (C) 2002 Thomas Leonard.
3259 You may redistribute copies of ROX-Filer under the terms of the GNU General
3264 <refsect1><title>BUGS</title>
3266 Report bugs to <email>tal197@users.sourceforge.net</email>.
3270 <refsect1><title>AUTHORS</title>
3272 ROX-Filer was created by Thomas Leonard, with help from:
3274 <simplelist columns='3'>
3275 <member>Michael Adams</member>
3276 <member>Christopher Arndt</member>
3277 <member>Jens Askengren</member>
3278 <member>Liav Asseraf</member>
3279 <member>Wilbert Berendsen</member>
3280 <member>Francesco Bochicchio</member>
3281 <member>Andrzej Borsuk</member>
3282 <member>Richard Boulton</member>
3283 <member>Simon Britnell</member>
3284 <member>Arnaud Calvo</member>
3285 <member>Babyfai Cheung</member>
3286 <member>Andrew Clover</member>
3287 <member>Fabien Coutant</member>
3288 <member>Couderc Damien</member>
3289 <member>Andreas Dehmel</member>
3290 <member>Micah Dowty</member>
3291 <member>Dmitry Elfimov</member>
3292 <member>Mattias Engdegard</member>
3293 <member>Andrew Flegg</member>
3294 <member>Olivier Fourdan</member>
3295 <member>Eric Gillespie</member>
3296 <member>Thierry Godefroy</member>
3297 <member>Olli Helenius</member>
3298 <member>Alex Holden</member>
3299 <member>Jasper Huijsmans</member>
3300 <member>Bernard Jungen</member>
3301 <member>James Kermode</member>
3302 <member>Jim Knoble</member>
3303 <member>Krzysztof Krzyzaniak</member>
3304 <member>Aaron Kurtz</member>
3305 <member>Vincent Ledda</member>
3306 <member>Vincent Lefevre</member>
3307 <member>Victor Liu See-le</member>
3308 <member>Anders Lundmark</member>
3309 <member>Jose Romildo Malaquias</member>
3310 <member>Denis Manente</member>
3311 <member>Brendan McCarthy</member>
3312 <member>Andras Mohari</member>
3313 <member>Christiansen Merel</member>
3314 <member>Jimmy Olgeni</member>
3315 <member>Andy Piper</member>
3316 <member>Marcelo Ramos</member>
3317 <member>Michel Alexandre Salim</member>
3318 <member>Chris Sawer</member>
3319 <member>Christian Storgaard</member>
3320 <member>Taras</member>
3321 <member>Simon Truss</member>
3322 <member>Jan Wagemakers</member>
3323 <member>Stephen Watson</member>
3324 <member>Andre Wyrwa</member>
3325 <member>Geoff Youngs</member>
3326 <member>Diego Zamboni</member>
3329 and many others; the <filename>Changes</filename> file contains more
3330 detailed information!
3337 <appendix id="soap"><title>SOAP RPC</title>
3339 <para>When the filer starts you can use command-line options to control its behaviour.
3340 As an alternative to this, the filer allows you to specify an operation with a
3341 <citation>SOAP</citation> RPC format message. In fact, if you use the command-line options,
3342 the filer converts to SOAP RPC internally.
3345 <para>All SOAP RPC messages are passed on standard input, like this:
3348 $ rox --RPC << EOF
3349 <?xml version="1.0"?>
3350 <env:Envelope xmlns:env="http://www.w3.org/2001/12/soap-envelope">
3351 <env:Body xmlns="http://rox.sourceforge.net/SOAP/ROX-Filer">
3353 <Name>Default</Name>
3354 <Side>Bottom</Side>
3357 </env:Envelope>
3360 The following methods are recognised:</para>
3364 <listitem><para><function>Version</function>()
3365 Returns the filer's version.
3368 <listitem><para><function>CloseDir</function>(<parameter>Filename</parameter>)
3369 Close directory <parameter>Filename</parameter> and all its subdirectories.
3372 <listitem><para><function>Examine</function>(<parameter>Filename</parameter>)
3373 <parameter>Filename</parameter> may have changed — check it and
3377 <listitem><para><function>OpenDir</function>(<parameter>Filename</parameter>,
3378 [<parameter>Style</parameter>, <parameter>Details</parameter>, <parameter>Sort</parameter>])
3379 Open a window showing directory <parameter>Filename</parameter>.
3380 <parameter>Style</parameter> is one of <userinput>Large</userinput>, <userinput>Small</userinput>
3381 or <userinput>Huge</userinput>.
3382 <parameter>Details</parameter> is one of <userinput>None</userinput>, <userinput>Summary</userinput>, <userinput>Size</userinput>, <userinput>Type</userinput>, <userinput>Times</userinput> or <userinput>Permissions</userinput>.
3383 <parameter>Sort</parameter> is one of <userinput>Name</userinput>, <userinput>Type</userinput>, <userinput>Date</userinput> or <userinput>Size</userinput>.
3384 If any of these three option parameters are missing, the default is used.
3387 <listitem><para><function>Panel</function>(<parameter>Side</parameter>,
3388 [<parameter>Name</parameter>])
3389 Open the panel named <parameter>Name</parameter> on screen side
3390 <parameter>Side</parameter> (<userinput>Top</userinput>|<userinput>Bottom</userinput>|<userinput>Left</userinput>|<userinput>Right</userinput>).
3391 <parameter>Name</parameter> can be a name in Choices (eg,
3392 <userinput>MyPanel</userinput>) or a full pathname.
3393 If not given, the panel on that side is turned off.
3396 <listitem><para><function>PanelAdd</function>(<parameter>Side</parameter>,
3397 <parameter>Path</parameter>, [<parameter>Label</parameter>,
3398 <parameter>After</parameter>])
3399 Add <parameter>Path</parameter> to the panel on side <parameter>Side</parameter>,
3400 with label <parameter>Label</parameter>. If <parameter>After</parameter> is
3401 <userinput>true</userinput> the icon goes on the right/bottom side of the panel,
3402 otherwise on the left/top side.
3405 <listitem><para><function>Pinboard</function>([<parameter>Name</parameter>])
3406 Display pinboard <parameter>Name</parameter> on the desktop background.
3407 <parameter>Name</parameter> can be a name in Choices (eg,
3408 <userinput>MyPinboard</userinput>) or a full pathname.
3409 If not given, the pinboard is turned off.
3412 <listitem><para><function>PinboardAdd</function>(<parameter>Path</parameter>,
3413 <parameter>X</parameter>, <parameter>Y</parameter>, [<parameter>Label</parameter>])
3414 Add <parameter>Path</parameter> to the pinboard at position
3415 (<parameter>X</parameter>, <parameter>Y</parameter>), giving it the label
3416 <parameter>Label</parameter>.
3419 <listitem><para><function>SetBackdropApp</function>(<parameter>App</parameter>)
3420 Make <parameter>App</parameter> (an application directory) the new handler
3421 for the current pinboard's backdrop.
3422 The <filename>AppInfo.xml</filename> file inside <parameter>App</parameter>
3423 must contain the CanSetBackdrop element, eg:
3425 <?xml version="1.0"?>
3427 <ROX:CanSetBackdrop xmlns:ROX="http://rox.sourceforge.net/SOAP/ROX-Filer"/>
3428 </AppInfo></programlisting>
3429 The application will be run with the <option>--backdrop</option> option
3430 as it's only argument after invoking this method, and whenever the pinboard is
3431 reloaded. DO NOT use this method if invoked with <option>--backdrop</option> or
3432 you will get stuck in an infinite loop!
3433 See <xref linkend="backdropapp"/> for a guide to writing backdrop applications.
3436 <listitem><para><function>Run</function>(<parameter>Filename</parameter>)
3437 Run <parameter>Filename</parameter> as if it was clicked on in the filer.
3440 <listitem><para><function>Show</function>(<parameter>Directory</parameter>,
3441 <parameter>Leafname</parameter>)
3442 Open <parameter>Directory</parameter> and flash the file
3443 <parameter>Leafname</parameter> inside it.
3446 <listitem><para><function>FileType</function>(<parameter>Filename</parameter>)
3447 Returns the MIME-type of <parameter>Filename</parameter> (by writing the
3448 SOAP response to standard output).
3453 The following calls can be used to start new file actions.
3454 <parameter>Quiet</parameter> can be <userinput>true</userinput> if the
3455 operation should start immediately, instead of waiting for the user to
3456 confirm. If <userinput>false</userinput>, the user must always confirm. If
3457 not given, the default setting is used.
3461 <listitem><para><function>Copy</function>(<parameter>From</parameter>,
3462 <parameter>To</parameter>, [<parameter>Leafname</parameter>,
3463 <parameter>Quiet</parameter>])
3464 Copy each file in the array <parameter>From</parameter> to the directory
3465 <parameter>To</parameter>. If <parameter>Leafname</parameter> is given
3466 then <parameter>From</parameter> should contain a single entry only;
3467 <parameter>Leafname </parameter> gives the new leafname.
3470 <listitem><para><function>Move</function>(<parameter>From</parameter>,
3471 <parameter>To</parameter>, [<parameter>Leafname</parameter>,
3472 <parameter>Quiet</parameter>])
3473 Move each file in the array <parameter>From</parameter> to the directory
3474 <parameter>To</parameter>. If <parameter>Leafname</parameter> is given
3475 then <parameter>From</parameter> should contain a single entry only;
3476 <parameter>Leafname</parameter> gives the new leafname.
3479 <listitem><para><function>Link</function>(<parameter>From</parameter>,
3480 <parameter>To</parameter>, [<parameter>Leafname</parameter>])
3481 Symlink each file in the array <parameter>From</parameter> to the
3482 directory <parameter>To</parameter>. If <parameter>Leafname</parameter> is
3483 given then <parameter>From</parameter> should contain a single entry only;
3484 <parameter>Leafname</parameter> gives the new leafname.
3487 <listitem><para><function>Mount</function>(<parameter>MountPoints</parameter>,
3488 [<parameter>OpenDir</parameter>, <parameter>Quiet</parameter>])
3489 Mount each directory in the list <parameter>MountPoints</parameter>. If
3490 <userinput>true</userinput>, <parameter>OpenDir</parameter> causes each
3491 directory to be opened once it is mounted.
3499 <title>References</title>
3502 <abbrev>ROX</abbrev><citetitle>The ROX desktop,
3503 <ulink url="http://rox.sourceforge.net"/></citetitle>
3507 <abbrev>RISC OS</abbrev><citetitle>RISC OS,
3508 <ulink url="http://www.riscos.com"/></citetitle>
3512 <abbrev>GTK+</abbrev><citetitle>GTK+ Toolkit,
3513 <ulink url="http://www.gtk.org"/></citetitle>
3517 <abbrev>libxml</abbrev><citetitle>The XML C library for Gnome
3518 <ulink url="http://www.xmlsoft.org"/></citetitle>
3522 <abbrev>GNOME</abbrev><citetitle>The GNOME desktop,
3523 <ulink url="http://www.gnome.org"/></citetitle>
3527 <abbrev>DND</abbrev><citetitle>The Drag and Drop protocol,
3528 <ulink url="http://www.newplanetsoftware.com/xdnd/"/></citetitle>
3532 <abbrev>XDS</abbrev><citetitle>The X Direct Save protocol,
3533 <ulink url="http://www.newplanetsoftware.com/xds/"/></citetitle>
3537 <abbrev>Choices</abbrev><citetitle>The ROX Choices system,
3538 <ulink url="http://rox.sourceforge.net/choices.php3"/></citetitle>
3542 <abbrev>AVFS</abbrev><citetitle>AVFS - A Virtual File System,
3543 <ulink url="http://sourceforge.net/projects/avf/"/></citetitle>
3547 <abbrev>SOAP</abbrev><citetitle>Simple Object Access Protocol (SOAP) 1.2
3548 <ulink url="http://www.w3.org/TR/SOAP/"/></citetitle>
3552 <abbrev>Thumbs</abbrev><citetitle>Thumbnail Managing Standard (Version 0.5)
3553 <ulink url="http://triq.net/~pearl/thumbnail-spec/"/></citetitle>
3557 <abbrev>SharedMIME</abbrev><citetitle>Shared MIME-info Database (Version 0.7)
3558 <ulink url="http://www.freedesktop.org/standards/shared-mime-info.html"/></citetitle>