Warning, /network/krdc/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"> <!-- ONLY If you are writing non-English 
0005                                      original documentation, change 
0006                                      the language here -->
0007     
0008   <!-- Do not define any other entities; instead, use the entities
0009        from entities/general.entities and $LANG/user.entities. -->
0010 ]>
0011 <!-- Based on kdoctemplate v0.9 January 10 2003 -->
0012 
0013 <book id="krdc" lang="&language;">
0014 
0015 <!-- This header contains all of the meta-information for the document such
0016 as Authors, publish date, the abstract, and Keywords -->
0017 
0018 <bookinfo>
0019 <title>The &krdc; Handbook</title>
0020 
0021 <authorgroup>
0022 <author>
0023 &Brad.Hards;
0024 &Brad.Hards.mail;
0025 </author>
0026 <author>
0027     <firstname>Urs</firstname>
0028     <surname>Wolfer</surname>
0029     <affiliation>
0030         <address><email>uwolfer @ kde.org</email></address>
0031     </affiliation>
0032 </author>
0033 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0034 </authorgroup>
0035 
0036 <legalnotice>&FDLNotice;</legalnotice>
0037 
0038 <date>2016-07-25</date>
0039 <releaseinfo>Applications 16.08</releaseinfo>
0040 
0041 <copyright>
0042 <year>2003, 2008</year>
0043 </copyright>
0044 
0045 <abstract>
0046 <para>
0047 &krdc; is a client application that allows you to view or even control
0048 the desktop session on another machine that is running a compatible server.
0049 <acronym>VNC</acronym> and <acronym>RDP</acronym> is supported.
0050 </para>
0051 </abstract>
0052 
0053 <keywordset>
0054 <keyword>KDE</keyword>
0055 <keyword>kdenetwork</keyword>
0056 <keyword>krfb</keyword>
0057 <keyword>VNC</keyword>
0058 <keyword>RFB</keyword>
0059 <keyword>krdc</keyword>
0060 <keyword>Desktop Sharing</keyword>
0061 <keyword>Remote Control</keyword>
0062 <keyword>Remote Assistance</keyword>
0063 <keyword>Remote Desktop</keyword>
0064 <keyword>RDP</keyword>
0065 <keyword>Remote Administration</keyword>
0066 </keywordset>
0067 
0068 </bookinfo>
0069 
0070 <chapter id="introduction">
0071 <title>Introduction</title>
0072 
0073 <para>
0074 &krdc; is a client application that allows you to view or even control
0075 the desktop session on another machine that is running a compatible
0076 server.
0077 </para>
0078 
0079 <para>
0080 You would typically use &krdc; with the &kde; <acronym>VNC</acronym> server (&krfb;), which is
0081 also known as Krfb, since it closely matches the special features of &krdc;.
0082 </para>
0083 
0084 <para>
0085 If you want to start &krdc; from &konsole;, the command is <userinput><command>krdc</command></userinput>.
0086 </para>
0087 
0088 <para>
0089 Please report any problems or feature requests to the &kde; mailing
0090 lists or file a bug at <ulink
0091 url="https://bugs.kde.org">https://bugs.kde.org</ulink>.
0092 </para>
0093 </chapter>
0094 
0095 <chapter id="what-is-RFB">
0096 <title>The Remote Frame Buffer protocol</title>
0097 
0098 <para>
0099 This chapter provides a brief description of the Remote Frame Buffer
0100 protocol used by &krdc; and by other compatible systems. If you are
0101 already familiar with Remote Frame Buffer, you can safely skip this
0102 chapter.
0103 </para>
0104 
0105 <para>
0106 The high level implementation of a system using the Remote Frame
0107 Buffer protocol is known as Virtual Network Computer, or more often
0108 just as <acronym>VNC</acronym>.
0109 </para>
0110 
0111 <para>
0112 Remote Frame Buffer (or <acronym>RFB</acronym> for short) is a simple
0113 protocol for remote access to graphical user interfaces. It works at
0114 the frame-buffer level, which roughly corresponds to the rendered
0115 screen image, which means that it can be applied to all windowing
0116 systems (including X11, &MacOS; and &Microsoft; &Windows;). Remote
0117 Frame Buffer applications exist for many platforms, and can often be
0118 free re-distributed.
0119 </para>
0120 
0121 <para>
0122 In the Remote Frame Buffer protocol, the application that runs on the
0123 machine where the user sits (containing the display, keyboard and
0124 pointer) is called the client. The application that runs on the
0125 machine where the framebuffer is located (which is running the
0126 windowing system and applications that the user is remotely
0127 controlling) is called the server. &krdc; is the &kde; client for the
0128 Remote Frame Buffer protocol. &krfb; is the &kde; server for the
0129 Remote Frame Buffer protocol. 
0130 </para>
0131 
0132 <para>
0133 It takes a reasonable amount of network traffic to send an image of
0134 the framebuffer, so Remote Frame Buffer works best over high
0135 bandwidth links, such as a local area network. It is still possible to
0136 use &krdc; over other links, but performance is unlikely to be as good.
0137 </para>
0138 
0139 </chapter>
0140 
0141 <chapter id="using-krdc">
0142 <title>Using &krdc;</title>
0143 
0144 <para>
0145 It is very easy to use &krdc; - it has a simple interface, as shown in
0146 the screenshot below.
0147 </para>
0148 
0149 <para>
0150 <screenshot>
0151 <screeninfo>Here's a screenshot of &krdc;</screeninfo>
0152         <mediaobject>
0153           <imageobject>
0154             <imagedata fileref="krdc_mainwindow.png" format="PNG"/>
0155           </imageobject>
0156           <textobject>
0157             <phrase>&krdc; main window</phrase>
0158           </textobject>
0159         </mediaobject>
0160 </screenshot>
0161 </para>
0162 
0163 <sect1 id="compatible-versions"><title>Connecting &krdc; to compatible servers</title>
0164 
0165 <para>
0166 &krdc; is a client, and it needs to be used with compatible
0167 servers. There are different ways to connect to those servers:
0168 </para>
0169 
0170 <itemizedlist>
0171 <listitem>
0172 <para>Directly typing the server name (or IP address) into the
0173 <guilabel>Connect to:</guilabel> input.</para> 
0174 </listitem>
0175 <listitem>
0176 <para>By using an invitation that you received. &krfb; uses
0177 invitations, and can send them by email.</para>
0178 </listitem>
0179 </itemizedlist>
0180 
0181 <para>
0182 Let's look at each of these in turn.
0183 </para>
0184 
0185 <sect2><title>Server name entry</title>
0186 <para>
0187 If you know the host name (or IP address) of the server you want to
0188 connect to, you can enter it directly into the <guilabel>Connect to:</guilabel> input.
0189 </para>
0190 
0191 <para>
0192 If you want to connect to a machine named megan, which is
0193 running a <acronym>VNC</acronym> server on screen 1 (5901), you can enter
0194 <userinput>megan:1</userinput> or <userinput>megan:5901</userinput> and 
0195 choose <guilabel>vnc</guilabel> as the protocol in the 
0196 drop down box.
0197 </para>
0198 <para>
0199 <screenshot>
0200 <screeninfo>Entering a hostname into &krdc;</screeninfo>
0201         <mediaobject>
0202           <imageobject>
0203             <imagedata fileref="address_input.png" format="PNG"/>
0204           </imageobject>
0205           <textobject>
0206             <phrase>Entering a hostname into &krdc;</phrase>
0207           </textobject>
0208         </mediaobject>
0209 </screenshot>
0210 </para>
0211 
0212 <para>
0213 Similary, if you are using a <acronym>RDP</acronym> server on that
0214 machine, you can enter <userinput>megan</userinput>. Choose <guilabel>rdp</guilabel> as
0215 the protocol. <acronym>RDP</acronym> does not need the screen number to be specified.
0216 If the server runs the <acronym>RDP</acronym> server not on the default port, you may
0217 specify it in the following way: <userinput>megan:3910</userinput>
0218 </para>
0219 <para>You need to enter an &URL; in percent encoded syntax, i.e. @ as %40, for &eg; 
0220 <userinput>username%40ad.domain.example</userinput>
0221 </para>
0222 <!--https://bugs.kde.org/show_bug.cgi?id=261076-->
0223 
0224 </sect2>
0225 
0226 <sect2><title>Using an invitation</title>
0227 <para>
0228 Within the &krfb; server application, it is possible to send
0229 invitations over email (and in other ways, although email is the most
0230 useful). If you receive this type of email invitation, you can just
0231 click on the link provided in the mail.
0232 This will start &krdc; if it is not already running, and connect to
0233 the server specified in the invitation.
0234 </para>
0235 
0236 </sect2>
0237 
0238 </sect1>
0239 
0240 <sect1 id="connection"><title>What happens when you connect</title>
0241 
0242 <para>
0243 Notice: Before connecting, ensure that the target computer (server) is
0244 available on the network and, if necessary, that its firewall has
0245 been correctly configured or disabled.
0246 </para>
0247 
0248 <para>
0249 No matter how you select the server to connect to, the next thing that
0250 happens is that &krdc; asks you about the network connection to the
0251 server, as shown below:
0252 </para>
0253 
0254 <para>
0255 <screenshot>
0256 <screeninfo>&krdc; connection speed selection</screeninfo>
0257         <mediaobject>
0258           <imageobject>
0259             <imagedata fileref="vnc_host_configuration.png" format="PNG"/>
0260           </imageobject>
0261           <textobject>
0262             <phrase>&krdc; connection speed selection</phrase>
0263           </textobject>
0264         </mediaobject>
0265 </screenshot>
0266 </para>
0267 
0268 <para>
0269 There are three speed settings for the <acronym>VNC</acronym> protocol:
0270 </para>
0271 
0272 <itemizedlist>
0273 <listitem><para>High Quality (LAN, direct connection), which is the
0274 default, and you should evaluate how well this setting performs before
0275 selecting a lower performance option that uses less bandwidth.
0276 </para></listitem>
0277 <listitem><para>Medium Quality (DSL, Cable, fast
0278 Internet).</para></listitem>
0279 <listitem><para>Low Quality (Modem, ISDN, slow
0280 Internet).</para></listitem>
0281 </itemizedlist>
0282 
0283 <para>
0284 If you always operate over the same link type, you can deselect the
0285 checkbox labeled <guilabel>Show this dialog again for this
0286 host</guilabel>, which means that you won't be asked about the
0287 connection type again for this host, providing you identify it in the
0288 same way. For example, if a host has two names, and deselect the
0289 checkbox when connecting using one name, you won't get asked if you
0290 connect using that name, although you will be asked if you use the
0291 other name, or the IP address.
0292 </para>
0293 
0294 <para>
0295 You select the appropriate speed setting, and select the
0296 <guibutton>OK</guibutton> to proceed.
0297 </para>
0298 
0299 <para>
0300 You can see the connection status in the icon in the tab.
0301 </para>
0302 
0303 <para>
0304 Depending on the configuration of the server, you may (and almost
0305 certainly will) need to provide a password to authenticate to the
0306 server. &krdc; will provide a password dialog similar to that shown
0307 below.
0308 </para>
0309 
0310 <para>
0311 &krdc; has the ability to save the password for further connections
0312 to the same host. It uses KWallet for doing this. You need to check the
0313 <guibutton>Remember password (KWallet)</guibutton> check box if you like
0314 to use this feature.
0315 </para>
0316 
0317 <para>
0318 <screenshot>
0319 <screeninfo>&krdc; password entry</screeninfo>
0320         <mediaobject>
0321           <imageobject>
0322             <imagedata fileref="password_entry.png" format="PNG"/>
0323           </imageobject>
0324           <textobject>
0325             <phrase>&krdc; password entry</phrase>
0326           </textobject>
0327         </mediaobject>
0328 </screenshot>
0329 </para>
0330 
0331 <para>
0332 After authentication, you will be connected to the remote server, and
0333 can begin using &krdc; to observe or control the remote desktop.
0334 </para>
0335 
0336 </sect1>
0337 
0338 <sect1 id="controlling-remote"><title>Controlling the remote desktop connection</title>
0339 
0340 <para>
0341 Having connected to the remote server, you would normally use the
0342 keyboard and mouse to control the windowing system and applications on
0343 that remote machine.
0344 </para>
0345 
0346 <para>
0347 You can view the remote desktop either as a full screen, or as a
0348 window on the local desktop. You can change between these modes using
0349 icons shown below.
0350 </para>
0351 
0352 <para>
0353 <screenshot>
0354 <screeninfo>&krdc; full screen mode selection</screeninfo>
0355         <mediaobject>
0356           <imageobject>
0357             <imagedata fileref="view-fullscreen.png" format="PNG"/>
0358           </imageobject>
0359           <textobject>
0360             <phrase>&krdc; full screen mode selection</phrase>
0361           </textobject>
0362         </mediaobject>
0363 </screenshot>
0364 </para>
0365 
0366 <para>
0367 <screenshot>
0368 <screeninfo>&krdc; window mode selection</screeninfo>
0369         <mediaobject>
0370           <imageobject>
0371             <imagedata fileref="view-restore.png" format="PNG"/>
0372           </imageobject>
0373           <textobject>
0374             <phrase>&krdc; window mode selection</phrase>
0375           </textobject>
0376         </mediaobject>
0377 </screenshot>
0378 </para>
0379 
0380 <para>
0381 Full screen mode is normally better when you are helping a remote
0382 user, because you can see all of what they can see. Window mode is
0383 most useful when you are working both remotely and locally - perhaps
0384 referring to some local documentation and then using those
0385 instructions on the remote machine.
0386 </para>
0387 
0388 <sect2><title>Using window mode</title>
0389 
0390 <para>
0391 In window mode, you can terminate the connection by closing the window, by clicking
0392 on the logout button.
0393 </para>
0394 
0395 </sect2>
0396 
0397 <sect2><title>Using full screen mode</title>
0398 
0399 <para>
0400 In full screen mode, you can change the appearance of the toolbar.
0401 The transparency of the toolbar can be changed with scrollwheel.
0402 </para>
0403 
0404 </sect2>
0405 
0406 </sect1>
0407 
0408 <sect1 id="bookmarks"><title>Bookmarks</title>
0409 
0410 <para>
0411 &krdc; has the ability to manage bookmarks. If you need to connect often to
0412 the same remote desktop, you can add an entry for this connection to the
0413 bookmark list. You can do so with a click on <menuchoice><guimenu>Bookmarks</guimenu>
0414 <guimenuitem>Add Bookmark</guimenuitem></menuchoice>.
0415 </para>
0416 
0417 <para>
0418 <screenshot>
0419 <screeninfo>&krdc; bookmarks menu</screeninfo>
0420         <mediaobject>
0421           <imageobject>
0422             <imagedata fileref="bookmarks_menu.png" format="PNG"/>
0423           </imageobject>
0424           <textobject>
0425             <phrase>&krdc; bookmarks menu</phrase>
0426           </textobject>
0427         </mediaobject>
0428 </screenshot>
0429 </para>
0430 
0431 
0432 <sect2><title>History Bookmarks</title>
0433 
0434 <para>
0435 &krdc; saves last used remote desktop connections. You can access these special
0436 bookmarks at <menuchoice><guimenu>Bookmarks</guimenu><guimenuitem>History</guimenuitem></menuchoice>. Of course you can also
0437 delete a bookmark of this list if you don't need it anymore in the list. Just click
0438 <guibutton>Delete Bookmark</guibutton> which appears after a click with the right mouse button on
0439 the bookmark you would like to delete.
0440 </para>
0441 
0442 </sect2>
0443 
0444 </sect1>
0445 
0446 <sect1 id="managing-configuration"><title>Managing &krdc; configuration</title>
0447 <para>
0448 Using <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure KRDC...</guimenuitem></menuchoice>, 
0449 you can open a dialog to modify the behavior of &krdc;. Selecting that button brings up a
0450 window as shown below:
0451 </para>
0452 
0453 <para>
0454 <screenshot>
0455 <screeninfo>&krdc; preferences - General tab</screeninfo>
0456         <mediaobject>
0457           <imageobject>
0458             <imagedata fileref="general_preferences.png" format="PNG"/>
0459           </imageobject>
0460           <textobject>
0461             <phrase>&krdc; preferences - <guilabel>General</guilabel> tab</phrase>
0462           </textobject>
0463         </mediaobject>
0464 </screenshot>
0465 </para>
0466 
0467 <para>
0468 <screenshot>
0469 <screeninfo>&krdc; preferences - <guilabel>VNC Defaults</guilabel> tab</screeninfo>
0470         <mediaobject>
0471           <imageobject>
0472             <imagedata fileref="vnc_preferences.png" format="PNG"/>
0473           </imageobject>
0474           <textobject>
0475             <phrase>&krdc; preferences - <guilabel>VNC
0476 Defaults</guilabel> profiles tab</phrase>
0477           </textobject>
0478         </mediaobject>
0479 </screenshot>
0480 </para>
0481 
0482 <para>
0483 <screenshot>
0484 <screeninfo>&krdc; preferences - <guilabel>RDP Defaults</guilabel> tab</screeninfo>
0485         <mediaobject>
0486           <imageobject>
0487             <imagedata fileref="rdp_preferences.png" format="PNG"/>
0488           </imageobject>
0489           <textobject>
0490             <phrase>&krdc; preferences - <guilabel>RDP
0491 Defaults</guilabel> profiles tab</phrase>
0492           </textobject>
0493         </mediaobject>
0494 </screenshot>
0495 </para>
0496 
0497 
0498 </sect1>
0499 
0500 </chapter>
0501 
0502 <chapter id="faq">
0503 <title>Questions and Answers</title>
0504 
0505 <!-- (OPTIONAL but recommended) This chapter should include all of the silly
0506 (and not-so-silly) newbie questions that fill up your mailbox. This chapter
0507 should be reserved for BRIEF questions and answers! If one question uses more
0508 than a page or so then it should probably be part of the
0509 "Using this Application" chapter instead. You should use links to
0510 cross-reference questions to the parts of your documentation that answer them.
0511 This is also a great place to provide pointers to other FAQ's if your users
0512 must do some complicated configuration on other programs in order for your
0513 application work. -->
0514 
0515 <qandaset id="faqlist">
0516 <qandaentry>
0517 <question>
0518 <para>Why does <acronym>RDP</acronym> support not work?</para>
0519 </question>
0520 <answer>
0521 <para><acronym>RDP</acronym> support in &krdc; depends on xfreerdp (FreeRDP). Make sure that you have installed
0522 this runtime dependency.
0523 </para>
0524 </answer>
0525 </qandaentry>
0526 </qandaset>
0527 
0528 </chapter>
0529 
0530 <chapter id="credits">
0531 
0532 <!-- Include credits for the programmers, documentation writers, and
0533 contributors here. The license for your software should then be included below
0534 the credits with a reference to the appropriate license file included in the K D E
0535 distribution. -->
0536 
0537 <title>Credits and License</title>
0538 
0539 <para>
0540 &krdc;
0541 </para>
0542 <para>
0543 The &krdc; project has been started by Tim Jansen <email>tim@tjansen.de</email>.
0544 As a Google Summer of Code 2007 project, Urs Wolfer <email>uwolfer @ kde.org</email>
0545 has completely rewritten &krdc;. Thanks to Google for making this possible, and thanks
0546 to the great mentor of this Summer of Code project, &Brad.Hards; &Brad.Hards.mail;.
0547 </para>
0548 
0549 <para>
0550 Documentation Copyright &copy; 2003 &Brad.Hards; &Brad.Hards.mail;
0551 Documentation Copyright &copy; 2007 Urs Wolfer <email>uwolfer @ kde.org</email>
0552 </para>
0553 
0554 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
0555 
0556 &underFDL;               <!-- FDL: do not remove -->
0557 
0558 &underGPL;               <!-- GPL License -->
0559 
0560 </chapter>
0561 
0562 &documentation.index;
0563 </book>
0564 
0565 <!--
0566 Local Variables:
0567 mode: xml
0568 sgml-minimize-attributes:nil
0569 sgml-general-insert-case:lower
0570 sgml-indent-step:0
0571 sgml-indent-data:nil
0572 End:
0573 
0574 vim:tabstop=2:shiftwidth=2:expandtab 
0575 -->