Warning, /network/krfb/doc/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0003   <!ENTITY % addindex "IGNORE">
0004   <!ENTITY % English "INCLUDE">
0005 ]>
0006 
0007 <book id="krfb" lang="&language;">
0008 
0009 <bookinfo>
0010 <title>The &krfb; Handbook</title>
0011 
0012 <authorgroup>
0013 <author>
0014 &Brad.Hards;
0015 &Brad.Hards.mail;
0016 </author>
0017 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0018 </authorgroup>
0019 
0020 <copyright>
0021 <year>2003</year>
0022 <holder>&Brad.Hards;</holder>
0023 </copyright>
0024 
0025 <legalnotice>&FDLNotice;</legalnotice>
0026 
0027 <date>2016-07-25</date>
0028 <releaseinfo>5.0 (Applications 16.08)</releaseinfo>
0029 
0030 <abstract>
0031 <para>
0032 &krfb; is a server application that allows you to share your current
0033 session with a user on another machine, who can use a <acronym>VNC</acronym> client to
0034 view or even control the desktop.
0035 </para>
0036 </abstract>
0037 
0038 <keywordset>
0039 <keyword>KDE</keyword>
0040 <keyword>kdenetwork</keyword>
0041 <keyword>krfb</keyword>
0042 <keyword>VNC</keyword>
0043 <keyword>RFB</keyword>
0044 <keyword>krdc</keyword>
0045 <keyword>Desktop Sharing</keyword>
0046 <keyword>Remote Control</keyword>
0047 <keyword>Remote Assistance</keyword>
0048 <keyword>Remote Desktop</keyword>
0049 </keywordset>
0050 
0051 </bookinfo>
0052 
0053 <chapter id="introduction">
0054 <title>Introduction</title>
0055 
0056 <para>
0057 &krfb; is a server application that allows you to share your current
0058 session with a user on another machine, who can use a <acronym>VNC</acronym> client to
0059 view or even control the desktop.
0060 </para>
0061 
0062 <para>
0063 You would typically use &krfb; with the &kde;  <acronym>VNC</acronym> client, which is
0064 &krdc;, since it closely matches the special features of &krfb;.
0065 </para>
0066 
0067 <para>
0068 &krfb; doesn't require you to start a new X session - it can share
0069 the current session. This makes it very useful when you want someone
0070 to help you perform a task.
0071 </para>
0072 
0073 <para>
0074 Please report any problems or feature requests to the &kde; mailing
0075 lists or file a bug at <ulink
0076 url="https://bugs.kde.org">https://bugs.kde.org</ulink>.
0077 </para>
0078 </chapter>
0079 
0080 <chapter id="what-is-RFB">
0081 <title>The Remote Frame Buffer protocol</title>
0082 
0083 <para>
0084 This chapter provides a brief description of the Remote Frame Buffer
0085 protocol used by &krfb; and by other compatible systems. If you are
0086 already familiar with Remote Frame Buffer, you can safely skip this
0087 chapter.
0088 </para>
0089 
0090 <para>
0091 The high level implementation of a system using the Remote Frame
0092 Buffer protocol is known as Virtual Network Computer, or more often
0093 just as <acronym>VNC</acronym>. 
0094 </para>
0095 
0096 <para>
0097 Remote Frame Buffer (or <acronym>RFB</acronym> for short) is a simple
0098 protocol for remote access to graphical user interfaces. It works at
0099 the frame-buffer level, which roughly corresponds to the rendered
0100 screen image, which means that it can be applied to all windowing
0101 systems (including X11, &MacOS; and &Microsoft; &Windows;). Remote
0102 Frame Buffer applications exist for many platforms, and can often be
0103 freely re-distributed.
0104 </para>
0105 
0106 <para>
0107 In the Remote Frame Buffer protocol, the application that runs on the
0108 machine where the user sits (containing the display, keyboard and
0109 pointer) is called the client. The application that runs on the
0110 machine where the framebuffer is located (which is running the
0111 windowing system and applications that the user is remotely
0112 controlling) is called the server. &krfb; is the &kde; server for the
0113 Remote Frame Buffer protocol. &krdc; is the &kde; client for the
0114 Remote Frame Buffer protocol.
0115 </para>
0116 
0117 <para>
0118 It takes a reasonable amount of network traffic to send an image of
0119 the framebuffer, so Remote Frame Buffer works best over high
0120 bandwidth links, such as a local area network. It is still possible to
0121 use &krfb; over other links, but performance is unlikely to be as good.
0122 </para>
0123 
0124 </chapter>
0125 
0126 <chapter id="using-krfb">
0127 <title>Using &krfb;</title>
0128 
0129 <sect1 id="main-windw">
0130 <title>&krfb; Main Window</title>
0131 <para>
0132 It is very easy to use &krfb; - it has a simple interface, as shown in
0133 the screenshot below.
0134 </para>
0135 
0136 <para>
0137 <screenshot>
0138 <screeninfo>Here's a screenshot of &krfb;</screeninfo>
0139         <mediaobject>
0140           <imageobject>
0141             <imagedata fileref="screenshot.png" format="PNG"/>
0142           </imageobject>
0143           <textobject>
0144             <phrase>&krfb; main window</phrase>
0145           </textobject>
0146         </mediaobject>
0147 </screenshot>
0148 </para>
0149 
0150 <para>
0151 When you want to allow someone to access your desktop, you have to
0152 enable the checkbox <guilabel>Enable Desktop Sharing</guilabel>,
0153 which will start the server.
0154 </para>
0155 
0156 <sect2 id="connection-details">
0157 <title>Connection Details</title>
0158 
0159 <para>
0160 The <guilabel>Address</guilabel> contains the address of your
0161 computer and the port number, separated by a colon.
0162 The address is just a hint - you can use any address that can
0163 reach your computer. &krfb; tries to guess your address from your
0164 network configuration, but does not always succeed in doing so.
0165 If your computer is behind a firewall it may have a different
0166 address or be unreachable for other computers.
0167 </para>
0168 <para>
0169 You can change the port on the <guilabel>Network</guilabel>
0170 page in the configuration dialog.
0171 </para>
0172 <para>
0173 The next field is prefilled with an automatically generated password.
0174 Click in the icon at the right of the field to change the password.
0175 </para>
0176 </sect2>
0177 
0178 <sect2 id="unattended-access">
0179 <title>Unattended Access</title>
0180 
0181 <para>
0182 Any remote user with the desktop sharing password will have to be authenticated.
0183 If unattended access is activated, and the remote user provides the password
0184 for unattended mode, desktop sharing access will be granted without explicit
0185 confirmation.
0186 </para>
0187 <para>
0188 By default the password for this mode is empty, to change that click on
0189 the button and enter a password.
0190 </para>
0191 <para>
0192 If unattended access is allowed, then you should probably specify a
0193 password.
0194 </para>
0195 
0196 <para>
0197 If the machine is a server and you are using &krfb; for remote
0198 administration, you probably want to use unattended access.
0199 </para>
0200 
0201 </sect2>
0202 
0203 <sect2 id="transfer-login-information">
0204 <title>Transfer Login Information</title>
0205 
0206 <para>
0207 &krfb; has no invitation feature any more as in previous versions.
0208 So you have to transfer the login information yourself using email
0209 or a personal invitation.
0210 </para>
0211 <para>
0212 If you cannot encrypt the email (or otherwise secure the link),
0213 sending a password by email is a very serious security risk, since
0214 anyone can read the password and address from the email as it passes
0215 over the network. This means that they can potentially take control of
0216 your machine.
0217 </para>
0218 <para>
0219 If you cannot encrypt the email message, it may be better to use a
0220 personal invitation, telephone the person you are giving access to,
0221 verify the identity of that person, and provide the required
0222 information that way.
0223 </para>
0224 
0225 <note>
0226 <para>
0227 &krfb; uses the normal <acronym>RFB</acronym> password system, which does not transfer
0228 your password in the clear across the network. Instead, it uses a
0229 challenge-response system. This is reasonably secure, as long as the
0230 password is securely guarded.
0231 </para>
0232 </note>
0233 
0234 </sect2>
0235 
0236 <sect2 id="krfb-qqit">
0237 <title>Quit &krfb;</title>
0238 
0239 <para>
0240 If you close the &krfb; main window by clicking on the window close icon or using the
0241 shortcut <keycombo action="simul">&Alt;<keycap>F4</keycap></keycombo> the server
0242 keeps running, which is indicated by an icon in the system tray.
0243 To stop &krfb; either use <menuchoice><guimenu>File</guimenu><guimenuitem>Quit</guimenuitem></menuchoice>
0244 in the main window or right click on the icon in the system tray and select
0245 <guimenuitem>Quit</guimenuitem>.
0246 </para>
0247 </sect2>
0248 
0249 </sect1>
0250 
0251 <sect1 id="krfb-configuration">
0252 <title>Configuring &krfb;</title>
0253 <para>
0254 In addition to the main &krfb; interface shown and described above, 
0255 you can also control &krfb;  using the
0256 <guimenuitem>Configure...</guimenuitem> on the &krfb; main window. The &krfb;
0257 configuration has two pages, as shown in the screenshot below: 
0258 </para>
0259 
0260 <para>
0261 The <guilabel>Network</guilabel> page allows control over the port that
0262 &krfb; uses, as shown below.
0263 </para>
0264 
0265 <para>
0266 <screenshot>
0267 <screeninfo>&krfb; Configuration (Network page)</screeninfo>
0268         <mediaobject>
0269           <imageobject>
0270             <imagedata fileref="configuration_network.png" format="PNG"/>
0271           </imageobject>
0272           <textobject>
0273             <phrase>&krfb; Configuration (Network page)</phrase>
0274           </textobject>
0275         </mediaobject>
0276 </screenshot>
0277 </para>
0278 
0279 <para>
0280 The <guilabel>Announce service on the local network</guilabel> checkbox
0281 controls whether &krfb; announces the service over the local network using
0282 Service Location Protocol. This is normally a good idea, but only
0283 works really well with a Service Location Protocol aware client, such
0284 as &krdc;.
0285 </para>
0286 
0287 <para>
0288 If you select the <guilabel>Use default port</guilabel> checkbox, 
0289 then &krfb; will locate a suitable port.
0290 If you deselect this checkbox, you can specify a particular
0291 port. Specifying a particular port may be useful if you are using
0292 port-forwarding on the firewall. Note that if Service Location
0293 Protocol is turned on, this will automatically deal with identifying
0294 the correct port.
0295 </para>
0296 
0297 <para>
0298 The <guilabel>Security</guilabel> page allows you to configure whether the
0299 person connecting to the &krfb; server can control the desktop, or only view.
0300 </para>
0301 
0302 <para>
0303 <screenshot>
0304 <screeninfo>&krfb; Configuration (Security page)</screeninfo>
0305         <mediaobject>
0306           <imageobject>
0307             <imagedata fileref="configuration_security.png" format="PNG"/>
0308           </imageobject>
0309           <textobject>
0310             <phrase>&krfb; Configuration (Security page)</phrase>
0311           </textobject>
0312         </mediaobject>
0313 </screenshot>
0314 </para>
0315 
0316 </sect1>
0317 
0318 <sect1 id="krfb-connection">
0319 <title>Connecting to &krfb;</title>
0320 
0321 <para>
0322 When someone connects to &krfb; on your machine, you will get a pop-up
0323 notification that looks like the following screenshot, unless you are
0324 accepting unattended access without confirmation.
0325 </para>
0326 <para>
0327 <screenshot>
0328 <screeninfo>&krfb; Connection Window</screeninfo>
0329         <mediaobject>
0330           <imageobject>
0331             <imagedata fileref="connection.png" format="PNG"/>
0332           </imageobject>
0333           <textobject>
0334             <phrase>&krfb; Connection Window</phrase>
0335           </textobject>
0336         </mediaobject>
0337 </screenshot>
0338 </para>
0339 
0340 <para>
0341 If you <guibutton>Accept Connection</guibutton>, the client can
0342 proceed to authenticate, which requires the correct password for a
0343 login. If you <guibutton>Refuse
0344 Connection</guibutton>, then the attempt to connect will be terminated.
0345 </para>
0346 
0347 <para>
0348 The <guilabel>Allow remote user to control keyboard and
0349 mouse</guilabel> check box determines whether this client can only
0350 observe, or can take control of your machine. 
0351 </para>
0352 
0353 </sect1>
0354 </chapter>
0355 
0356 <chapter id="credits">
0357 
0358 <title>Credits and License</title>
0359 
0360 <para>
0361 &krfb;
0362 </para>
0363 <para>
0364 Program copyright 2002 Tim Jansen <email>tim@tjansen.de</email>
0365 </para>
0366 <para>
0367 Contributors:
0368 <itemizedlist>
0369 <listitem><para>Ian Reinhart Geiser <email>geiseri@kde.org</email></para>
0370 </listitem>
0371 </itemizedlist>
0372 </para>
0373 
0374 <para>
0375 Documentation Copyright &copy; 2003 &Brad.Hards; &Brad.Hards.mail;
0376 </para>
0377 
0378 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0379 
0380 &underFDL;               <!-- FDL: do not remove -->
0381 
0382 &underGPL;               <!-- GPL License -->
0383 
0384 </chapter>
0385 
0386 &documentation.index;
0387 </book>
0388 
0389 <!--
0390 Local Variables:
0391 mode: xml
0392 sgml-minimize-attributes:nil
0393 sgml-general-insert-case:lower
0394 sgml-indent-step:0
0395 sgml-indent-data:nil
0396 End:
0397 
0398 vim:tabstop=2:shiftwidth=2:expandtab 
0399 -->