path: root/doc/man/kfmclient.1

.\" This file was generated by kdemangen.pl
.\" Further edits by Adeodato Simó. COMMANDS and EXAMPLES sections added.
.TH KFMCLIENT 1 "Jan 2005" "Trinity Desktop Environment" "TDE tool for opening URLs from the command line"
.SH NAME
kfmclient
- TDE tool for opening URLs from the command line
.SH SYNOPSIS
kfmclient [Qt-options] [TDE-options] [options] command [URL(s)] 
.SH DESCRIPTION
kfmclient is a tool for opening local and remote URLs in Konqueror from
the command line.
.SH COMMANDS
.SS
.SS openURL
.TP
kfmclient openURL \fIurl\fR [ \fImimetype\fR ]
Opens a window showing \fIurl\fR. \fIurl\fR may be a relative path or file name,
such as . or subdir/. If \fIurl\fR is omitted, $HOME is used instead.

If \fImimetype\fR is specified, it will be used to determine the component
that Konqueror should use. For instance, set it to text/html for a web
page, to make it appear faster.
.SS newTab
.TP
kfmclient newTab \fIurl\fR [ \fImimetype\fR ]
Same as above but opens a new tab with \fIurl\fR in an existing Konqueror
window on the current active desktop if possible.
.SS openProfile
.TP
kfmclient openProfile \fIprofile\fR [ \fIurl\fR ]
Opens a window using the given profile. \fIprofile\fR is a file under
~/.trinity/share/apps/konqueror/profiles. \fIurl\fR is an optional URL to open.
.SS openProperties
.TP
kfmclient openProperties \fIurl\fR
Opens a properties menu.
.SS exec
.TP
kfmclient exec [ \fIurl\fR [ \fIbinding\fR ] ]
Tries to execute \fIurl\fR. \fIurl\fR may be a usual URL, this URL will
be opened. You may omit \fIbinding\fR. In this case the default binding
is tried. Of course URL may be the URL of a document, or it may be a
*.desktop file.
This way you could for example mount a device by passing 'Mount default'
as binding to 'cdrom.desktop'.
.SS move
.TP
kfmclient move \fIsrc\fR \fIdest\fR
Moves the URL \fIsrc\fR to \fIdest\fR. \fIsrc\fR may be a list of URLs.
.SS copy
.TP
kfmclient copy \fIsrc\fR \fIdest\fR
Copies the URL \fIsrc\fR to \fIdest\fR. \fIsrc\fR may be a list of URLs.
.SS download
.TP
kfmclient download [ \fIsrc\fR ]
Copies the URL \fIsrc\fR to a user specified location. \fIsrc\fR may be
a list of URLs, if not present then a URL will be requested.
.SS sortDesktop
.TP
kfmclient sortDesktop
Rearranges all icons on the desktop.
.SS configure
.TP
kfmclient configure
Re-read Konqueror's configuration.
.SS configureDesktop
.TP
kfmclient configureDesktop
Re-read kdesktop's configuration.
.SH OPTIONS
.SS
.SS Generic options:
.TP
.B  --help  
Show help about options
.TP
.B  --help-qt  
Show Qt specific options
.TP
.B  --help-tde  
Show TDE specific options
.TP
.B  --help-all  
Show all options
.TP
.B  --author  
Show author information
.TP
.B -v,  --version  
Show version information
.TP
.B  --license  
Show license information
.TP
.B  --  
End of options
.SS 
.SS TDE options:
.TP
.B  --caption  <caption>
Use 'caption' as name in the titlebar
.TP
.B  --icon  <icon>
Use 'icon' as the application icon
.TP
.B  --miniicon  <icon>
Use 'icon' as the icon in the titlebar
.TP
.B  --config  <filename>
Use alternative configuration file
.TP
.B  --dcopserver  <server>
Use the DCOP Server specified by 'server'
.TP
.B  --nocrashhandler  
Disable crash handler, to get core dumps
.TP
.B  --waitforwm  
Waits for a WM_NET compatible windowmanager
.TP
.B  --style  <style>
sets the application GUI style
.TP
.B  --geometry  <geometry>
sets the client geometry of the main widget
.SS 
.SS Qt options:
.TP
.B  --display  <displayname>
Use the X-server display 'displayname'
.TP
.B  --session  <sessionId>
Restore the application for the given 'sessionId'
.TP
.B  --cmap  
Causes the application to install a private color
map on an 8-bit display
.TP
.B  --ncols  <count>
Limits the number of colors allocated in the color
cube on an 8-bit display, if the application is
using the QApplication::ManyColor color
specification
.TP
.B  --nograb  
tells Qt to never grab the mouse or the keyboard
.TP
.B  --dograb  
running under a debugger can cause an implicit
-nograb, use -dograb to override
.TP
.B  --sync  
switches to synchronous mode for debugging
.TP
.B --fn,  --font  <fontname>
defines the application font
.TP
.B --bg,  --background  <color>
sets the default background color and an
application palette (light and dark shades are
calculated)
.TP
.B --fg,  --foreground  <color>
sets the default foreground color
.TP
.B --btn,  --button  <color>
sets the default button color
.TP
.B  --name  <name>
sets the application name
.TP
.B  --title  <title>
sets the application title (caption)
.TP
.B  --visual  TrueColor
forces the application to use a TrueColor visual on
an 8-bit display
.TP
.B  --inputstyle  <inputstyle>
sets XIM (X Input Method) input style. Possible
values are onthespot, overthespot, offthespot and
root
.TP
.B  --im  <XIM server>
set XIM server
.TP
.B  --noxim  
disable XIM
.TP
.B  --reverse  
mirrors the whole layout of widgets
.SH EXAMPLES
.TP
kfmclient exec file:/root/Desktop/cdrom.desktop "Mount default"
Mounts the CD-ROM.
.TP
kfmclient exec file:/home/weis/data/test.html
Opens the file with default binding.
.TP
kfmclient exec file:/home/weis/data/test.html Netscape
Opens the file with netscape.
.TP
kfmclient exec ftp://localhost/
Opens new window with URL.
.TP
kfmclient exec file:/root/Desktop/emacs.desktop
Starts emacs.
.TP
kfmclient exec file:/root/Desktop/cdrom.desktop
Opens the CD-ROM's mount directory.
.TP
kfmclient exec .
Opens the current directory. Very convenient.
.SH OTHER
This manual page was written by Adeodato Simo <asp16@alu.ua.es> for the
Debian system (but may be used by others).

This manual page can be redistribute and/or modified it under the terms
of the GNU General Public License as published by the Free Software
Foundation; version 2 dated June, 1991.
.nf