.TH XFM 5 "20 April, 2006" "xfm" XFM .\" Copyright (C) 2006, Bernhard R. Link .\" You may distribute under the terms of the GNU General Public .\" License as specified in the file COPYING that comes with xfm. .SH NAME xfm \- file format for application window contents of xfm .SH DESCRIPTION Xfm - the X file and application manager - has its own format to save the content of the application window, which is described in this file. .SH FORMAT One entry per line. Lines starting with a hash (#) and empty lines are ignored. Each line consists out of six fields, separated by colons (:). Backslashes and colons within those fields have to be escaped using backslashes. .SH FIELDS .SS Label The label printed below the icon in the application window is the first part. .SS Directory Directory The second part is the directory the specified action is executed in. An empty string is treated as the \fI$HOME\fP-directory, which is also substituted for a leading tilde followed by a slash (~/). If this line has the special drop_action \fBLOAD\fP, this is not the directory, but the next xfm file to display. .SS "empty compatibility field" This field is only here for compatibility reasons. It has to be empty. .SS "icon" The 4th field is the icon to show. Unless this field is empty, \fBxfm\fP will search in the \fBpixmapPath\fP and the \fBbitmapPath\fP for this file and use it as icon for this item. The icon has to be in \fBXBM\fP or in the \fBXPM\fP format. .SS "push action" This field (the 5th) contains the action to execute when the specified field is double-clicked or otherwise activated. Unless it is one of the special commands listed below, it is given as a whole to the shell. Any parts encapsulated in percent signs (%) are substituted with user input. Default values can be specified with two hyphens (\-\-) within the token. The special commands are: .IP \fBLOAD\fP The directory field is interpreted as filename of a xfm file which replaces the current contents of the application window. If the directory is the special value \fBXFM-DEVICES\fP, the content of the application window are generated out of the information of the \fBxfm_dev\fP(5) file instead. .IP \fBOPEN\fP The directory specified in the directory field is opened in a new file window. .IP "\fBEDIT\fP \fIfilename\fP" Start the default editor with the specified filename. .SS "drop action" This field (the 6th) contains the action to execute if some files are dragged from the file window and dropped into this item. The command is given to a shell, and the files are given as arguments. .SH EXAMPLES Start a xterm with \fI$HOME\fP-directory as current directory. The icon is xterm.xpm. Nothing can be dragged here. .br \fBXterm:::xterm.xpm:exec term:\fP .br Open the special menu for showing mountable devices: .br \fBDevices:XFM\-DEVICES:::LOAD:\fP .br Open a file window with the home directory: .br \fBHome::::OPEN:\fP .br Open \fB/floppy\fP in a new file window: .br \fBDiskettenlaufwerk:/floppy::dev_floppy.xpm:OPEN:\fP .br Execute an xterm with a user specified command: .br \fBexecute::::xterm \-e %command\-\-watch date%:\fP .br Grab a screenshot when pushed, show drag&dropped images with xli: .br \fBpicture::::import `date +\\%Y\\%m\\%d\\%M\\%H\\%S.png`:xli "$@"\fP .br Process dropped files with transfig: .br \fBtransfig:::app.xpm::transfig \-L %Language\\:\-\-eepic% "$@"\fP .SH FILES .TP .B \fI$HOME\fP/.xfm/Apps Unless otherwise specified in the X resources, this is the file opened when Xfm starts. .TP .B /etc/X11/xfm/Apps Unless otherwise specified in the X resources, this file is opened when the previous one fails. .SH "SEE ALSO" .BR xfm (1), .BR xfm_dev (5), .BR xfmtype (1), .BR xbm (5), .BR xpm (5).