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 at users.sourceforge.net</email></address>
19 <copyright><year>2003</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>
109 <varlistentry><term>Icon Themes</term>
111 Collections of file icons, called themes, can be installed (eg, to
112 <filename>~/.icons</filename>). You can switch between themes in
113 the Options box. Once other desktops support this fully, themes
114 will be sharable between desktops.
115 </para></listitem></varlistentry>
117 <varlistentry><term>DNotify support (Linux only)</term>
119 If used with a recent Linux kernel (2.4.x series), the filer will notice changes
120 to directories automatically. On other systems, directories will update when the
121 pointer is moved over them.
122 </para></listitem></varlistentry>
131 <chapter id="invoking">
132 <title>Invoking</title>
134 You should be able to start the filer by simply running the <userinput>rox</userinput>
135 command, by typing it at a shell prompt or otherwise. If the filer isn't installed yet,
136 consult <xref linkend="compiling"/>.
139 By default, <application>ROX-Filer</application> will start by displaying
140 the current directory. You can get it to display other directories instead
141 by listing them after the command:
143 <screen>$ rox /home /usr /usr/local</screen>
145 You can also use it to open files, like this:
147 <screen>$ rox README</screen>
149 The filer supports various options; use <option>-h</option> for a list.
150 All options have long and short forms (eg <option>-h</option> and
151 <option>--help</option>) — although on some systems you can only use the
154 Note that if the same version of the filer is already running on this
155 machine then, by default, it will be used to open the directories.
157 For a complete list of command-line options, see <xref linkend="manpage"/>
161 <title><anchor id="run_pin" xreflabel="Pinboard support"/>Pinboard support</title>
164 If you want the filer to manage your desktop background then you use
165 the <option>--pinboard</option> option and supply a name for the pinboard,
168 <screen>$ rox --pinboard=MyPinboard</screen>
170 The pinboard configuration is saved in
171 <filename><Choices>/ROX-Filer/pb_MyPinboard</filename>
172 as soon as you change it in some way (for example, by dropping a file
173 onto the background). You can have as many pinboards as you like and
174 switch between them by running rox again, eg:
176 <screen>$ rox --pinboard=MyOtherPinboard</screen>
178 To turn off the pinboard again, set the name to an empty string:
180 <screen>$ rox --pinboard=</screen>
182 See the <xref linkend="winman"/> if you have trouble getting the icons to
183 display correctly. The pinboard may also be turned on and off by locating
184 <filename>ROX-Filer</filename> in a filer window and choosing `Enable
185 pinboard' or `Disable pinboard' from the menu. </para>
189 <title><anchor id="run_pan" xreflabel="Panel support"/>Panels</title>
192 Panels work just like the pinboard. You can create a panel on any
193 side of the screen by using the options <option>--left</option>, <option>--right,</option>
194 <option>--top</option> and <option>--bottom</option>, depending on which side
195 of the screen the panel should appear on. On some systems, the short
196 (one letter) form of the options must be used. For example, to create
197 a panel along the bottom edge of the screen:
199 <screen>$ rox -b=MyPanel</screen>
201 The panel should be displayed in a window without a title bar. If
202 this does not work then see the <xref linkend="winman"/> for some ideas.
203 You can drag files onto either side of the panel to add them. Panel icons
204 can be repositioned by dragging them with the middle mouse button.
205 Changes to the panel are automatically saved to
206 <filename><Choices>/ROX-Filer/pan_MyPanel</filename>.
207 As with the pinboard, you can switch between panel configurations
208 simply by running rox again with a different panel name. Specify a
209 blank name to remove the panel.
211 <screen>$ rox --bottom=MyOtherPanel
212 $ rox --bottom=</screen>
217 <title><anchor id="winman" xreflabel="window manager notes"/>Window manager notes</title>
219 You may have to play around with your window manager a bit to get
220 the pinboard icons and panels to display correctly (eg, without borders
221 and underneath all other windows). In particular, try setting the
222 stacking level / depth to low (or a negative value). Make sure any
223 'Keep transients above other windows' type options are turned off!
226 <sect2><title>Sawfish / sawmill</title>
228 Sawfish tries to guess whether you are using GNOME at start-up and only
229 provides support if so. You may need to add the line
230 <programlisting>(require 'gnome)</programlisting>
231 to your <filename>.sawfishrc</filename> file (see the sawfish manual
236 <sect2><title>IceWM</title>
239 Paste these configuration settings into
240 <filename>~/.icewm/preferences</filename>:
243 # Manage root window (EXPERIMENTAL - normally enabled!)
244 GrabRootWindow=1 # 0/1
245 # Bitmask of root window button click to use in window manager
246 UseRootButtons=3 # [0-255]
247 # Desktop mouse-button click to show the menu
248 DesktopWinMenuButton=1 # [0-20]
249 # Desktop mouse-button click to show the window list
250 DesktopWinListButton=2 # [0-5]
251 # Desktop mouse-button click to show the window list menu
252 DesktopMenuButton=0 # [0-20]</programlisting>
253 Paste these into <filename>~/.icewm/winoptions</filename>:
256 # ROX-Filer pinboard and panel
257 ROX-Filer.icon: folder
258 ROX-Panel.layer: Dock
259 ROX-Panel.doNotCover: 1
260 ROX-Panel.ignoreWinList: 1
261 ROX-Panel.ignoreTaskBar: 1
262 ROX-Panel.ignoreQuickSwitch: 1
263 ROX-Pinboard.layer: Below
264 ROX-Pinboard.ignoreWinList: 1
265 ROX-Pinboard.ignoreTaskBar: 1
266 ROX-Pinboard.ignoreQuickSwitch: 1
267 ROX-Filer.layer: Normal</programlisting>
268 Restart IceWM and the filer for the new settings to take effect.
273 <sect2><title>Window Maker</title>
275 <step><para>Run the filer using <userinput>rox -p=Default</userinput>.</para></step>
277 Press <keycap>Control</keycap>+<keycap>Escape</keycap>, or
278 [RightButtonDown] on any window's titlebar.
279 Choose <guimenuitem>Attributes...</guimenuitem> from the menu.
283 The Attributes Inspector window appears. From the pulldown menu
284 at the top, choose <guimenuitem>Window Specification</guimenuitem>
289 Press the <guibutton>Select window</guibutton> button.
290 The cursor changes to a double crosshair. Select one of the
291 <application>ROX-Filer</application> pinboard icons. The radio buttons
292 in the <guilabel>Window Specification</guilabel> frame should change
293 their labels to include <userinput>ROX-Pinboard.ROX-Filer</userinput>
294 as the first item. Select that radio button.
298 Choose <guimenuitem>Window Attributes</guimenuitem> from the pulldown
299 menu. In the <guilabel>Attributes</guilabel> frame, choose the
300 features you want the pinboard icons to have; I recommend the
303 <listitem><para>Disable titlebar</para></listitem>
304 <listitem><para>Disable resizebar</para></listitem>
305 <listitem><para>Disable close button</para></listitem>
306 <listitem><para>Disable miniaturize button</para></listitem>
307 <listitem><para>Keep at bottom (sunken)</para></listitem>
308 <listitem><para>Omnipresent</para></listitem>
314 Choose <guimenuitem>Advanced Options</guimenuitem> from the pulldown
315 menu. In the <guilabel>Advanced</guilabel> frame, choose the advanced
316 features you wish; I recommend the following:
319 <listitem><para>Do not show in the window list</para></listitem>
320 <listitem><para>Ignore 'Hide Others'</para></listitem>
321 <listitem><para>Ignore 'Save Session' (possibly)</para></listitem>
326 When you're finished selecting window attributes, press the
327 <guibutton>Save</guibutton> button, and then close the Attributes
328 Inspector window using the <guibutton>X</guibutton> button in the titlebar.
333 <sect2><title>Others</title>
335 If all else fails, try the Compatibility section of the Options window.
341 <title>Running as root</title>
344 If you run the filer as the `root' user then the filer will display
345 a message at the top of each window to remind you. The root user has
346 permission to access or change any file in the system, so be very
347 careful when using the filer like this.
349 Normally, you should log in as an ordinary user and only change to
350 root when you need to. If you have <command>sudo</command> installed
351 and set up then you can run the filer like this:
353 <screen>$ sudo rox</screen>
355 Remember, any file operations you perform and any programs you run from
356 these windows will run as root too! Be careful!
358 You may find that the X server won't allow root (or other users) to
359 connect. Reading the manual pages for <command>xauth</command> and
360 <command>xhost</command> may give you some hints, but it varies
361 between systems (which is why this isn't built in to the filer!).
368 <chapter id="keys" xreflabel="mouse and key bindings">
369 <title>Mouse button and key bindings</title>
371 <itemizedlist><title>Quick start:</title>
373 <listitem><para>Click the left
374 <footnote><para>This documentation assumes that button–1 is the left
375 button, button–2 is the middle button and button–3 is the
376 right button. This is not always the case — for example, in a
377 left-handed setup.</para></footnote> mouse button to open files and
378 directories.</para></listitem>
381 Click the right button to get a menu. Click over a file to perform an action on that file.
385 Drag files between windows with the left button to copy, move or link them
386 (choose from a menu). Linking creates a shortcut to the original file.
392 By default, the mouse button bindings are designed to fit in with X
393 conventions. However, the behaviour is highly configurable — have a play in
394 the Options window if you don't like the normal settings. The normal settings
400 <thead><row><entry>Key or mouse button</entry><entry>Action</entry></row></thead>
404 <row><entry>Left button click</entry><entry>
405 Open the file or directory clicked on. Hold down <keycap>Control</keycap>
406 to select things instead of opening them. Hold down <keycap>Shift</keycap>
407 to look inside applications, treat files as text, follow symlinks, or
408 get more control over mount points (see <xref linkend="media"/>).
411 <row><entry>Middle button click</entry><entry>
412 Same as left click, but open a directory in a new window or close the viewer
416 <row><entry>Right button click</entry><entry>
417 Open the main menu. Hold down <keycap>Control</keycap> while clicking to go
418 directly to the Selection submenu. Hold down <keycap>Shift</keycap> to get the
419 <guimenu>Send To</guimenu> menu (see the <xref linkend="SendTo"/> section).
422 <row><entry>Drag an item (left mouse button)</entry><entry>
423 Show a menu of possible actions. There is an option to disable this menu,
424 in which case this gesture will copy the file(s) to the destination (an
425 application or another filer window). Hold down <keycap>Shift</keycap>
426 to move the file, <keycap>Control</keycap>+<keycap>Shift</keycap> to
427 create a symbolic link, or <keycap>Alt</keycap> to get the menu of
431 <row><entry>Drag an item (middle mouse button)</entry><entry>
432 When you let go, display a menu of possible actions.
433 There is an option to make this move the files rather than open the menu.
436 <row><entry>Drag (not over an item)</entry><entry>
437 Select a group of items by dragging a box around them. With the left
438 mouse button, only the files in the box will be selected. If you hold
439 down <keycap>Control</keycap> then the boxed items are added to the selection.
440 If you use the middle button then the boxed items switch between being selected
444 <row><entry>Double-click background</entry><entry>
445 Resize the window to a sensible size (this can be turned off from
449 <row><entry><keycap>Backspace</keycap></entry><entry>
450 Change to viewing the parent directory.
453 <row><entry>Cursor keys</entry><entry>
454 Move the cursor around.
458 <keycap>Page Up</keycap>, <keycap>Page Down</keycap></entry><entry>
459 Move the cursor up and down a page at a time.
462 <row><entry><keycap>Home</keycap>, <keycap>End</keycap></entry><entry>
463 Move to the first/last entry in the directory.
466 <row><entry><keycap>Return</keycap></entry><entry>
467 Acts like clicking on the file. You may hold down Shift for other
468 effects, as with clicking. Holding down Alt works like clicking with
469 the middle button; directories open in a new window and opening files
470 closes the directory at the same time.
473 <row><entry><keycap>Spacebar</keycap></entry><entry>
474 Toggles the item under the cursor between being selected and unselected,
475 and moves to the next item.
478 <row><entry><keycap>Tab</keycap>, <keycap>Shift</keycap>+<keycap>Tab</keycap></entry><entry>
479 Moves the cursor to the next/previous selected item.
482 <row><entry>Hold mouse over an item</entry><entry>
483 Shows a tooltip containing a brief description of an application (if
484 available), the target of a symbolic link, and the full name of a file,
485 if it's too long to show in the main window.
488 </tbody></tgroup></informaltable>
491 If you have user-defineable key-bindings enabled, then other keys can easily
492 be set by opening the menu, moving the pointer over the item you want to use
493 and pressing a key. The key will appear in the menu and can be used from
494 then on. Key bindings are automatically saved when the filer quits.
495 You can use an XSettings manager, such as ROX-Session, to turn this feature
496 on for all Gtk+-2.0 applications.
500 <chapter id="selection">
501 <title>The selection and file groups</title>
503 When you select items in a <application>ROX-Filer</application> window,
504 the filer takes the <emphasis>primary selection</emphasis>. You can then paste
505 into another window to get the pathnames of the selected files.
509 <title>Example: loading a file into an application that doesn't support
510 drag-and-drop:</title>
512 <step><para>Open the application's Open dialog box.</para></step>
515 <keycap>Control</keycap>-click on the file in
516 <application>ROX-Filer</application> to select it.</para></step>
519 Click the middle button in the filename box in the application to paste the
525 Note that clicking the middle mouse button in the main area of most web-browsers
526 will open the selected file.
528 If you select something else (eg, some text in another program), the selected
529 items in the filer window will be shown shaded (the filer no longer has the
530 primary selection). Clicking on one of the shaded items will cause the
531 filer to regain the primary selection.
534 <sect1><title>Saving and restoring the selection</title>
536 It is sometimes useful to save the current selection for later. You can
537 save the current selection to one of ten numbered groups by pressing
538 <keycap>Control</keycap>+<keycap><number></keycap>.
539 You can restore a saved group by pressing the group number on its own. You
540 can do this from a different directory, or even a different filer window.
542 Saving is also useful even if there is no selection, since it still saves
543 the current directory.
545 <procedure><title>Example: saving a directory and returning to it later:</title>
546 <step><para>You are looking at a directory, and wish to remember it.
547 Press <keycap>Control</keycap>+<keycap>1</keycap>.</para></step>
548 <step><para>Move to another directory, or close the window, etc.</para></step>
549 <step><para>Press <keycap>1</keycap> in any filer window to return
550 to the first directory.</para></step> </procedure>
551 <para>The groups are saved automatically for next time the filer is loaded.
555 <chapter id="toolbar">
556 <title><anchor id="Toolbar" xreflabel="Toolbar"/>The toolbar</title>
559 By default, each window has a toolbar along the top. You can disable
560 this (or make it larger) from the Options window, as well as set which
561 tools appear on the toolbar. Normally, you should click with the left
562 mouse button (1). However, many tools can perform a related function
563 if clicked on with buttons 2 or 3 (middle or right).
566 <informaltable><tgroup cols="3">
571 Mouse button 1</entry><entry>
580 Close the window</entry><entry>
582 </entry></row><row><entry>
583 Up arrow</entry><entry>
584 Change to parent directory</entry><entry>
585 Show parent in a new window <xref linkend="newwin_fn"/>
586 </entry></row><row><entry>
588 Change to home directory</entry><entry>
589 Show home in a new window <xref linkend="newwin_fn"/>
590 </entry></row><row><entry>
591 Jump to point</entry><entry>
592 Open the <xref linkend="bookmarks"/>
595 </entry></row><row><entry>
596 Looping arrows</entry><entry>
597 Reread the directory contents</entry><entry>
599 </entry></row><row><entry>
600 Magnifying glass (+)</entry><entry>
601 Select a larger icon size.</entry><entry>
602 Select a smaller icon size.
603 </entry></row><row><entry>
604 Magnifying glass (fit)</entry><entry>
605 Set Automatic sizing mode and resize the window.</entry><entry>
607 </entry></row><row><entry>
609 Hide or show extra details</entry><entry>
611 </entry></row><row><entry>
613 Step forward through the different sort types.</entry><entry>
614 Step backward through the sort types.
615 </entry></row><row><entry>
617 Toggle the display of hidden files (those with names starting with a dot)</entry><entry>
619 </entry></row><row><entry>
620 List with selections</entry><entry>
621 Select All.</entry><entry>
623 </entry></row><row><entry>
624 Life-belt</entry><entry>
625 Show <application>ROX-Filer</application>'s help files</entry><entry>
628 </tbody></tgroup></informaltable>
631 <anchor id="newwin_fn" xreflabel="[1]"/>[1]
632 If the 'New window on button 1' option is turned on
633 then the default is to open a new window — clicking with the other
634 button reuses the same window instead.
638 Dragging files to the Up or Home icons acts just like dragging them
639 into the directory which the button leads to. Dragging to the Bookmarks button
640 will add the directory as a bookmark.
643 The toolbar can also show the number of files in the directory, and
644 information about the selection. This can be turned on or off in the
650 <title>The menus</title>
652 By default, you can open a menu by right clicking over a pinboard, panel or
655 In filer windows, you may also press <keycap>\</keycap> to open the menu. As
656 a shortcut, you can open the File submenu directly by holding down the
657 <keycap>Control</keycap> key when opening the menu. Here is a full
658 description of each menu item:
660 <informaltable><tgroup cols="2">
662 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
665 <row><entry><guimenuitem>Display</guimenuitem></entry><entry>
666 Change the display settings.
669 <row><entry><guimenuitem>File</guimenuitem></entry><entry>
670 Operations on the selected items.
673 <row><entry><guimenuitem>Select</guimenuitem></entry><entry>
674 Control which items are selected.
677 <row><entry><guimenuitem>Options...</guimenuitem></entry><entry>
678 Configure <application>ROX-Filer</application>.
681 <row><entry><guimenuitem>New</guimenuitem></entry><entry>
682 Create a new file or subdirectory inside this directory.
685 <row><entry><guimenuitem>Window</guimenuitem></entry><entry>
686 Operations on the window as a whole.
689 <row><entry><guimenuitem>Help</guimenuitem></entry><entry>
690 Information about the filer.
693 </tbody></tgroup></informaltable>
698 <title>The display menu</title>
701 <informaltable><tgroup cols="2">
703 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
706 <row><entry><guimenuitem>Icons View</guimenuitem></entry><entry>
707 Files are displayed as rows of icons.
710 <row><entry><guimenuitem>Icons, With...</guimenuitem></entry><entry>
711 Files are displayed as rows of icons with additional details
712 (chosen from the submenu). To see fuller information about each file
713 use the List View instead.
716 <row><entry><guimenuitem>List View</guimenuitem></entry><entry>
717 Show files in a list along with their details. Click on a column heading
718 to sort by that column.
721 <row><entry><guimenuitem>Bigger Icons</guimenuitem></entry><entry>
722 Increase the size of the icons. Turns off Automatic mode.
725 <row><entry><guimenuitem>Smaller Icons</guimenuitem></entry><entry>
726 Reduce the size of the icons. Turns off Automatic mode.
729 <row><entry><guimenuitem>Automatic</guimenuitem></entry><entry>
730 Select a sensbile icon size automatically now and when changing
734 <row><entry><guimenuitem>Sort by XXX</guimenuitem></entry><entry>
735 Set the sort mode. In List View you can also set the sort type by
736 clicking on the column headings.
739 <row><entry><guimenuitem>Reversed</guimenuitem></entry><entry>
740 Sort in reverse order (newest to oldest, largest to smallest, etc).
743 <row><entry><guimenuitem>Show Hidden</guimenuitem></entry><entry>
744 If on, files beginning with a dot are shown, otherwise they are hidden.
745 The titlebar shows <guilabel>(All)</guilabel> when this is on.
748 <row><entry><guimenuitem>Show Thumbnails</guimenuitem></entry><entry>
749 When on, the filer tries to load every image file and use that
750 image as the file's icon. Useful if you have a directory full of
751 photos and can't remember which is which!
752 See the <xref linkend="thumbnails"/> section for details.
755 <row><entry><guimenuitem>Refresh</guimenuitem></entry><entry>
756 Rereads the contents of the directory and details of all the files
757 in it. Use this if the display becomes out-of-date.
759 </tbody></tgroup></informaltable>
763 <sect2><title><anchor id="Permissions" xreflabel="Permissions"/>
768 The permissions field, when shown, is made up of four groups of three
769 flags. Each flag is displayed as a letter if it is on and a dash (–)
770 if not. The first three characters show the permissions for the owner
771 of the file, the second for other members of the file's group and
772 the third for everyone else. Whichever group applies to the
773 <application>ROX-Filer</application> process itself is shown underlined.
774 The fourth group shows any special flags.
776 The meanings of the characters are:
780 <listitem><para><computeroutput>r</computeroutput> —
781 Permission to read the contents of a file, or the names of files
782 in a directory.</para></listitem>
784 <listitem><para><computeroutput>w</computeroutput> —
785 Permission to alter the contents of a file, or change which names
786 appear in a directory.</para></listitem>
788 <listitem><para><computeroutput>x</computeroutput> —
789 Permission to run the file as a program, or refer to the files
790 listed within the directory.</para></listitem>
792 <listitem><para><computeroutput>U</computeroutput> —
793 This program executes with the <emphasis>effective user ID</emphasis> of its
794 owner rather than the person who ran it.</para></listitem>
796 <listitem><para><computeroutput>G</computeroutput> —
797 This program executes with the <emphasis>effective group ID</emphasis> of its
798 group, regardless of who ran it.</para></listitem>
800 <listitem><para><computeroutput>T</computeroutput> —
801 Entries in this directory can only be altered or removed by the
802 people who own the files even if they have write permission on the
803 directory itself.</para></listitem>
808 <emphasis role="underline">rwx</emphasis>,rwx,r-x/---</programlisting>
809 means that the owner of the file is the same as the effective user of
810 <application>ROX-Filer</application> (basically, you own the file), you and
811 members of the file's group have read, write and execute permission and other
812 people have only read and execute permission. There are no special flags set.
814 The rules which determine which permissions apply may vary slightly between
815 operating systems, but a rough guide is:
819 <listitem><para>If the <emphasis>effective user ID</emphasis> of the
820 process is equal to the file's owner, then the owner permissions apply.
823 <listitem><para>Otherwise, if the <emphasis>effective group ID</emphasis>
824 of the process is equal to the file's group OR the file's group is one
825 of the process's <emphasis>supplemental groups</emphasis> then the
826 group permissions apply.
829 <listitem><para>Otherwise, the `other' permissions apply. The
830 <emphasis>real user ID</emphasis> and <emphasis>real group
831 ID</emphasis> have no effect (except that a process may set its real
832 IDs to its effective IDs).
842 <title>The file menu</title>
844 All of these work in the same way — if you open the menu with some
845 items selected then the operation applies to those items. If you open
846 then menu over an item while there is no selection then that item
847 is temporarily selected.
849 If you choose one of these while there is no selection at all then the
850 window goes into `target mode'; the operation happens to the next item you
851 click on. Click on the window background, press <keycap>Escape</keycap>, or
852 click with the right mouse button to cancel target mode. Target mode is
853 mainly useful with the <guilabel>Single-click navigation</guilabel> option
854 and keys bound to the various menu entries. </para><para>
855 Note that individual applications may add extra menu items to the
856 top of this submenu when you click over them — see
857 <xref linkend="AppDir"/> for details. There may also be any number of
858 user-defined actions at the top, which depend on the type of file
859 clicked on. You can add programs here by choosing the
860 <guimenuitem>Customise Menu</guimenuitem> item. For example, you could
861 make <application>The Gimp</application> appear on the menu for images, and
862 <application>FreeFS</application> appear for mount points.
864 <informaltable><tgroup cols="2">
865 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
869 <guimenuitem>Copy...</guimenuitem></entry><entry>
870 Make a copy of this object.
874 <guimenuitem>Rename...</guimenuitem></entry><entry>
875 Change the name used for this object, or move it between directories.
879 <guimenuitem>Link...</guimenuitem></entry><entry>
880 Create a symbolic link to this name.
884 <guimenuitem>Delete</guimenuitem></entry><entry>
885 Remove all the selected entries from the directory. Subdirectories
886 will have their contents deleted first. Deleting symlinks only removes
887 the link, not the thing it points to.
891 <guimenuitem>Shift Open</guimenuitem></entry><entry>
892 Opens applications as directories, files as text/plain, and
893 symlinks by opening the directory containing the thing they point to.
894 It also has interesting effects on mount points (see <xref linkend="media"/>).
895 This is the same effect as clicking with <keycap>Shift</keycap> held
896 down. The text of the menu entry changes to show which action will be
901 <guimenuitem>Open AVFS</guimenuitem></entry><entry>
902 Open the file as if it was a directory — see the
903 <xref linkend="vfs"/> section.
907 <guimenuitem>Send To...</guimenuitem></entry><entry>
908 Opens the `Send To' menu, allowing you to send the selected files
909 to one of a list of applications. See the
910 <xref linkend="SendTo"/> section.
914 <guimenuitem>Set Run Action...</guimenuitem></entry><entry>
915 Allows you to set the default program to use when opening files of
916 this type. See <xref linkend="RunAction"/> section for details.
920 <guimenuitem>Set Icon...</guimenuitem></entry><entry>
921 You can give each file or directory its own special icon using this
922 feature — simply drag a suitable image onto <xref linkend="SetIcon"/>.
926 <guimenuitem>Properties</guimenuitem></entry><entry>
927 Display extra information about this object. You can also change
928 the access permissions from here (<guimenuitem>Permissions</guimenuitem>
929 below allows you to change many files at once), and change the target
930 to which a symlink points.
934 <guimenuitem>Count</guimenuitem></entry><entry>
935 Count the sizes of all the selected items. Directories also have their
936 contents counted. Symlinks count themselves, not the things they point
941 <guimenuitem>Set Type...</guimenuitem></entry><entry>
942 Set the MIME type for a file. This only works on filesystems with extended attribute support. For older filesystems, you will have to rename a file to change its type.
946 <guimenuitem>Permissions</guimenuitem></entry><entry>
947 Allows you to change the permissions for the selected files.
948 If only one file is to be changed, you can use
949 <guimenuitem>Properties</guimenuitem> instead for a simpler interface.
953 <guimenuitem>Find</guimenuitem></entry><entry>
954 Search for files by specifying various conditions — see the
955 <xref linkend="Searching"/> section.
958 </tbody></tgroup></informaltable>
961 <formalpara><title>Note about symlinks:</title>
963 A symbolic link stores the <emphasis>location</emphasis>
964 of another file. Deleting the symlink doesn't affect the other file.
965 Deleting the other file means that the symlink won't work. There are
966 two types of symbolic link — Relative and Absolute. An absolute
967 link stores the path from the root directory to the target file (eg
968 <filename>/home/fred/MyFile</filename>).
970 A relative path stores the path from the symlink
971 to the target (eg <filename>../fred/MyFile</filename>).
972 If the target file is never going to move then you want an absolute link,
973 but if the target may move (and the symlink will be moved with it) then
974 you want a relative link.
980 <title>The select menu</title>
982 This menu allows you to select and unselect files in various ways. See the
983 <xref linkend="keys"/> section for other ways to select files.
985 <informaltable><tgroup cols="2">
986 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
989 <guimenuitem>Select All</guimenuitem></entry><entry>
990 Select every item in this window.
993 <row><entry><guimenuitem>Clear Selection</guimenuitem></entry><entry>
994 Unselect every item in this window.
997 <row><entry><guimenuitem>Invert Selection</guimenuitem></entry><entry>
998 Every selected file becomes unselected, and every unselected file
1003 <guimenuitem>Select If...</guimenuitem></entry><entry>
1004 Select just those files that match the given pattern —
1005 see the <xref linkend="SelectIf"/> section.
1008 </tbody></tgroup></informaltable>
1014 <title>The new menu</title>
1017 Each entry in this submenu opens a savebox for creating a new file or
1018 directory. There are two standard entries; the others are the contents of
1019 your <filename><Choices>/Templates</filename> directory, if it
1023 <informaltable><tgroup cols="2">
1024 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
1027 Directory</entry><entry>
1028 Create a new directory.
1029 </entry></row><row><entry>
1031 Create a blank file.
1032 </entry></row><row><entry>
1033 <user entries></entry><entry>
1034 Copy a file from your Templates directory.
1036 </tbody></tgroup></informaltable>
1039 To add your own entries, create a new directory called
1040 <filename>~/Choices/Templates</filename>
1041 (if you have the default <envar>CHOICESPATH</envar>) and put any files you
1042 want in there. Each file in the directory will appear on the menu and the
1043 box that appears will copy it. For example, you could create a blank
1049 <title>My Page</title>
1054 </html></programlisting>
1056 Save this as <filename>index.html</filename> inside the
1057 <filename>Templates</filename> directory and you can easily create new
1058 HTML files. You can also save blank documents from various applications
1059 into here (eg, a blank spreadsheet, a blank letter, etc).
1061 Note that you cannot set keyboard shortcuts for these user-defined
1068 <title>The window menu</title>
1072 <informaltable><tgroup cols="2">
1073 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
1076 <guimenuitem>Parent, New Window</guimenuitem></entry><entry>
1077 Open a new window displaying this window's parent.
1081 <guimenuitem>Parent, Same Window</guimenuitem></entry><entry>
1082 As above, but reuse this window.
1086 <guimenuitem>New Window</guimenuitem></entry><entry>
1087 Open another window onto this directory.
1091 <guimenuitem>Home Directory</guimenuitem></entry><entry>
1092 Change to your home directory.
1096 <guimenuitem>Show Bookmarks</guimenuitem></entry><entry>
1097 Open the bookmarks menu (see <xref linkend="bookmarks"/>).
1101 <guimenuitem>Follow Symbolic Links</guimenuitem></entry><entry>
1102 Converts the path shown in the window's titlebar to its canonical form.
1103 For example, if <filename>/home/fred/link</filename> is a symlink
1104 pointing to <filename>/usr/share/doc/</filename> then clicking on the symlink
1105 will take you to that directory and going `up' will take you back to
1106 <filename>/home/fred</filename>.
1107 If you'd used <guimenuitem>Follow Symbolic Links</guimenuitem>, you would
1108 have ended up in <filename>/usr/share</filename> instead.
1112 <guimenuitem>Resize Window</guimenuitem></entry><entry>
1113 Set the window to a sensible size for its contents.
1117 <guimenuitem>Close Window</guimenuitem></entry><entry>
1122 <guimenuitem>Enter Path...</guimenuitem></entry><entry>
1123 Open the path-entry box (see the the <xref linkend="mini"/> section).
1127 <guimenuitem>Shell Command...</guimenuitem></entry><entry>
1128 Open the shell command box (see the <xref linkend="mini"/> section).
1131 <row><entry><guimenuitem>Xterm Here</guimenuitem></entry><entry>
1132 Open an xterm with its current directory set to this directory.
1135 <row><entry><guimenuitem>Switch to xterm</guimenuitem></entry><entry>
1136 Open an xterm with its current directory set to this directory, and close the
1137 filer window at the same time.
1140 </tbody></tgroup></informaltable>
1147 <title>The help menu</title>
1150 <informaltable><tgroup cols="2">
1151 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
1154 <guimenuitem>About ROX-Filer...</guimenuitem></entry><entry>
1155 Display information about the file. This is the same as locating ROX-Filer
1156 itself in a filer window and selecting <guimenuitem>Properties</guimenuitem> from
1161 <guimenuitem>Show Help Files</guimenuitem></entry><entry>
1162 Same as selecting ROX-Filer and choosing
1163 <guimenuitem>Help</guimenuitem> from the file menu.
1167 <guimenuitem>Manual</guimenuitem></entry><entry>
1168 Opens the HTML manual for your language, or the English version if there
1172 </tbody></tgroup></informaltable>
1178 <title><anchor id="SendTo" xreflabel="Send To menu"/>The send to menu</title>
1181 The `Send To' menu provides a quick way to send some files to an application.
1182 The filer scans all the <filename>SendTo</filename> directories in your
1183 <envar>CHOICESPATH</envar> and lists the contents on this menu.
1185 To change which applications appear here you should choose the
1186 <guimenuitem>Customise</guimenuitem> item from the bottom
1187 of the menu to create and open your own <filename>SendTo</filename>
1188 directory. Applications can be symlinked into this directory by dragging
1189 them in and choosing <guimenuitem>Link</guimenuitem> from the menu.
1191 Opening the Send To menu via the main menu is rather slow, so it is
1192 normally opened by clicking the Menu mouse button over a file while
1193 holding the <keycap>Shift</keycap> key down.
1196 <title>Showing different applications for different types</title>
1198 You may want to set things up so that, for example, the Gimp is
1199 only shown when an image is selected. To do this, create a
1200 hidden directory inside <filename>SendTo</filename> called
1201 <filename>.image</filename>, or whatever type you want to use.
1202 You can use either the complete type (eg <filename>.image_png</filename>)
1203 or just the media type. Use <guimenuitem>Properties</guimenuitem> over a
1204 file to find out its MIME type.
1207 Entries in these hidden directories are shown only for files of
1208 the appropriate type. If multiple files are selected, the
1209 <filename>.group</filename> directory is used instead.
1215 <title><anchor id="bookmarks" xreflabel="Bookmarks menu"/>The bookmarks menu</title>
1217 The bookmarks menu can be used to store a list of frequently used directories.
1218 You can also open the menu from the main popup menu (in the <guimenuitem>Window</guimenuitem> submenu)
1219 and you can use this to bind a shortcut key to it. From the bookmarks menu
1220 you can add the currently shown directory to the list, jump to one of the
1221 stored directories, or open a dialog letting you edit the list. In the dialog
1222 box, you can remove entries, rearrange them (using the arrows or by
1223 dragging) and edit the pathnames directly, if required.
1226 The <guimenuitem>Recently Visited</guimenuitem> submenu shows the last few directories
1227 viewed. Choosing one will switch to that directory. The current directory is shown
1228 shaded, since you are already there.
1234 <chapter id="icons">
1235 <title>The pinboard and panels</title>
1238 The <xref linkend="run_pin"/> and <xref linkend="run_pan"/> sections explain
1239 how to turn the pinboard and panels on. Once on, you may drop items from filer
1240 windows onto the them to pin them up. Clicking on a pinned item acts just like
1241 clicking on it in a filer window. You can drag pinned icons just like normal
1242 icons and you can right-click on one to see the popup menu.
1244 Drag panel icons with the middle mouse button to move them around.
1245 In previous versions of the filer, pinboard icons were also moved using the
1246 middle mouse button, but this is no longer supported (as the middle button
1247 is reserved for the window manager's use).
1249 You can assign keyboard shortcuts to pinboard and panel icons. These can be
1250 used to open directories, files or applications quickly, even if another
1251 window has the focus.
1253 Changes to the pinboard and panel are automatically saved. Clicking on pinned
1254 icons with <keycap>Control</keycap> held down selects and unselects them.
1255 Click on the background to unselect them all.
1259 Pinning a file does <emphasis>not</emphasis> copy it, it merely
1260 creates a shortcut to the original file. If you delete the file, then
1261 you've lost it! Removing a pinned file from its pinboard or panel
1262 only removes the link. This is different to most other filers...
1266 <title>The pinboard and panel menus</title>
1269 <informaltable><tgroup cols="2">
1270 <thead><row><entry>Entry</entry><entry>Action</entry></row></thead>
1274 <guimenuitem>ROX-Filer</guimenuitem></entry><entry>
1275 Show the filer's help, edit the options or open your home directory.
1279 <guimenuitem>File `file'</guimenuitem></entry><entry>
1280 Offers a smaller version of the filer's submenu of the same name.
1284 <guimenuitem>Edit Item</guimenuitem></entry><entry>
1285 Change the name displayed under the icon, or the pathname the item
1286 points to. You can also set a keyboard shortcut for the icon here.
1290 <guimenuitem>Show Location</guimenuitem></entry><entry>
1291 Open a directory viewer showing where the file is stored.
1295 <guimenuitem>Remove Item(s)</guimenuitem></entry><entry>
1296 Remove the selected items from the pinboard or panel.
1300 <guimenuitem>Backdrop...</guimenuitem></entry><entry>
1301 Set the desktop backdrop image (see below). Only available from
1305 </tbody></tgroup></informaltable>
1308 If you are setting up the defaults for multiple users and
1309 you wish to create a `Home' icon that leads to each user's home directory
1310 then you should first create a new icon and then use
1311 <guimenuitem>Edit Icon</guimenuitem> to change the location to
1312 <filename>~</filename> and the name to `Home'.
1314 Note that individual applications may add extra menu items to the
1315 top of this menu when you click over them — see <xref linkend="AppDir"/>
1321 <title>Panel applets</title>
1324 <application>ROX-Filer</application> allows you to run small programs
1325 inside the panel — such programs are called
1326 <emphasis>applets</emphasis>. To run an applet, drag it onto the panel from
1327 a filer window and instead of the applet's icon being shown, the applet
1331 <procedure><title>To create your own applets (programmers only!):</title>
1334 Create a directory for the applet (eg <filename>MyApplet</filename>).
1338 Use the <guimenuitem>Set Icon...</guimenuitem> feature to create an icon
1339 called <filename>.DirIcon</filename> inside it (so the directory appears
1344 Make a <filename>Help</filename> directory inside it for when the user
1345 chooses <guimenuitem>Help</guimenuitem> from the menu.
1349 Create an executable file called <filename>AppletRun</filename>. This will be
1350 passed the XID of the panel socket window when the directory is dragged
1351 onto the panel. You can use this to create a GtkPlug widget. An
1352 example applet (written in python) is available at
1353 <ulink url="http://rox.sourceforge.net/applets.html"/>
1360 <title><anchor id="iconify" xreflabel="Iconified windows"/>Iconified windows on the pinboard</title>
1362 When the pinboard is in use, ROX-Filer can be used to display an icon for each iconified
1363 (or 'minimised') window. You can turn this on or off from the Options box. Iconified window icons
1364 have a semi-transparent background slab effect, and can be dragged around.
1365 Clicking on one will expand it back into the window it represents. Some
1366 older window managers do not support this, and no icons will be shown.
1371 <title><anchor id="backdropapp" xreflabel="Backdrop applications"/>The pinboard backdrop image</title>
1373 You can set any image for the backdrop by choosing <guimenuitem>Backdrop...</guimenuitem>
1374 from the pinboard menu (right-click over the desktop background when the pinboard is turned on).
1377 To set an image, select <guilabel>Centre</guilabel>, <guilabel>Scale</guilabel>,
1378 <guilabel>Stretch</guilabel> or <guilabel>Tile</guilabel> to set the style,
1379 and then drag an image onto the marked area. To return to a solid colour
1380 backdrop (as set in the Options box), click on <guibutton>Clear</guibutton>.
1382 The Wallpaper<citation>Wallpaper</citation> application can be used for more complicated
1383 effects, such as choosing a new random image each hour, or rendering an image of the Earth
1384 as it is currently lit by the sun.
1386 <formalpara><title>For programmers...</title>
1388 If you want to create an application to set the backdrop (eg, to choose a
1389 random image, or a slideshow) you need to first create an application directory
1390 (see <xref linkend="AppDir"/>).
1393 When run without arguments, the application should invoke the
1394 <function>SetBackdropApp</function> SOAP method (see <xref
1395 linkend="soap"/>). The filer will immediately run the application again,
1396 this time with the <option>--backdrop</option> option.
1398 When run with <option>--backdrop</option>, the program should write the style and name of
1399 the image file to display to its standard output stream, eg:
1400 <screen>tile /tmp/image.png</screen>
1401 <userinput>centre</userinput> and <userinput>scale</userinput> are the other possible
1402 styles. The filer will then load this image and display it. The application does not
1403 set the backdrop itself, it only tells the filer what to display.
1405 In the case of a random backdrop chooser, the program may then quit immediately. If
1406 the application created a temporary image then it should read the line "ok\n" from its
1407 standard input before deleting the image.
1409 If the application wishes to show a sequence of images it should still read "ok\n",
1410 then wait until it's time to display the next image and then write that filename, and
1413 The filer will indicate that the program should stop running by closing the two
1414 streams. The program should clean up and exit at this point. Be sure to catch
1415 SIGPIPE when writing to standard output if you need to delete any temporary files.
1417 See the Wallpaper<citation>Wallpaper</citation> application for a complete example application
1418 (written in python).
1425 <anchor id="media" xreflabel="Removable devices"/>Removable devices
1428 Using removable devices, such as floppy disks and CDROMs under ROX-Filer is quite
1429 simple. However, it is important to understand about <emphasis>mounting</emphasis> and
1430 <emphasis>unmounting</emphasis> devices.
1433 Mounting a device causes its contents to appear in the filesystem. On a typical setup,
1434 the directory <filename>/floppy</filename> is an empty directory on the hard disk.
1435 The floppy device is then mounted onto this directory, causing its contents to appear
1436 inside. For example, a file called <filename>Letter</filename> on the floppy disk will
1437 appear as <filename>/floppy/Letter</filename>.
1440 Devices must be unmounted before the disk is removed. Unmounting causes the system to
1441 write any buffered data to the disk. If you remove a disk without unmounting
1442 it, it will probably be corrupted. CD and Zip drives often lock the tray while the
1443 device is mounted so you can't remove it accidentally.
1446 So that you don't have to specify which device should be mounted at which point in the
1447 filesystem every time you want to use a disk, a preset list is usually found in the
1448 file <filename>/etc/fstab</filename>. ROX-Filer shows mount points (such as
1449 <filename>/floppy</filename>) which are listed here but not mounted with transparent
1450 grey circles overlayed on their icons.
1453 Clicking on one of these mount points will mount the device for you. The circle turns
1454 green to indicate that the device is now mounted. Do <emphasis>not</emphasis> remove
1455 the device while the circle is lit! You can unmount the device by clicking
1456 while holding down <keycap>Shift</keycap> on the <filename>/floppy</filename>
1460 You can also unmount a device by closing its directory window (eg, closing
1461 the view of <filename>/floppy</filename>) and choosing Unmount when prompted. The
1462 filer will only offer to unmount devices this way if they were mounted by
1463 the filer in the first place.
1466 If you want to open a directory without mounting anything (eg, if you want to
1467 see the contents of <filename>/floppy</filename> on the hard disk), you can
1468 click on the unmounted mount point with <keycap>Shift</keycap> held down.
1469 This isn't usually useful, as these directories are typically empty.
1474 <title><anchor id="thumbnails" xreflabel="Thumbnails"/>File thumbnails</title>
1476 When thumbnailing is turned on, the filer tries to load every image file
1477 and use that image as the file's icon. Useful if you have a directory full
1478 of photos and can't remember which is which! You can turn it on for
1479 a single directory by choosing <guimenuitem>Show Thumbnails</guimenuitem>
1480 from the <guimenu>Display</guimenu> menu. You can set it as the default
1481 from the Options box.
1482 The titlebar shows <guilabel>(Thumbs)</guilabel> when thumbnailing is on.
1485 The thumbnails are saved in <filename>~/.thumbnails</filename> for
1486 quick loading next time.
1487 While loading thumbnails, a progress bar appears at the bottom of
1488 the window. Clicking on the <guibutton>Cancel</guibutton> button
1489 beside the bar stops the scan.
1490 It is also possible to thumbnail other types of file, such as videos
1491 (eg, by showing the first frame), with a suitable helper program.
1493 <sect1><title>Technical details</title>
1495 When in thumbnail mode <application>ROX-Filer</application> checks the
1496 thumbnail directory (<filename>~/.thumbs/normal</filename>) for a
1497 thumbnail for each file it scans. If a thumbnail exists it loads it and
1498 continues on to the next file.
1500 To generate a thumbnail for a given file of type media/subtype the filer looks
1501 for a program <filename><Choices>/MIME-thumb/media_subtype</filename>,
1502 falling back to <filename><Choices>/MIME-thumb/media</filename> if one
1503 cannot be found (this duplicates how run actions for files are looked up). If
1504 neither file can be found and the file is of type image/* then the internal
1505 routines are used. If the file is not of type image/* then no thumbnail is
1508 If the generator program is found, is executed with the parameters
1509 <screen>thumbnailer /path/to/source/file /path/to/thumbnail pixel_size</screen>
1511 Once the child program exits, it attempts to load
1512 <filename>/path/to/thumbnail</filename>. If that fails no thumbnail is
1515 Note that because of the order it does things ROX-Filer will happily
1516 use any pre-existing thumbnail even if it has no idea how it was
1523 <chapter id="virtual">
1525 <anchor id="vfs" xreflabel="Virtual file systems"/>Virtual file systems
1528 Some types of file can be represented as a directory. A typical example
1529 is a zip file, which contains an entire directory structure in compressed
1530 form. It is often useful to be able to open up such a file as if it
1531 was a real directory, and the VFS system allows you to do this.
1533 To use this feature you must have a system such as
1534 AVFS<citation>AVFS</citation> installed, which causes the kernel to support
1535 various Virtual File Systems directly.
1540 <chapter id="minibuffer">
1541 <title><anchor id="mini" xreflabel="Minibuffer"/>The mini-buffer</title>
1544 The mini-buffer is a white bar that appears along the bottom of the
1545 window and allows you to enter some text. Press <keycap>Escape</keycap> to
1546 get rid of it again. It behaves in different ways depending on how you
1551 <title>The path-entry box</title>
1554 This allows you to type in a path directly. As you type the display
1555 is updated to show the item entered visually. The main use is to find
1556 a file in a large directory quickly, but you can also use it for navigating
1557 between directories, or for selecting a full pathname from somewhere
1558 else and pasting it directly into the path-entry box.
1561 <informaltable><tgroup cols="2">
1562 <thead><row><entry>Key</entry><entry>Action</entry></row></thead>
1566 <keycap>Return</keycap></entry><entry>
1567 Open the currently selected item.
1571 <keycap>Tab</keycap></entry><entry>
1572 Shell-style tab completion.
1576 <keycap>Up</keycap>, <keycap>Down</keycap></entry><entry>
1577 Select the previous/next matching entry.
1579 </tbody></tgroup></informaltable>
1584 If you start entering a name beginning with a `.' then the `Show Hidden'
1585 feature is temporarily turned on so that the file can be shown.
1589 Tab completion tries to fill in as many characters for you as it can.
1590 For example, if there are two files in a directory called
1591 <filename>save-mail-nov-1999</filename> and
1592 <filename>save-mail-dec-1999</filename> then typing
1593 <userinput>save</userinput> and pressing <keycap>Tab</keycap> will expand
1594 <userinput>save</userinput> to <userinput>save-mail-</userinput> and beep
1595 to indicate that the match is not complete. If you use tab completion on a
1596 directory and it is unique then the filer will automatically change into
1597 the directory. This behavior should be familiar to shell users.
1600 <informalexample><para>
1601 Let's say you want to locate the documentation for Wine in the directory
1602 <filename>/usr/share/doc</filename> (which is usually very large).
1603 Here's how you could do it:
1608 Open the minibuffer by choosing <guimenuitem>Enter
1609 Path...</guimenuitem> from the <guimenu>Window</guimenu> menu, or
1610 by pressing the slash (<keycap>/</keycap>) key.
1614 Press <keycap>CTRL</keycap>+<keycap>A</keycap> to select the existing
1620 <userinput>u<Tab>sh<Tab>do<Tab>wi<Tab></userinput>.
1621 As you type, the cursor will move to the correct subdirectory.
1622 If it beeps when you press <keycap>Tab</keycap> then you need to supply
1623 more letters, or press <keycap>Return</keycap>.
1628 </para></informalexample>
1632 <title>The shell command box</title>
1635 This provides a quick way of entering shell commands if you don't
1636 want to open an xterm. If you don't know what shell commands are,
1639 Just type in the command and press <keycap>Return</keycap> to execute it.
1640 <keycap>Up</keycap> and <keycap>Down</keycap> arrows move through previously
1642 <keycap>Tab</keycap> does shell-style completion.
1643 Clicking on an item inserts its name into the minibuffer.
1644 If some items are selected then they are assigned to the positional
1645 parameters <userinput>$1</userinput>, <userinput>$2</userinput>, etc.
1647 Opening the minibuffer with a selection adds <computeroutput>"$@"</computeroutput>
1648 to the end of the command — this expands to all the selected files.
1651 <informalexample><para>Examples:
1653 <orderedlist><title>To untar a <filename>.tgz</filename> archive:</title>
1656 Open the minibuffer by choosing <guimenuitem>Shell Command...</guimenuitem> from
1657 the <guimenu>Window</guimenu> menu.
1658 I usually bind this to the bang (<keycap>!</keycap>) key.
1662 Type <userinput>tar xzf</userinput> and click on the file.
1663 The leading space is automatically inserted.
1667 Press <keycap>Return</keycap> to execute it.
1672 <orderedlist><title>To print all the selected files:</title>
1675 Open the shell command minibuffer.
1679 Type <userinput>lpr</userinput> at the beginning of the line and press
1680 <keycap>Return</keycap>.
1685 </para></informalexample>
1687 <itemizedlist><title>Notes</title>
1690 Be careful; you will not be asked to confirm! If in doubt, start the
1691 command with <userinput>xmessage</userinput> so that it will be displayed
1692 rather than executed.
1696 <citerefentry><refentrytitle>sh</refentrytitle></citerefentry>
1697 is always used as the name of the shell to run (mainly because
1698 <citerefentry><refentrytitle>bash</refentrytitle></citerefentry> and
1699 <citerefentry><refentrytitle>csh</refentrytitle></citerefentry> treat
1700 positional parameters differently).
1701 However, <envar>PATH</envar> is searched to find it so you can still use
1702 another shell if you want by naming it sh and putting it in your path.
1706 Commands execute in the background, so you can say:
1708 <command>sleep 240; xmessage Time to go!</command>
1715 <title><anchor id="SelectIf" xreflabel="Select If"/>The conditional
1716 selection box</title> <para>
1718 Use this if you want to automatically select all files in the directory
1719 which match a condition.
1721 <orderedlist><title>For example, to select all files larger than 5Mb:</title>
1724 Open the Select If minibuffer.
1728 Type <userinput>Size > 5Mb</userinput> and press <keycap>Return</keycap>.
1733 Just those files over 5 Mb in size will be selected. The expressions
1734 you can enter are in the same form as described in the
1735 <xref linkend="Searching"/> section, except that
1736 <userinput>prune</userinput> has no effect since the contents of
1737 directories are never checked anyway. You can press <keycap>Tab</keycap>
1738 to jump to each selected file in turn.
1744 <chapter id="actions">
1745 <title>Action windows</title>
1747 Action windows are those boxes that appear while you're doing a
1748 Copy/Move/Link/etc operation. The status line at the top of the window shows
1749 the current directory or object that the window is processing. The scrolling
1750 area below is the log area — it shows what has been done, and questions
1751 may be displayed here.
1754 <imagedata align="center" format="PNG" fileref="../Action.png"/>
1758 Below this are four buttons and some options. All windows have the
1759 <guilabel>Quiet</guilabel> option. When this is on the filer will only
1760 confirm some operations (such as deleting a non-writeable file). Otherwise,
1761 all operations are confirmed.
1763 The buttons work as follows:
1767 <varlistentry><term><guibutton>Yes</guibutton></term><listitem><para>
1768 answers yes to the question displayed in the log area.
1769 </para></listitem></varlistentry>
1771 <varlistentry><term><guibutton>No</guibutton></term><listitem><para>
1772 answers no to the question displayed in the log area.
1773 </para></listitem></varlistentry>
1775 <varlistentry><term><guibutton>Cancel</guibutton></term><listitem><para>
1776 kills the current operation (if any) and closes the action
1778 </para></listitem></varlistentry>
1780 <varlistentry><term><guibutton>Quiet</guibutton></term><listitem><para>
1781 is a quick way to turn <guilabel>Quiet</guilabel> on and click
1782 <guibutton>Yes</guibutton>.
1783 </para></listitem></varlistentry>
1788 You can control which actions get started automatically (without you
1789 having to click on <guibutton>Quiet</guibutton> at the start) from the
1794 <title>Action window options</title>
1797 Some actions have options, which appear as option boxes at the bottom
1798 of the window. They are:
1803 <guilabel>Force</guilabel> means that the filer won't treat non-writeable
1804 files as special. Normally, it confirms the deletion even if
1805 <guibutton>Quiet</guibutton> is pressed.
1806 Note that you still can't remove files from non-writeable directories because
1807 in that case you really don't have permission.
1811 <guilabel>Brief</guilabel> prevents the filer logging a message every time it
1812 does something. Use this to speed things up if large numbers of messages are
1817 <guilabel>Recurse</guilabel> means that doing something to a directory will
1818 also do the same thing to all its contents, and the contents of any
1819 subdirectories, and so on.
1823 <guilabel>Newer</guilabel> will automatically copy a file over an existing one
1824 if the file is newer than the one it replaces (later modification time).
1830 You can set the defaults for these options from the Options box.
1835 <chapter id="searching">
1836 <title><anchor id="Searching" xreflabel="Searching"/>Searching</title>
1838 The Find feature looks through all the selected files and directories
1839 and any subdirectories (recursively) looking for items that match
1840 a particular expression.
1842 Choose <guimenuitem>Find</guimenuitem> from the <guimenu>File</guimenu>
1843 submenu to search all the selected objects. If you want to select all the
1844 files within a single directory which meet certain criteria, use
1845 <guimenuitem>Select</guimenuitem> -> <guimenuitem>Select If...</guimenuitem>
1848 If you know the name of a file then just enter it in the `Expression:'
1849 box, enclosed in single quotes. For example, to find a file called
1850 <filename>log</filename> you would enter <userinput>'log'</userinput>.
1852 Remember to use normal quotes, not double quotes (") or back-quotes (`).
1854 As the filer finds matching files they are added to the results list.
1855 Double-clicking on an entry in the list opens a viewer showing that file.
1856 The filer will use the same window to view other results (so, if you want
1857 the results shown in separate windows you must explicitly create a new
1858 window from the <guimenu>Window</guimenu> menu).
1862 <title>Wildcards</title>
1865 You can also put shell-style wildcard characters inside the quotes,
1870 <member><command>'*.html'</command></member>
1871 <member><command>'Report.*'</command></member>
1872 <member><command>'Draft[1-5]'</command></member>
1873 <member><command>'main.[ch]'</command></member>
1878 <citerefentry><refentrytitle>glob</refentrytitle>
1879 <manvolnum>7</manvolnum></citerefentry>
1880 manpage if you want to know more about shell wildcards.
1882 If the pattern you enter contains a slash (`/') character then the
1883 pattern is matched against the file's full path, otherwise only the
1884 leafname is used. That is, <userinput>'*tmp*'</userinput> will find
1885 <filename>tmp</filename> and <filename>tmpfile</filename> but not
1886 <filename>/tmp/file</filename> — <userinput>'/*tmp*'</userinput> will find
1892 <title>Simple tests</title>
1894 As well as finding files by their names you can also find them by
1895 various other attributes. Note that <emphasis>file</emphasis> is used here to
1896 mean anything that can appear in the filesystem — including directories,
1899 You can also use a short form for each test; these are shown in brackets.
1900 You can combine multiple tests — `<userinput>-rw</userinput>' is
1901 the same as `<userinput>IsReadable and IsWriteable</userinput>'.
1904 <itemizedlist><title>These look at the type of the item being checked:</title>
1907 <userinput>IsReg (-f)</userinput> matches any regular (ie, normal) file.
1911 <userinput>IsLink (-l)</userinput> matches symlinks.
1915 <userinput>IsDir (-d)</userinput> matches directories.
1919 <userinput>IsChar (-c)</userinput> matches character device files.
1923 <userinput>IsBlock (-b)</userinput> matches block device files.
1927 <userinput>IsDev (-D)</userinput> matches block or character device files.
1931 <userinput>IsPipe (-p)</userinput> matches pipes.
1935 <userinput>IsSocket (-S)</userinput> matches sockets.
1940 <itemizedlist><title>These look at the permissions set on the file —
1941 see the <xref linkend="Permissions"/> section.</title>
1944 <userinput>IsSUID (-u)</userinput> matches files which have the Set-UID
1945 bit set.</para></listitem>
1948 <userinput>IsSGID (-g)</userinput> matches files which have the Set-GID
1949 bit set.</para></listitem>
1952 <userinput>IsSticky (-k)</userinput> matches files with the sticky bit
1953 set.</para></listitem>
1956 <userinput>IsReadable (-r)</userinput> matches files which you can read
1957 from.</para></listitem>
1960 <userinput>IsWriteable (-w)</userinput> matches files which you can write to.
1964 <userinput>IsExecutable (-x)</userinput> matches files which you can execute.
1969 <itemizedlist><title>And a couple of other useful ones:</title>
1972 <userinput>IsEmpty (-z)</userinput> finds empty files (ie, those whose
1977 <userinput>IsMine (-o)</userinput> finds files which you own.
1985 <title>Logic operators</title>
1987 You can combine the above tests in various ways to perform more advanced
1989 An expression is actually made up of a list of <emphasis>cases</emphasis>,
1990 separated by commas. The filer will try to match each case in turn
1991 until one matches or there are no more cases left. For example, to
1992 search for files with several possible endings:
1994 <screen>'*.gif', '*.htm', '*.html'</screen>
1996 Further, each of the cases is actually a list of conditions. The case
1997 only matches if all of its conditions are met. So, to find a directory
1998 called <filename>lib</filename> or a regular file ending in
1999 <filename>.so</filename>:
2001 <screen>IsDir 'lib', IsReg '*.so'</screen>
2003 You can negate a condition by putting a <userinput>!</userinput> in front
2004 of it and you can use a sub-expression as a condition by bracketing it,
2012 Not isdir and not isreg
2015 All four do the same thing.
2020 <title>Comparisons</title>
2022 You can also compare various values using the operators
2023 <userinput><</userinput>,
2024 <userinput><=</userinput>,
2025 <userinput>=</userinput>,
2026 <userinput>!=</userinput>,
2027 <userinput>></userinput>, and
2028 <userinput>>=</userinput>
2029 (for less-than, less-than-or-equal-to, equal-to,
2030 not-equal-to, greater-than and greater-than-or-equal-to).
2032 When comparing times, you may find it helpful to use
2033 <userinput>after</userinput> and <userinput>before</userinput> instead of
2034 <userinput>></userinput> and <userinput><</userinput> to make things
2038 <itemizedlist><title>
2039 The following are read from the file being checked and may be used
2040 for the values being compared:
2044 <userinput>atime</userinput> The time that the file was last accessed.
2048 <userinput>ctime</userinput> The time that the file's status was last changed.
2052 <userinput>mtime</userinput> The time that the file's contents were last modified.
2056 <userinput>size</userinput> The size of the file.
2060 <userinput>inode</userinput> The file's inode (index) number.
2064 <userinput>nlinks</userinput> The number of links to this file. That is,
2065 the number of directory entries which refer to this file. Note that
2066 symlinks don't count as references.
2070 <userinput>uid</userinput> The User ID of the file.
2074 <userinput>gid</userinput> The Group ID of the file.
2078 <userinput>blocks</userinput> The number of disk blocks being used by the file.
2084 Times are measured as seconds since the Unix Epoch (00:00:00 UTC,
2085 January 1, 1970). Sizes are in bytes. When specifying constants to
2086 compare these values with you may use various keywords to scale the
2092 <userinput>Byte(s)</userinput> has no effect, but looks better.
2096 <userinput>Kb</userinput> multiplies by 1024, so 2Kb is the same as 2048.
2100 <userinput>Mb</userinput> multiplies by 1024<superscript>2</superscript>,
2105 <userinput>Sec(s)</userinput> has no effect, but looks nice.
2109 <userinput>Min(s)</userinput> multiplies by 60 to get minutes.
2113 <userinput>Hour(s), Day(s), Week(s), Year(s)</userinput> likewise
2114 convert to the relevant unit.
2118 <userinput>Ago</userinput> makes the time in the past relative to when
2123 <userinput>Hence</userinput> makes the time in the future.
2127 <userinput>Now</userinput> is short for <userinput>0 Secs Hence</userinput>.
2132 Some examples should make this all a bit clearer!
2135 mtime after 1 day ago
2139 IsReg and nlinks > 1</screen>
2140 The first finds files modified within the last 24 hours. You could
2141 use <userinput>></userinput> instead of <userinput>after</userinput>,
2142 but it's not so clear what is meant.
2144 The second finds files larger than 10 Mb. The last finds regular files with
2145 more than one directory entry.
2147 Be careful though — the filer doesn't check the context of the
2148 modifiers, so <userinput>size > 1 day ago</userinput> is allowed,
2149 although it doesn't make much sense!
2151 Also, forgetting to use <userinput>ago</userinput> or
2152 <userinput>hence</userinput> will cause odd effects (the time will be
2153 measured relative to the Epoch rather than the current time).
2154 Finally, don't use <userinput>=</userinput> with times —
2155 <userinput>atime = 1 day ago</userinput> looks for a file accessed
2156 <emphasis>exactly</emphasis> 86400 seconds ago...
2162 <title>Specials</title>
2168 <userinput>System(Command)</userinput> executes `Command' on the file.
2169 The test succeeds if the command returns an exit status of zero. A `%'
2170 character in `Command' is replaced by the full path of the file being
2171 checked. <userinput>System</userinput> is a very slow test to perform,
2172 so do it last if possible. For example, if you're looking for a
2173 <filename>.c</filename> file containing the word `main', do:
2175 <screen>'*.c' system(grep -q main "%")</screen>
2176 so that the grep is only performed for files ending in <filename>.c</filename>
2177 (as opposed to only checking that the file ends in <filename>.c</filename> if
2178 it contains the word `main').
2182 <userinput>Prune</userinput> Always fails!
2183 <footnote><para>Note that this is the opposite of the
2184 <citerefentry><refentrytitle>find</refentrytitle><manvolnum>1</manvolnum>
2185 </citerefentry> command.</para></footnote>
2187 However, if it gets evaluated at all then it prevents the filer
2188 from checking inside the current directory. Remember the order in which
2189 the filer checks the expression!
2197 '*.old' system(rm '%')
2199 'src' prune, '*.c'</screen>
2200 The first deletes each file ending in <filename>.old</filename>.
2201 The second looks for <filename>.c</filename> files, but does not bother
2202 checking inside directories called <filename>src</filename>.
2203 The expression is evaluated like this:
2205 If file is named <filename>src</filename> then `Prune'.
2206 Either way, check if it ends in <filename>.c</filename> and include
2207 it in the results if so.
2212 <chapter id="options">
2213 <title>Options</title>
2216 You can configure various aspects of <application>ROX-Filer</application>
2217 from the Options box.
2218 Choose <guimenuitem>Options...</guimenuitem> from a filer window menu to
2219 open it. The list on the left of the window lists the various sections —
2220 click on one to see its options.
2222 At the bottom of the window are two buttons:
2227 <guibutton>OK</guibutton>
2228 saves the current choices into your Choices directory for next time
2229 <application>ROX-Filer</application> is loaded, if anything changed.
2230 Exactly where choices are loaded from and saved to is controlled by the
2231 <envar>CHOICESPATH</envar> environment variable — see
2232 <citation>Choices</citation> for details.
2233 Changes made in the Options box take effect instantly, so you don't need to
2234 click on <guibutton>OK</guibutton> just to try them out.
2238 <guibutton>Revert</guibutton>
2239 Restores all choices to how they were when the options box was opened.
2240 This button is shown shaded if you haven't made any changes.
2241 The Options window is not closed when this is used.
2246 The options in the Options window have tooltips explaining the use of each
2247 option — hold the mouse pointer over an option to find out what it
2253 <chapter id="types">
2254 <title>Filetypes</title>
2257 All files have a MIME type in the form <emphasis>text/plain</emphasis>. Here,
2258 <emphasis>text</emphasis> is the <emphasis>media type</emphasis> and
2259 <emphasis>plain</emphasis> is the <emphasis>sub-type</emphasis>.
2261 <application>ROX-Filer</application> uses a file's name to decide what its MIME
2262 type is, and then uses the MIME type to decide what icon to give it and what
2263 program to use when you open the file.
2267 <title><anchor id="RunAction" xreflabel="the Set Run Action box"/>
2268 The Set Run Action box
2271 This box appears when you choose <guimenuitem>Set Run Action...</guimenuitem>
2272 from the File menu, and is used to set which application is loaded when you click
2275 For example, let's say you want to set things up so that opening a
2276 <filename>.gif</filename> file loads it into the Gimp.
2277 First, right-click over a gif image to open the menu and choose
2278 <guimenuitem>Set Run Action...</guimenuitem> from the
2279 <guimenuitem>File</guimenuitem> submenu.
2280 Then, you have a choice of two methods to set the run action:
2283 <sect2><title>Setting the run action by drag-and-drop</title>
2285 Drag the Gimp (from a filer window, a panel or the pinboard) onto
2286 the area marked <guilabel>Drop a suitable application here</guilabel>.
2287 From now on, clicking on a GIF file will load it into the Gimp.
2291 <sect2><title>Setting the run action by entering a shell command</title>
2293 Type: <userinput>gimp "$@"</userinput>
2294 into the box labelled <guilabel>Enter a shell command</guilabel> and press
2295 <keycap>Return</keycap>. <userinput>$@</userinput>
2296 will be replaced by the name of the file you click on when this command
2297 is used. As before, clicking on any GIF image will now load it into
2302 <sect2><title>Setting the default media-type handlers</title>
2304 Whichever method you use to set the action you have the choice of
2305 setting the run action just for that type, or setting the default
2306 for all files with that media-type which don't already have a specific
2309 Since the Gimp can load many types of image, it makes sense
2310 to select the <guilabel>Set default for all `image/<anything>'</guilabel>
2311 option so you don't have to do it again for image/jpeg files and so on. However,
2312 this only affects types that don't already have a specific action
2313 (ie, those that would have brought up an error box if you tried to
2320 <title><anchor id="SetIcon" xreflabel="the Set Icon box"/>
2325 This box appears when you choose <guimenuitem>Set Icon...</guimenuitem>
2326 from the File menu, and is used to set which image to use to represent
2329 It works much like the Set Run Action box described above, except that
2330 you may specifiy an icon for one file individually (by name) as well as
2331 for all files of a particular type. When setting the icon for a single
2332 file, the filer stores the name of the file and the name of the icon inside
2333 your Choices directory. If either moves, the icon won't be displayed.
2335 When setting the icon for a directory, you have the additional option of
2336 storing the image inside the directory itself as a hidden file. This means
2337 that other users will see the icon too, and you can safely delete the original
2338 image after the copy (note that the image is scaled down if needed, and converted
2341 The directory icon inside the <guilabel>Drop an icon here</guilabel>
2342 area allows you to quickly get to a directory from which you are already
2343 using one or more icons.
2348 <title>How filetypes are stored</title>
2351 <application>ROX-Filer</application> uses two sub-directories in your Choices
2352 directory for filetypes:
2356 <varlistentry><term><filename>MIME-types</filename></term><listitem><para>
2357 contains symlinks, one for each MIME type, which point
2358 to programs that can handle files of that type. To set what program
2359 is run when you click on the file you should normally use the <guimenuitem>Set
2360 Run Action...</guimenuitem> feature (see the <xref linkend="RunAction"/> section).
2361 However, you can also set the actions manually — for example, to make
2362 opening an HTML file load it into Netscape:
2366 Find the Netscape application and go to <guimenuitem>Link...</guimenuitem>
2371 Enter <userinput>text_html</userinput> as the name for the link and drag the
2372 icon from the Link box into the <filename>MIME-types</filename> directory.
2377 You can also put actual programs in here as well as links if you want
2379 </para></listitem></varlistentry>
2381 <varlistentry><term><filename>MIME-icons</filename></term><listitem><para>
2382 contains the images used to display each type of file.
2383 So the filer will try to display an HTML file using the icon
2384 <filename>MIME-icons/text_html.png</filename>.
2385 </para></listitem></varlistentry>
2389 In both <filename>MIME-types</filename> and <filename>MIME-icons</filename>
2390 directories you can also provide default actions/images for each media type.
2391 For example, if <filename>text_html</filename> isn't found then the filer
2392 will try simply using <filename>text</filename>.
2396 The filer works out the type for a file from its name. The rules come from
2397 various <filename>globs</filename> files — see
2398 <citation>SharedMIME</citation> for details.</para>
2402 <chapter id="appdirs">
2403 <title><anchor id="AppDir" xreflabel="Application directories"/>
2404 Application directories
2407 An application directory is a directory which can be run as an application.
2408 It contains all the resources of an application — source code, binaries,
2409 documentation and so on. Keeping everything in one place make installation
2410 and uninstallation much easier for users. You can also keep multiple
2411 versions of a program by simply having several application directories.
2412 You may move and rename them as you please. Application directories
2413 make programs easier to use and install.
2415 They're more secure too, because you can compile an application as a user and
2416 then simply copy it as root. Since you don't have to run an install script
2417 you are free from the danger of running untrusted code as root. All you have
2418 to watch out for is setuid binaries.
2421 The following files are treated as special by
2422 <application>ROX-Filer</application>:
2427 <filename>AppRun</filename>
2428 is executed when you click on the directory — make sure
2429 it is executable (use the Permissions box)!
2433 <filename>.DirIcon</filename>
2434 is the image used to represent the directory (this works even if
2435 there is no <filename>AppRun</filename>).
2439 <filename>Help</filename>
2440 is the directory to be opened when you choose <guimenuitem>Help</guimenuitem>
2445 <filename>AppInfo.xml</filename>
2446 contains extra information about an application (see below).
2450 <filename>AppIcon.xpm</filename>
2451 is used if <filename>.DirIcon</filename> is missing (for backwards
2452 compatibility; not to be used anymore).
2457 Have a look at the <filename>ROX-Filer</filename> application directory for a
2462 <note><para>For security reasons, an application directory must have the
2463 same owner as the <filename>AppRun</filename> file inside.</para></note>
2466 <title>The AppInfo file</title>
2469 <filename>AppInfo.xml</filename> is an XML file with the following structure
2470 (any elements may be omitted, and the file itself is optional):
2473 <?xml version="1.0"?>
2475 <Summary xml:lang="en">A graphical file manager</Summary>
2476 <Summary xml:lang="de">Ein grafische Datei-Manager</Summary>
2477 <Summary xml:lang="nl">Een grafisch bestandsbeheerprogramma</Summary>
2478 <Summary xml:lang="es">Un manejador de archivos gráafico</Summary>
2479 <About xml:lang="en">
2480 <Purpose>File manager</Purpose>
2481 <Version>1.3.5 PREVIEW</Version>
2482 <Authors>Thomas Leonard and others</Authors>
2483 <License>GNU General Public License</License>
2484 <Homepage>http://rox.sourceforge.net</Homepage>
2486 <About xml:lang="es">
2487 <Purpose>Manejador de Archivos</Purpose>
2488 <Authors>Thomas Leonard y otros</Authors>
2491 <Item option="-p=Default">
2492 <Label>Enable pinboard</Label>
2493 <Label xml:lang="es">Habilitar el pinboard</Label>
2495 <Item option="-p=">
2496 <Label>Disable pinboard</Label>
2497 <Label xml:lang="es">Deshabilitar el pinboard</Label>
2506 <userinput>Summary</userinput>
2507 is displayed in a tooltip when the mouse is held over the application.
2511 <userinput>About</userinput>
2512 contains a list of fields which are shown in the `File Info'
2513 box for the application (any element names may be used, but the above
2518 <userinput>AppMenu</userinput>
2519 is a list of extra menu items to display for the application.
2520 When one is chosen, <filename>AppRun</filename> is called with
2521 <userinput>option</userinput> as its only argument. You can nest
2522 AppMenus inside other AppMenus to create submenus, provided they have
2523 <Label> elements.
2533 <title>Internationalisation</title>
2539 <title><anchor id="LANG" xreflabel="Translations"/>
2540 Selecting a translation
2544 <application>ROX-Filer</application> is able to translate many of its messages,
2545 provided suitable translation files are provided:
2548 <listitem><para>Open the Options box from the menu,</para></listitem>
2549 <listitem><para>Select a language from the menu at the top,</para></listitem>
2550 <listitem><para>Click on <guibutton>Save</guibutton> and restart the filer
2551 for the new setting to take full effect.</para></listitem>
2558 <title>Creating a new translation</title>
2562 <listitem><para>Go into the <filename>src</filename> directory and create
2563 the file <filename>messages.pot</filename>:
2567 $ make messages.pot</screen>
2571 <listitem><para>Copy the file into the <filename>po</filename>
2572 subdirectory under <filename>src</filename> as
2573 <filename><name>.po</filename>. Eg, if your
2574 language is referred to as `ml' (`my language'):
2576 <screen>$ cp messages.pot po/ml.po</screen>
2579 <listitem><para>Load the copy into a text editor.</para></listitem>
2581 <listitem><para>Fill in the translations, which are all blank to start with.
2584 <listitem><para>Run the <filename>make-mo</filename> script to create the
2585 binary file which <application>ROX-Filer</application> can use.
2586 You will need the GNU gettext package for this.
2587 If you don't have it then just send me the <filename>.po</filename> file
2588 and I'll convert it for you.
2591 $ cd ROX-Filer/src/po
2593 Created file ../../Messages/ml.gmo OK</screen>
2596 <listitem><para>Edit <filename>ROX-Filer/Options.xml</filename> so that
2597 your language is listed, restart the filer and select it from the Options box
2598 (see the <xref linkend="LANG"/> section).
2601 <listitem><para>Submit the <filename>.po</filename> file to me so that I
2602 can include it in future releases of the filer.
2610 <title>Updating an existing translation</title>
2614 <listitem><para>Go into the directory containing the <filename>.po</filename>
2615 files and run the <filename>update-po</filename> script.
2616 This checks the source code for new and changed strings and updates all
2617 the translation files.
2620 $ cd ROX-Filer/src/po
2621 $ ./update-po</screen>
2624 <listitem><para>Edit the file by hand as before, filling in the new blanks
2625 and updating out-of-date translations.
2626 Look out for <computeroutput>fuzzy</computeroutput> entries where
2627 <command>update-po</command> has made a guess; check it's correct and
2628 remove the <computeroutput>fuzzy</computeroutput> line.
2631 <listitem><para>Run <command>make-mo</command> as before.</para></listitem>
2633 <listitem><para>Submit the updated file to me.</para></listitem>
2637 See the <command>gettext</command> info page for more instructions on creating
2644 <chapter id="hacking">
2645 <title>Hacking</title>
2647 This is a quick start guide for people who want to modify the source
2648 code. If you make useful changes or fix bugs, please send patches
2649 to me or to the mailing list. Tell me which version you're using!
2653 <title>Compiling</title>
2655 The first time you compile the program you need to do <command>AppRun
2656 --compile</command>, but in future you only need to run <command>make</command>
2657 in the <filename>src</filename> directory when you change the
2658 <filename>.c</filename> and <filename>.h</filename> files.
2659 You might want to run <command>make depend</command> too.
2664 <title>Creating and applying patches</title>
2666 When people make small modifications to the sources they will often
2667 distribute them as <emphasis>patch files</emphasis> — usually on the
2670 To apply a patch, go into the <filename>src</filename> directory and run
2671 <command>patch</command> with the patch file. Then recompile, like this:
2675 $ patch < patchfile
2676 $ ../AppRun --compile</screen>
2678 You can remove the patch by simply repeating the above sequence —
2679 <command>patch</command> will detect that the patch is already applied
2680 and offer to remove it.
2682 To create a patch you should first get the latest version of the filer
2683 from CVS (instructions on using CVS can be found on the web-site).
2684 Modify the program as you please. Create the patch using
2685 <command>cvs diff</command> from the appropriate directory:
2687 <screen>$ cvs diff -u > my_patch</screen>
2689 This creates a human– and machine-readable patch file. Submit this
2690 to the mailing list. The are many reasons for posting patches rather
2691 that the modified files:
2694 <listitem><para>They are smaller, and hence shouldn't bounce.
2695 They are also quicker to download for people with slow connections.
2698 <listitem><para>People can see what they're getting into before applying them!
2701 <listitem><para>Patches can (usually) be applied to slightly modified
2702 versions of the sources. This means that people can apply several patches
2703 without each new one overwriting the others.
2712 <title>Autoconf</title>
2714 Here's a quick explanation of the autoconf system in case you haven't
2715 used it before. See <command>info autoconf</command> for full details.
2717 There's a file called <filename>configure.in</filename> which contains
2718 various tests (<command>info autoconf</command>).
2719 You run <command>autoconf</command> and it reads through the file
2720 and generates a shell script to perform the tests, saving it as
2721 <filename>configure</filename>.
2722 <filename>configure</filename> is normally distributed with the program because
2723 not everyone has autoconf.
2725 You then run <filename>configure</filename> (in fact, let the
2726 <filename>AppRun</filename> script do it because
2727 it passes it some arguments), which performs all the tests. It reads
2728 in <filename>Makefile.in</filename> and <filename>config.h.in</filename>
2729 and fills in the missing values with the test results to produce
2730 <filename>Makefile</filename> and <filename>config.h</filename>.
2732 You run <command>make</command>, which creates <filename>.o</filename>
2733 files from the <filename>.c</filename> files and links to produce
2734 <filename>ROX-Filer</filename>.
2738 <sect1><title>Data-structures</title>
2740 The <filename>global.h</filename> file lists each major data-structure used
2741 in the filer and explains its purpose. This is a good place to start reading
2742 if you want to know how the filer works.
2747 <appendix id="compiling">
2748 <title>Compiling</title>
2751 If you've just got hold of the filer by downloading the source archive
2752 then you'll need to compile it before you can use it. If you downloaded
2753 and installed a binary package, or if <application>ROX-Filer</application>
2754 was included with your system, then you can skip this section. If you got
2755 here by clicking on the lifebelt symbol in a filer window, or if typing
2756 <command>rox</command> at a shell prompt works, then you don't need to
2759 <itemizedlist><title>To compile, you will need the following:</title>
2762 Unix or Linux (root access is not required),
2766 The X Window system (supplied as standard on all modern systems),
2770 GTK+ 2.0.1 or later (libraries and headers) — get the latest version
2771 from <citation>GTK+</citation>,
2775 LibXML 2.0.0 or later (libraries and headers) — get the latest
2776 version from <citation>libxml</citation>,
2780 A C compiler, such as `gcc' (standard on most systems).
2785 All of the above are standard on most modern Linux distributions.
2786 To check which version of GTK+ you have installed, run the
2787 <command>pkg-config</command> command, like this
2788 (<prompt>$</prompt> is the shell prompt):
2790 <screen>$ pkg-config --modversion gtk+-2.0
2794 <procedure><title>To compile:</title>
2797 The filer now uses the Shared MIME Database<citation>SharedMIME</citation>
2798 to work out the types of files. You need to install this before the
2799 filer will work properly (ROX-Filer will warn you if it's not installed
2804 Change to the directory containing the ROX-Filer subdirectory.
2808 Run the <command>install.sh</command> script, like this:
2810 <screen>$ ./install.sh</screen>
2815 <application>ROX-Filer</application> will perform various checks to find
2816 out what kind of system it is being run on and will then compile. If it
2817 doesn't work then please e-mail me and complain! Tell me what kind of
2818 system you have and what errors were reported. If you manage to fix the
2819 problem yourself then please e-mail me the fix.
2821 The executable file is stored inside the ROX-Filer directory in a
2822 different subdirectory for each platform. Therefore, you can compile
2823 the same application on several different types of machine and then
2824 run it from any of them using the <filename>AppRun</filename> script.
2825 This is particularly useful in a network environment.
2829 Once the filer has compiled you will be asked where you want to install
2830 it. If you want to do a system-wide installation as root, you may
2831 want to stop here, <command>su</command> to root and rerun the install
2834 If you don't have the root password then don't worry — just follow
2835 the instructions for installing into your home directory.
2840 You can now run the filer by running the <command>rox</command> script
2841 without any options, like this:
2843 <screen>$ rox</screen>
2845 A window should appear and display the contents of the current directory.
2847 If you installed the script into your home directory then you may
2848 need to set your <envar>PATH</envar> environment variable so that the shell can
2849 find it. For example, if you installed it into a directory called
2850 <filename>bin</filename> in your home directory, use this:
2852 <screen>$ PATH=$HOME/bin:$PATH; export PATH</screen>
2854 or (if you are using the <citerefentry><refentrytitle>csh</refentrytitle>
2855 <manvolnum>1</manvolnum></citerefentry> shell):
2857 <screen>$ setenv PATH $HOME/bin:$PATH
2864 <appendix id="manpage"><title>Manual page</title>
2869 <refentrytitle>ROX</refentrytitle>
2870 <manvolnum>1</manvolnum>
2874 <refname>ROX-Filer</refname>
2875 <refpurpose>a simple graphical file manager</refpurpose>
2880 <command>rox</command>
2881 <arg choice="opt" rep="repeat"><option>OPTION</option></arg>
2882 <arg choice="opt" rep="repeat">FILE</arg>
2886 <refsect1><title>DESCRIPTION</title>
2888 ROX-Filer is a simple and easy to use graphical file manager for X11, the
2889 windowing system used on Unix and Unix-like operating systems.
2891 It is also the core component of the ROX Desktop:
2892 <ulink url="http://rox.sourceforge.net"/>
2894 Invoking <command>rox</command> opens each directory or file listed,
2895 or the current working directory if no arguments are given.
2899 <refsect1><title>COMMAND-LINE OPTIONS</title>
2903 <varlistentry><term><option>-b</option></term><term><option>--bottom=PANEL</option></term>
2904 <listitem><para>open PANEL as a bottom-edge panel.
2905 </para></listitem></varlistentry>
2907 <varlistentry><term><option>-c</option></term><term><option>--client-id=ID</option></term>
2908 <listitem><para>used for session management.
2909 </para></listitem></varlistentry>
2911 <varlistentry><term><option>-d</option></term><term><option>--dir=DIR</option></term>
2912 <listitem><para>open DIR as directory (not as an application, even if it looks like one).
2913 </para></listitem></varlistentry>
2915 <varlistentry><term><option>-D</option></term><term><option>--close=DIR</option></term>
2916 <listitem><para>close DIR and all its subdirectories.
2917 </para></listitem></varlistentry>
2919 <varlistentry><term><option>-h</option></term><term><option>--help</option></term>
2920 <listitem><para>display help about the various options.
2921 </para></listitem></varlistentry>
2923 <varlistentry><term><option>-l</option></term><term><option>--left=PANEL</option></term>
2924 <listitem><para>open PANEL as a left-edge panel.
2925 </para></listitem></varlistentry>
2927 <varlistentry><term><option>-m</option></term><term><option>--mime-type=FILE</option></term>
2928 <listitem><para>print MIME type of FILE and exit.
2929 </para></listitem></varlistentry>
2931 <varlistentry><term><option>-n</option></term><term><option>--new</option></term>
2932 <listitem><para>start a new filer, even if one already seems to be
2933 running. This also prevents the filer from forking (running in the
2934 background). This option is mainly useful for debugging.
2935 </para></listitem></varlistentry>
2937 <varlistentry><term><option>-p</option></term><term><option>--pinboard=PIN</option></term>
2938 <listitem><para>use pinboard PIN as the pinboard.
2939 </para></listitem></varlistentry>
2941 <varlistentry><term><option>-r</option></term><term><option>--right=PANEL</option></term>
2942 <listitem><para>open PANEL as a right-edge panel.
2943 </para></listitem></varlistentry>
2945 <varlistentry><term><option>-R</option></term><term><option>--RPC</option></term>
2946 <listitem><para>read and invoke SOAP RPC from standard input (see <xref linkend="soap"/>).
2947 </para></listitem></varlistentry>
2949 <varlistentry><term><option>-s</option></term><term><option>--show=FILE</option></term>
2950 <listitem><para>open a directory showing FILE.
2951 </para></listitem></varlistentry>
2953 <varlistentry><term><option>-t</option></term><term><option>--top=PANEL</option></term>
2954 <listitem><para>open PANEL as a top-edge panel.
2955 </para></listitem></varlistentry>
2957 <varlistentry><term><option>-u</option></term><term><option>--user</option></term>
2958 <listitem><para>show user name in each window.
2959 </para></listitem></varlistentry>
2961 <varlistentry><term><option>-v</option></term><term><option>--version</option></term>
2962 <listitem><para>display the version information and exit.
2963 </para></listitem></varlistentry>
2965 <varlistentry><term><option>-x</option></term><term><option>--examine=FILE</option></term>
2966 <listitem><para>FILE has changed; re-examine it.
2967 </para></listitem></varlistentry>
2973 <refsect1><title>NOTES</title>
2975 The main documentation for ROX-Filer is available by choosing
2976 <guimenuitem>Show Help Files</guimenuitem> from the
2977 popup menu, or by clicking on the right-most toolbar icon.
2981 <refsect1><title>LICENSE</title>
2982 <para>Copyright (C) 2003 Thomas Leonard.
2984 You may redistribute copies of ROX-Filer under the terms of the GNU General
2989 <refsect1><title>BUGS</title>
2991 Please report bugs to the developer mailing list: <ulink url="http://rox.sourceforge.net/contact.html"/>.
2995 <refsect1><title>AUTHORS</title>
2997 ROX-Filer was created by Thomas Leonard, with help from:
2999 <simplelist columns='3'>
3000 <member>Michael Adams</member>
3001 <member>Christopher Arndt</member>
3002 <member>Jens Askengren</member>
3003 <member>Liav Asseraf</member>
3004 <member>Wilbert Berendsen</member>
3005 <member>Francesco Bochicchio</member>
3006 <member>Yuri Bongiorno</member>
3007 <member>Andrzej Borsuk</member>
3008 <member>Richard Boulton</member>
3009 <member>Simon Britnell</member>
3010 <member>Arnaud Calvo</member>
3011 <member>Babyfai Cheung</member>
3012 <member>Andrew Clover</member>
3013 <member>Fabien Coutant</member>
3014 <member>Couderc Damien</member>
3015 <member>Andreas Dehmel</member>
3016 <member>Micah Dowty</member>
3017 <member>Dmitry Elfimov</member>
3018 <member>Mattias Engdegard</member>
3019 <member>Andrew Flegg</member>
3020 <member>Olivier Fourdan</member>
3021 <member>Eric Gillespie</member>
3022 <member>Thierry Godefroy</member>
3023 <member>Olli Helenius</member>
3024 <member>Alex Holden</member>
3025 <member>Jasper Huijsmans</member>
3026 <member>Sigve Indregard</member>
3027 <member>Bernard Jungen</member>
3028 <member>Marcin Juszkiewicz</member>
3029 <member>James Kermode</member>
3030 <member>Jim Knoble</member>
3031 <member>Krzysztof Krzyzaniak</member>
3032 <member>Aaron Kurtz</member>
3033 <member>Vincent Ledda</member>
3034 <member>Vincent Lefevre</member>
3035 <member>Victor Liu See-le</member>
3036 <member>Alexey Lubimov</member>
3037 <member>Krzysztof Luks</member>
3038 <member>Marcus Lundblad</member>
3039 <member>Anders Lundmark</member>
3040 <member>Jose Romildo Malaquias</member>
3041 <member>Denis Manente</member>
3042 <member>Brendan McCarthy</member>
3043 <member>Andras Mohari</member>
3044 <member>Christiansen Merel</member>
3045 <member>Jimmy Olgeni</member>
3046 <member>Richard Olsson</member>
3047 <member>Matthew O'Phinney</member>
3048 <member>Daniele Peri</member>
3049 <member>Andy Piper</member>
3050 <member>Marcelo Ramos</member>
3051 <member>Michel Alexandre Salim</member>
3052 <member>Adam Sampson</member>
3053 <member>Chris Sawer</member>
3054 <member>Christian Storgaard</member>
3055 <member>Taras</member>
3056 <member>Simon Truss</member>
3057 <member>Hirosi Utumi</member>
3058 <member>Jan Wagemakers</member>
3059 <member>Keith Warno</member>
3060 <member>Götz Waschk</member>
3061 <member>Stephen Watson</member>
3062 <member>Andre Wyrwa</member>
3063 <member>Geoff Youngs</member>
3064 <member>Diego Zamboni</member>
3067 and many others; the <filename>Changes</filename> file contains more
3068 detailed information!
3075 <appendix id="soap"><title>SOAP RPC</title>
3077 <para>When the filer starts you can use command-line options to control its behaviour.
3078 As an alternative to this, the filer allows you to specify an operation with a
3079 <citation>SOAP</citation> RPC format message. In fact, if you use the command-line options,
3080 the filer converts to SOAP RPC internally.
3083 <para>All SOAP RPC messages are passed on standard input, like this:
3086 $ rox --RPC << EOF
3087 <?xml version="1.0"?>
3088 <env:Envelope xmlns:env="http://www.w3.org/2001/12/soap-envelope">
3089 <env:Body xmlns="http://rox.sourceforge.net/SOAP/ROX-Filer">
3091 <Name>Default</Name>
3092 <Side>Bottom</Side>
3095 </env:Envelope>
3098 The following methods are recognised:</para>
3102 <listitem><para><function>Version</function>()
3103 Returns the filer's version.
3106 <listitem><para><function>CloseDir</function>(<parameter>Filename</parameter>)
3107 Close directory <parameter>Filename</parameter> and all its subdirectories.
3110 <listitem><para><function>Examine</function>(<parameter>Filename</parameter>)
3111 <parameter>Filename</parameter> may have changed — check it and
3115 <listitem><para><function>OpenDir</function>(<parameter>Filename</parameter>,
3116 [<parameter>Style</parameter>, <parameter>Details</parameter>, <parameter>Sort</parameter>,
3117 <parameter>Class</parameter>, <parameter>ID</parameter>],
3118 <parameter>Hidden</parameter>, <parameter>Filter</parameter>)
3119 Open a window showing directory <parameter>Filename</parameter>.
3120 <parameter>Style</parameter> is one of <userinput>Large</userinput>, <userinput>Small</userinput>, <userinput>Huge</userinput>
3121 or <userinput>Automatic</userinput>.
3122 <parameter>Details</parameter> is one of <userinput>None</userinput>, <userinput>ListView</userinput>, <userinput>Size</userinput>, <userinput>Type</userinput>, <userinput>Times</userinput> or <userinput>Permissions</userinput>.
3123 <parameter>Sort</parameter> is one of <userinput>Name</userinput>, <userinput>Type</userinput>, <userinput>Date</userinput>, <userinput>Size</userinput>,
3124 <userinput>Owner</userinput> or <userinput>Group</userinput>.
3125 If any of these three option parameters are missing, the default is used.
3126 <parameter>Class</parameter> can be used to set the WM_CLASS property on the new window. You can
3127 use this to get your window manager to treat the window
3129 <parameter>ID</parameter> is a string used to identify the
3130 opened window. If a window with this ID already exists, it is changed to the
3131 given directory. Otherwise, a new window is created and given this ID.
3132 If used from a program, ensure the IDs you generate are unique, for example
3133 by including your process name, PID and a timestamp in the ID.
3134 <parameter>Hidden</parameter> if <userinput>true</userinput> means
3135 that hidden files (those that start with a dot character) are shown,
3136 or not shown if <userinput>false</userinput>. If ommitted then the
3137 configured setting is used.
3138 <parameter>Filter</parameter> can be used to filter files shown by
3139 their name. For example using a filter of <userinput>*.c</userinput>
3140 means that only files ending in .c are shown.
3143 <listitem><para><function>Panel</function>(<parameter>Side</parameter>,
3144 [<parameter>Name</parameter>])
3145 Open the panel named <parameter>Name</parameter> on screen side
3146 <parameter>Side</parameter> (<userinput>Top</userinput>|<userinput>Bottom</userinput>|<userinput>Left</userinput>|<userinput>Right</userinput>).
3147 <parameter>Name</parameter> can be a name in Choices (eg,
3148 <userinput>MyPanel</userinput>) or a full pathname.
3149 If not given, the panel on that side is turned off.
3152 <listitem><para><function>PanelAdd</function>(<parameter>Side</parameter>,
3153 <parameter>Path</parameter>, [<parameter>Label</parameter>,
3154 <parameter>After</parameter>])
3155 Add <parameter>Path</parameter> to the panel on side <parameter>Side</parameter>,
3156 with label <parameter>Label</parameter>. If <parameter>After</parameter> is
3157 <userinput>true</userinput> the icon goes on the right/bottom side of the panel,
3158 otherwise on the left/top side.
3161 <listitem><para><function>Pinboard</function>([<parameter>Name</parameter>])
3162 Display pinboard <parameter>Name</parameter> on the desktop background.
3163 <parameter>Name</parameter> can be a name in Choices (eg,
3164 <userinput>MyPinboard</userinput>) or a full pathname.
3165 If not given, the pinboard is turned off.
3168 <listitem><para><function>PinboardAdd</function>(<parameter>Path</parameter>,
3169 <parameter>X</parameter>, <parameter>Y</parameter>, [<parameter>Label</parameter>])
3170 Add <parameter>Path</parameter> to the pinboard at position
3171 (<parameter>X</parameter>, <parameter>Y</parameter>), giving it the label
3172 <parameter>Label</parameter>.
3175 <listitem><para><function>SetBackdropApp</function>(<parameter>App</parameter>)
3176 Make <parameter>App</parameter> (an application directory) the new handler
3177 for the current pinboard's backdrop.
3178 The <filename>AppInfo.xml</filename> file inside <parameter>App</parameter>
3179 must contain the CanSetBackdrop element, eg:
3181 <?xml version="1.0"?>
3183 <ROX:CanSetBackdrop xmlns:ROX="http://rox.sourceforge.net/SOAP/ROX-Filer"/>
3184 </AppInfo></programlisting>
3185 The application will be run with the <option>--backdrop</option> option
3186 as it's only argument after invoking this method, and whenever the pinboard is
3187 reloaded. DO NOT use this method if invoked with <option>--backdrop</option> or
3188 you will get stuck in an infinite loop!
3189 See <xref linkend="backdropapp"/> for a guide to writing backdrop applications.
3192 <listitem><para><function>SetBackdrop</function>(<parameter>Filename</parameter>,
3193 <parameter>Style</parameter>)
3194 Set the backdrop image to a given file. If you want to regenerate the image next
3195 time the user logs in, or you want to change it automatically from time to time,
3196 use <function>SetBackdropApp</function> above instead.
3199 <listitem><para><function>Run</function>(<parameter>Filename</parameter>)
3200 Run <parameter>Filename</parameter> as if it was clicked on in the filer.
3203 <listitem><para><function>Show</function>(<parameter>Directory</parameter>,
3204 <parameter>Leafname</parameter>)
3205 Open <parameter>Directory</parameter> and flash the file
3206 <parameter>Leafname</parameter> inside it.
3209 <listitem><para><function>FileType</function>(<parameter>Filename</parameter>)
3210 Returns the MIME-type of <parameter>Filename</parameter> (by writing the
3211 SOAP response to standard output).
3216 The following calls can be used to start new file actions.
3217 <parameter>Quiet</parameter> can be <userinput>true</userinput> if the
3218 operation should start immediately, instead of waiting for the user to
3219 confirm. If <userinput>false</userinput>, the user must always confirm. If
3220 not given, the default setting is used.
3224 <listitem><para><function>Copy</function>(<parameter>From</parameter>,
3225 <parameter>To</parameter>, [<parameter>Leafname</parameter>,
3226 <parameter>Quiet</parameter>])
3227 Copy each file in the array <parameter>From</parameter> to the directory
3228 <parameter>To</parameter>. If <parameter>Leafname</parameter> is given
3229 then <parameter>From</parameter> should contain a single entry only;
3230 <parameter>Leafname </parameter> gives the new leafname.
3233 <listitem><para><function>Move</function>(<parameter>From</parameter>,
3234 <parameter>To</parameter>, [<parameter>Leafname</parameter>,
3235 <parameter>Quiet</parameter>])
3236 Move each file in the array <parameter>From</parameter> to the directory
3237 <parameter>To</parameter>. If <parameter>Leafname</parameter> is given
3238 then <parameter>From</parameter> should contain a single entry only;
3239 <parameter>Leafname</parameter> gives the new leafname.
3242 <listitem><para><function>Link</function>(<parameter>From</parameter>,
3243 <parameter>To</parameter>, [<parameter>Leafname</parameter>])
3244 Symlink each file in the array <parameter>From</parameter> to the
3245 directory <parameter>To</parameter>. If <parameter>Leafname</parameter> is
3246 given then <parameter>From</parameter> should contain a single entry only;
3247 <parameter>Leafname</parameter> gives the new leafname.
3250 <listitem><para><function>Mount</function>(<parameter>MountPoints</parameter>,
3251 [<parameter>OpenDir</parameter>, <parameter>Quiet</parameter>])
3252 Mount each directory in the list <parameter>MountPoints</parameter>. If
3253 <userinput>true</userinput>, <parameter>OpenDir</parameter> causes each
3254 directory to be opened once it is mounted.
3262 <title>References</title>
3265 <abbrev>ROX</abbrev><citetitle>The ROX desktop,
3266 <ulink url="http://rox.sourceforge.net"/></citetitle>
3270 <abbrev>RISC OS</abbrev><citetitle>RISC OS,
3271 <ulink url="http://www.riscos.com"/></citetitle>
3275 <abbrev>GTK+</abbrev><citetitle>GTK+ Toolkit,
3276 <ulink url="http://www.gtk.org"/></citetitle>
3280 <abbrev>libxml</abbrev><citetitle>The XML C library for Gnome
3281 <ulink url="http://www.xmlsoft.org"/></citetitle>
3285 <abbrev>GNOME</abbrev><citetitle>The GNOME desktop,
3286 <ulink url="http://www.gnome.org"/></citetitle>
3290 <abbrev>DND</abbrev><citetitle>The Drag and Drop protocol,
3291 <ulink url="http://www.newplanetsoftware.com/xdnd/"/></citetitle>
3295 <abbrev>XDS</abbrev><citetitle>The X Direct Save protocol,
3296 <ulink url="http://www.newplanetsoftware.com/xds/"/></citetitle>
3300 <abbrev>Choices</abbrev><citetitle>The ROX Choices system,
3301 <ulink url="http://rox.sourceforge.net/choices.html"/></citetitle>
3305 <abbrev>AVFS</abbrev><citetitle>AVFS - A Virtual File System,
3306 <ulink url="http://sourceforge.net/projects/avf/"/></citetitle>
3310 <abbrev>SOAP</abbrev><citetitle>Simple Object Access Protocol (SOAP) 1.2
3311 <ulink url="http://www.w3.org/TR/SOAP/"/></citetitle>
3315 <abbrev>Thumbs</abbrev><citetitle>Thumbnail Managing Standard (Version 0.5)
3316 <ulink url="http://triq.net/~jens/thumbnail-spec/"/></citetitle>
3320 <abbrev>Wallpaper</abbrev><citetitle>Wallpaper backdrop control application
3321 <ulink url="http://rox.sf.net/wallpaper.html"/></citetitle>
3325 <abbrev>SharedMIME</abbrev><citetitle>Shared MIME-info Database (Version 0.8)
3326 <ulink url="http://www.freedesktop.org/standards/shared-mime-info-spec/"/></citetitle>