* [gentoo-doc-cvs] cvs commit: metadoc.xml kde-config.xml kde-split-ebuilds.xml
@ 2008-04-26 19:21 Xavier Neys
0 siblings, 0 replies; only message in thread
From: Xavier Neys @ 2008-04-26 19:21 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 08/04/26 19:21:00
Modified: metadoc.xml kde-config.xml kde-split-ebuilds.xml
Log:
#219345 Kra^H^HDE docs moved to its project space. Good riddance.
Revision Changes Path
1.211 xml/htdocs/doc/en/metadoc.xml
file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/metadoc.xml?rev=1.211&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/metadoc.xml?rev=1.211&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/metadoc.xml?r1=1.210&r2=1.211
Index: metadoc.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v
retrieving revision 1.210
retrieving revision 1.211
diff -u -r1.210 -r1.211
--- metadoc.xml 11 Apr 2008 23:59:51 -0000 1.210
+++ metadoc.xml 26 Apr 2008 19:21:00 -0000 1.211
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE metadoc SYSTEM "/dtd/metadoc.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.210 2008/04/11 23:59:51 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.211 2008/04/26 19:21:00 neysx Exp $ -->
<metadoc lang="en">
- <version>1.132</version>
+ <version>1.133</version>
<members>
<lead>neysx</lead>
<member>cam</member>
@@ -255,7 +255,7 @@
<file id="uml">/doc/en/uml.xml</file>
<file id="java">/doc/en/java.xml</file>
<file id="openafs">/doc/en/openafs.xml</file>
- <file id="kde-config">/doc/en/kde-config.xml</file>
+ <file id="kde-config">/proj/en/desktop/kde/kde-config.xml</file>
<file id="nano-basics-guide">/doc/en/nano-basics-guide.xml</file>
<file id="shoutcast-config">/doc/en/shoutcast-config.xml</file>
<file id="vdr-guide">/doc/en/vdr-guide.xml</file>
@@ -352,7 +352,7 @@
<file id="metadoc-guide">/proj/en/gdp/doc/metadoc-guide.xml</file>
<file id="hpc-howto">/doc/en/hpc-howto.xml</file>
<file id="gnap-userguide">/proj/en/base/embedded/gnap-userguide.xml</file>
- <file id="kde-split-ebuilds">/doc/en/kde-split-ebuilds.xml</file>
+ <file id="kde-split-ebuilds">/proj/en/desktop/kde/kde-split-ebuilds.xml</file>
<file id="grub-error-guide">/doc/en/grub-error-guide.xml</file>
<file id="usb-guide">/doc/en/usb-guide.xml</file>
<file id="liveusb">/doc/en/liveusb.xml</file>
1.34 xml/htdocs/doc/en/kde-config.xml
file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/kde-config.xml?rev=1.34&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/kde-config.xml?rev=1.34&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/kde-config.xml?r1=1.33&r2=1.34
Index: kde-config.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/kde-config.xml,v
retrieving revision 1.33
retrieving revision 1.34
diff -u -r1.33 -r1.34
--- kde-config.xml 28 Nov 2007 19:26:51 -0000 1.33
+++ kde-config.xml 26 Apr 2008 19:21:00 -0000 1.34
@@ -1,19 +1,16 @@
<?xml version='1.0' encoding='UTF-8'?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/kde-config.xml,v 1.33 2007/11/28 19:26:51 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/kde-config.xml,v 1.34 2008/04/26 19:21:00 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<guide link="/doc/en/kde-config.xml">
+<guide redirect="/proj/en/desktop/kde/kde-config.xml">
<title>The KDE Configuration HOWTO</title>
<author title="Author">
<mail link="swift@gentoo.org">Sven Vermeulen</mail>
</author>
-<author title="Editor">
- <mail link="greg_g@gentoo.org">Gregorio Guidi</mail>
-</author>
<abstract>
One of the most used desktop environments is KDE. This guide tries to describe
@@ -24,826 +21,19 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>1.22</version>
-<date>2007-06-23</date>
-
-<chapter>
-<title>What is the K Desktop Environment?</title>
-<section>
-<title>The Project</title>
-<body>
-
-<p>
-The <uri link="http://www.kde.org">KDE Project</uri> is a free software project
-dedicated to the development of KDE, an open source graphical desktop
-environment for Linux and Unix workstations. The development is carried out by
-several hundred software engineers from all over the world committed to free
-software development. See also <uri
-link="http://www.kde.org/whatiskde/project.php">What is the KDE Project</uri>.
-</p>
-
-</body>
-</section>
-<section>
-<title>The Software</title>
-<body>
-
-<p>
-The K Desktop Environment is an easy-to-use desktop environment built around a
-well thought out application framework to allow for application
-interoperability, drag n drop and so on. Apart from the essential components,
-the KDE environment also provides ready-to-use applications for 101 tasks: file
-management, Internet browsing, office applications, e-mail handling, ...
-Everything is covered by the KDE project.
-</p>
-
-<p>
-The KDE environment is available in more than 70 languages and has an immense
-user base. For those interested, there are lots of <uri
-link="http://www.kde.org/screenshots/">screen shots</uri> available. For more
-information on KDE, read the <uri link="http://www.kde.org/whatiskde/">What is
-KDE?</uri> article on <uri link="http://www.kde.org">KDE.org</uri>.
-</p>
-
-</body>
-</section>
-<section>
-<title>The Community</title>
-<body>
-
-<p>
-Many KDE-based community sites exist. On <uri
-link="http://www.kdenews.org">KDEnews.org</uri> you'll find the latest news on
-KDE generally. <uri link="http://www.kdedevelopers.org">KDEdevelopers.org</uri>
-is specifically focussed on KDE development, while <uri
-link="http://www.kde-forum.org">KDE-forum</uri> is better suited for the large
-masses. More links can be found on the <uri
-link="http://www.kde.org/family/">KDE Family page</uri>.
-</p>
+<version>2</version>
+<date>2008-04-26</date>
-</body>
-</section>
-</chapter>
<chapter>
-<title>Installing KDE</title>
-<section>
-<title>What do you need?</title>
-<body>
-
-<p>
-If you're interested in installing KDE (or KDE support), you will have to make
-sure that your USE variable contains the <c>kde</c> flag, and either the
-<c>qt3</c> or <c>qt4</c> flag (or both). Qt is the graphical widget library that
-KDE uses, and <c>qt3</c> is for version 3.x, while <c>qt4</c> will build support
-for the newer Qt 4.x library. Neither USE flag is necessary for installing KDE.
-However, there are a few packages that offer you the choice of using either the
-<c>qt3</c> or <c>qt4</c> libraries.
-</p>
-
-<p>
-You should also add <c>hal</c> to your USE variable now if you want to add support
-for mounting devices automatically as explained below in
-<uri link="#kde_device_mounting">Setup KDE to Mount Devices</uri>.
-</p>
-
-<p>
-If you do not want to use <uri link="http://www.arts-project.org/">aRts</uri>
-for your all-around multimedia, disable the <c>arts</c> USE flag (it is active
-by default).
-</p>
-
-<note>
-The Gentoo 2006.1 release introduced a number of new profiles, including the
-<c>desktop</c> subprofile. You may want to switch to this subprofile, if it
-exists for your architecture, as it contains a number of default USE flag
-changes. Please read the <uri link="/doc/en/gentoo-upgrading.xml">Gentoo
-Upgrading Guide</uri> to learn how to switch profiles.
-</note>
-
-</body>
-</section>
-<section>
-<title>Installing KDE as Split Packages</title>
-<body>
-
-<note>
-We recommend that you use the split packages to install KDE (rather than the
-monolithic packages, though both methods will be presented), as shown below.
-</note>
-
-<p>
-If you want to have more control on what parts of KDE you install, you have the
-possibility to install just the single KDE applications that you need. To know
-more about the ebuilds for the individual KDE programs see the <uri
-link="/doc/en/kde-split-ebuilds.xml">Split Ebuilds HOWTO</uri>.
-</p>
-
-<p>
-Knowing what to install and what not is a tad more difficult with split ebuilds.
-However, Gentoo does provide a few meta packages that will pull in a certain
-amount of KDE packages for you:
-</p>
-
-<ul>
- <li>
- If you want a full-blown KDE installation, install <c>kde-meta</c>.
- This package will pull in all KDE applications as dependencies.
- </li>
- <li>
- If you want a basic KDE installation, install <c>kdebase-startkde</c>. You
- can always install additional KDE applications when you want.
- </li>
- <li>
- If you want something in between <c>kde-meta</c> and
- <c>kdebase-startkde</c>, install <c>kdebase-meta</c>. This will install a
- few extra applications such as <c>konsole</c> and <c>kdm</c>.
- </li>
-</ul>
-
-<p>
-These three possibilities are the extreme limits; you are probably interested in
-a safe mixture of the two :) To make your decision process somewhat easier, the
-following table gives a short, very incomplete yet useful overview of some of
-the available KDE packages.
-</p>
-
-<p>
-These packages are <e>not</e> part of the <c>kdebase-startkde</c> installation.
-</p>
-
-<table>
-<tr>
- <th>Ebuild name</th>
- <th>Description</th>
-</tr>
-<tr>
- <ti><c>akregator</c></ti>
- <ti>
- The application to easily manage and browse internet RSS feeds.
- </ti>
-</tr>
-<tr>
- <ti><c>juk</c></ti>
- <ti>
- The playlist oriented media player, with a look and feel resembling Apple's
- iTunes.
- </ti>
-</tr>
-<tr>
- <ti><c>kate</c></ti>
- <ti>
- The <uri link="http://kate.kde.org/">KDE Advanced Text Editor</uri>, a
- multi-document editor with syntax highlighting, code folding and more.
- </ti>
-</tr>
-<tr>
- <ti><c>kmail</c></ti>
- <ti>
- Organize your e-mails efficiently with <uri
- link="http://kmail.kde.org/">KMail</uri>.
- </ti>
-</tr>
-<tr>
- <ti><c>knetattach</c></ti>
- <ti>
- With KNetAttach (also known as the <e>Network Folder Wizard</e>), you can
- easily add additional network folders to your KDE desktop.
- </ti>
-</tr>
-<tr>
- <ti><c>knode</c></ti>
- <ti>
- KNode is the powerful KDE newsreader.
- </ti>
-</tr>
-<tr>
- <ti><c>konsole</c></ti>
- <ti>
- <uri link="http://konsole.kde.org/">Konsole</uri> is the KDE terminal
- emulator.
- </ti>
-</tr>
-<tr>
- <ti><c>kontact</c></ti>
- <ti>
- <uri link="http://kontact.kde.org/">Kontact</uri> is the KDE Personal
- Information Manager, helping you manage your communications more easily,
- organize your work faster and work together more closely.
- </ti>
-</tr>
-<tr>
- <ti><c>kopete</c></ti>
- <ti>
- <uri link="http://kopete.kde.org/index.php">Kopete</uri> is KDE's Instant
- Messenger supporting all known IM protocols.
- </ti>
-</tr>
-<tr>
- <ti><c>korganizer</c></ti>
- <ti>
- <uri link="http://korganizer.kde.org/">Korganizer</uri> is the calendar and
- scheduling application for KDE.
- </ti>
-</tr>
-<tr>
- <ti><c>kpdf</c></ti>
- <ti>
- With <uri link="http://kpdf.kde.org/">KPDF</uri> you can view and work with
- PDF files. It has very unique features which enhance your viewing pleasure
- enormously.
- </ti>
-</tr>
-<tr>
- <ti><c>kscd</c></ti>
- <ti>
- kscd is a graphical CD player for KDE.
- </ti>
-</tr>
-<tr>
- <ti><c>ksnapshot</c></ti>
- <ti>
- With ksnapshot you can take screen shots from your desktop.
- </ti>
-</tr>
-<tr>
- <ti><c>kuickshow</c></ti>
- <ti>
- The KDE kuickshow application is able to browse amongst and display
- various image formats.
- </ti>
-</tr>
-</table>
-
-<p>
-And this is just the tip of the iceberg. If you want to know more about all
-possible KDE applications, take a look inside the <uri
-link="http://packages.gentoo.org/category/kde-base?full_cat">kde-base
-category</uri>. Their function should be available in the description.
-</p>
-
-<p>
-To preview what emerge would install, use <c>emerge -p</c> together with the
-<c>less</c> pager, otherwise you might not be able to see all packages.
-</p>
-
-<pre caption="Previewing the kde installation">
-<comment>(Substitute with your choice of package(s))</comment>
-# <i>emerge -p kdebase-startkde | less</i>
-</pre>
-
-<p>
-If you are happy with the proposed result, leave the <c>-p</c> out. This
-building process will take some time as KDE is a big environment. Don't be
-surprised when your system does not finish immediately.
-</p>
-
-</body>
-</section>
-<section>
-<title>Installing KDE as Monolithic Packages</title>
-<body>
-
-<p>
-Although the split ebuilds are the recommended way to install KDE, you do have
-the option of installing the monolithic ebuilds.
-</p>
-
-<p>
-The KDE project releases new versions of its desktop environment as a set of
-about 16 big packages, each containing many applications (thus they are called
-"monolithic"), so you need to decide which of these packages you want to
-install.
-</p>
-
-<p>
-If you want to see what it looks like to have all these packages installed,
-just check yourself:
-</p>
-
-<pre caption="Listing all packages KDE would install">
-# <i>emerge --pretend kde | less</i>
-</pre>
-
-<p>
-If you're not interested in installing all those packages, you can emerge them
-individually. You will most definitely want the <c>kdebase</c> package as it
-contains KDE's base packages and required dependencies. The following table
-lists some of the other available packages that you can install.
-</p>
-
-<table>
-<tr>
- <th>Package</th>
- <th>Description</th>
-</tr>
-<tr>
- <ti>kdeaccessibility</ti>
- <ti>
- Accessibility related programs, managed by the <uri
- link="http://accessibility.kde.org">KDE Accessibility Project</uri>
- </ti>
-</tr>
-<tr>
- <ti>kdeadmin</ti>
- <ti>
- KDE Administrative tools, such as <c>KCron</c> (Task Scheduling),
- <c>KUser</c> (User Management) and <c>KDat</c> (Backup Management).
- </ti>
-</tr>
-<tr>
- <ti>kdeartwork</ti>
- <ti>
- Various art-related stuff, including screen savers and themes. See also <uri
- link="http://www.kde-artists.org/">www.kde-artists.org</uri> for more KDE related
- artwork.
- </ti>
-</tr>
-<tr>
- <ti>kdeedu</ti>
- <ti>
- Educational KDE applications focused on school children aged 3 to 18. See
- also the <uri link="http://edu.kde.org">KDE Edu Project</uri>.
- </ti>
-</tr>
-<tr>
- <ti>kdegames</ti>
- <ti>
- Various KDE-developed games. More information can be found at the <uri
- link="http://games.kde.org">KDE Games Center</uri>.
- </ti>
-</tr>
-<tr>
- <ti>kdegraphics</ti>
- <ti>
- Graphic-related tools for KDE, including <c>KSnapshot</c> (Screenshot
- Software), <c>KolourPaint</c> (Simple Graphical Editor), <c>Kpdf</c>
- (PDF viewer), <c>KIconEdit</c> (Icon Editor) and <c>KPovModeler</c>
- (a 3D Modeler).
- </ti>
-</tr>
-<tr>
- <ti>kdemultimedia</ti>
- <ti>
- Multimedia-related applications, including support for CD, MP3, DVD,
- sequencing, sound and video applications. More information can be found on
- the <uri link="http://multimedia.kde.org">KDE Multimedia Project</uri>
- web site.
- </ti>
-</tr>
-<tr>
- <ti>kdenetwork</ti>
- <ti>
- Network-related applications such as <c>Kopete</c> (Multi-Protocol Instant
- Messaging), <c>kppp</c> (Dial-In) and <c>KSirc</c> (IRC client). Note that
- <c>konqueror</c> (File Manager <e>and</e> Browser) is part of <c>kdebase</c>!
- </ti>
-</tr>
-<tr>
- <ti>kdepim</ti>
- <ti>
- Personal Information Management tools, such as <c>KOrganizer</c> (Journal),
- <c>KAddressbook</c> (Address book), <c>Kontact</c> (Groupware) and
- <c>KMail</c> (E-mail). More information online at the <uri
- link="http://pim.kde.org">KDE PIM Project</uri> web site.
- </ti>
-</tr>
-<tr>
- <ti>kdesdk</ti>
- <ti>
- Code development tools, including <c>KBabel</c> (Translation tool),
- <c>KBugBuster</c> (Front end for KDE bug tracking) and <c>Kompare</c> (GUI
- to see differences between files).
- </ti>
-</tr>
-<tr>
- <ti>kdetoys</ti>
- <ti>
- Various toys to amuse yourself with when you're waiting for your pizza
- delivery. You'll find applets such as <c>eyesapplet</c> and
- <c>fifteenapplet</c>, but also nifty tools like <c>amor</c> which doesn't do
- much except eat resources :)
- </ti>
-</tr>
-<tr>
- <ti>kdeutils</ti>
- <ti>
- Graphical system tools such as <c>kcalc</c> (Calculator), <c>kdessh</c> (SSH
- terminal), <c>kfloppy</c> (Floppy-related actions), etc.
- </ti>
-</tr>
-<tr>
- <ti>kde-i18n</ti>
- <ti>
- Internationalization files for KDE. This includes translated
- documentation. See also the <uri link="http://i18n.kde.org">KDE i18n
- project</uri> for more information.
- </ti>
-</tr>
-</table>
-
-<p>
-For instance, to install KDE with only the network- and admin-related
-applications:
-</p>
-
-<pre caption="Example installation of individual KDE components">
-# <i>emerge kdebase kdenetwork kdeadmin</i>
-</pre>
-
-<p>
-In case you wonder: compiling KDE does take a while.
-</p>
-
-</body>
-</section>
-<section>
-<title>External KDE applications</title>
-<body>
-
-<p>
-The number of KDE applications is not limited to those shipped with the
-official KDE releases, but includes hundreds of other applications that use the
-KDE framework and libraries. Here we list just a few of the most popular ones.
-</p>
-
-<table>
-<tr>
- <th>Ebuild name</th>
- <th>Description</th>
-</tr>
-<tr>
- <ti><c>koffice</c></ti>
- <ti>
- <uri link="http://www.koffice.org/">KOffice</uri> is the comprehensive KDE
- office suite, featuring applications for word processing (KWord),
- spreadsheet calculations (KSpread), presentation (KPresenter), image
- manipulation (Krita), database management (Kexi) and much more.
- Just as KDE can be installed through the <c>kde</c> or <c>kde-meta</c>
- ebuilds, you can install KOffice as a single package (<c>koffice</c>) or as
- a set of individual packages (<c>koffice-meta</c>).
- </ti>
-</tr>
-<tr>
- <ti><c>amarok</c></ti>
- <ti>
- With <uri link="http://amarok.kde.org/">amaroK</uri> you have a powerful
- music player for Unix/Linux.
- </ti>
-</tr>
-<tr>
- <ti><c>k3b</c></ti>
- <ti>
- <uri link="http://www.k3b.org/">K3B</uri> is a complete CD/DVD burning
- utility with Audio support. Burning CDs was never this easy.
- </ti>
-</tr>
-<tr>
- <ti><c>kaffeine</c></ti>
- <ti>
- <uri link="http://kaffeine.sourceforge.net/">Kaffeine</uri> is a full
- featured multimedia-player for KDE.
- </ti>
-</tr>
-</table>
-
-</body>
-</section>
+<title>Moved</title>
<section>
-<title>First Impressions</title>
<body>
<p>
-Let us have a look at the result. Your mother has probably told you
-never to work as root. So we'll take your mother's advice and test
-KDE as a user. Log in as your user and configure your session so it starts KDE
-when you issue <c>startx</c>. You can do this by writing <c>exec startkde</c> in
-<path>~/.xinitrc</path> (see also
-<uri link="/doc/en/xorg-config.xml#using_startx">Using startx</uri> in the
-<uri link="/doc/en/xorg-config.xml">X Server Configuration Howto</uri>):
-</p>
-
-<pre caption="Configuring your local session">
-$ <i>echo "exec startkde" > ~/.xinitrc</i>
-</pre>
-
-<p>
-Now start up your graphical environment by running <c>startx</c>.
-</p>
-
-<pre caption="Starting KDE">
-$ <i>startx</i>
-</pre>
-
-<p>
-You will be greeted by an application called <c>KPersonalizer</c>.
-Congratulations, let's now take a look at how we can configure KDE...
+This document was moved to <uri>/proj/en/desktop/kde/kde-config.xml</uri>
</p>
</body>
</section>
</chapter>
-<chapter>
-<title>Configuring KDE</title>
-<section>
-<title>KPersonalizer</title>
-<body>
-
-<p>
-KPersonalizer is the application that configures KDE for you. It's a very
-useful wizard that allows you to quickly change KDE to suit your own needs. When
-you run KDE for the first time, KPersonalizer is automatically started.
-</p>
-
-<p>
-The first input KPersonalizer requests is your country and the language of your
-choice. As we haven't installed the necessary language packs on your system yet,
-the available languages will be very slim -- you'll probably have only English
-to choose from. Don't mind this, we will change the language later on (if
-applicable of course).
-</p>
-
-<p>
-The second choice you're offered is the <e>System Behavior</e>. This includes
-window activation, mouse selection, etc. When you select a certain behavior
-its description is shown to help you choose the behavior you like. If you're
-uncertain, don't panic -- you are able to change the behavior whenever you
-want.
-</p>
-
-<p>
-Next, KPersonalizer asks for the amount of eye-candy it should activate. The
-more eye-candy you want, the funkier your KDE will be, but the more your CPU
-will be stressed. However, this should be taken with a bit of salt - on a 600
-Mhz CPU with 128 Mb of memory, enabling full eye-candy still results in a
-responsive system.
-</p>
-
-<p>
-Finally, KDE asks what style you want to use. A style defines the window
-decoration, theme, button layout, etc. Try several styles to see which one you
-like the most. Did we already mention KDE is fully configurable?
-</p>
-
-<p>
-Now sit back and enjoy -- KDE will start up and you'll be greeted by a nice,
-clean, functional desktop environment.
-</p>
-
-</body>
-</section>
-<section>
-<title>Installing Language Packs</title>
-<body>
-
-<p>
-If English isn't your native language or you're just interested in working with
-KDE in a foreign language, please read on. We will install the language pack(s)
-for the language(s) you want to use with KDE.
-</p>
-
-<p>
-Language packs are contained in the <c>kde-i18n</c> package. To install the
-language packs of your choice, you need to set the <c>LINGUAS</c> variable to
-the language(s) you want to use. It is advisable to set this variable in
-<path>/etc/make.conf</path> so that updating your system doesn't remove the
-language packs you want.
-</p>
-
-<pre caption="Setting LINGUAS in /etc/make.conf">
-# <i>nano -w /etc/make.conf</i>
-<comment>(As an example, we install the language packs for Dutch (nl)
- and French (fr))</comment>
-LINGUAS="nl fr"
-</pre>
-
-<p>
-Now run <c>emerge kde-i18n</c> to install the language packs. Once settled, fire
-up KDE, then start the KDE Control Center (K-menu > Control Center). This is
-<e>the</e> application where you can control almost every aspect of KDE. It is
-much more extended than KPersonalizer.
-</p>
-
-<p>
-To change your language, go to <c>Regional & Accessibility</c>,
-<c>Country/Region & Languages</c>. Then add the language(s) of your choice.
-To see your (localized) KDE in its full glory, log out and in again, and enjoy.
-</p>
-
-</body>
-</section>
-<section>
-<title>Graphical Login</title>
-<body>
-
-<p>
-If you want to use <c>kdm</c> as graphical login manager (which means you don't
-have to login to a terminal and type <c>startx</c> every time) you need to
-first emerge it, and then edit a configuration file and set up your system so
-that it enters graphical mode after boot, as explained below.
-</p>
-
-<note>
-It's possible that you already have <c>kdm</c> installed for various reasons.
-If you get an error with packages blocking <c>kde-base/kdm</c>, proceed with
-the next section.
-</note>
-
-<pre caption="Installing kdm">
-# <i>emerge --ask kdm</i>
-</pre>
-
-<p>
-In <path>/etc/conf.d/xdm</path>, set the <c>DISPLAYMANAGER</c> variable to
-<c>kdm</c>.
-</p>
-
-<pre caption="Setting DISPLAYMANAGER in /etc/conf.d/xdm">
-# <i>nano -w /etc/conf.d/xdm</i>
-<comment>(Edit the following variable)</comment>
-DISPLAYMANAGER="kdm"
-</pre>
-
-<p>
-Finish up by adding <c>xdm</c> to the default runlevel:
-</p>
-
-<pre caption="Adding xdm to the default runlevel">
-# <i>rc-update add xdm default</i>
-</pre>
-
-<p>
-When you reboot your system, it will use KDM as the graphical login manager.
-</p>
-
-<p>
-KDM will provide a list of available sessions to choose from, including KDE -
-of course - and including all the other sessions installed on your system,
-which KDM finds by looking in <path>/usr/share/xsessions/</path>. Thus, if you
-use KDM, you don't need to edit <path>~/.xinitrc</path>.
-</p>
-
-</body>
-</section>
-<section id="kde_device_mounting">
-<title>Setup KDE to Mount Devices</title>
-<body>
-
-<!-- TODO add pmount package when pmount is in arch.
- Also, add pmount to the default runlevel -->
-
-<p>
-KDE gives you the power to mount devices such as CDROMs or USB sticks through a
-single click in a graphical interface. To accomplish this goal you need to have
-KDE compiled with <c>hal</c> in your USE variable and to have <c>dbus</c> and
-<c>hal</c> installed on your system. You should also add <c>dbus</c> and
-<c>hal</c> to the default runlevel and add yourself to the <c>plugdev</c>
-group.
-</p>
-
-<pre caption="Setup device mounting">
-# <i>emerge --ask dbus hal</i>
-# <i>rc-update add dbus default</i>
-# <i>rc-update add hald default</i>
-<comment>Add <user> to the plugdev group</comment>
-# <i>gpasswd -a <user> plugdev</i>
-</pre>
-
-</body>
-</section>
-</chapter>
-<chapter>
-<title>Managing KDE Installations</title>
-<section>
-<title>Multiple Installations</title>
-<body>
-
-<p>
-One peculiarity of the way KDE is managed in Gentoo is that when a new series
-of KDE appears (such as the 3.5.x series, which supersedes the 3.4.x series)
-it will be installed alongside the old one and will not overwrite it. So if
-for instance you had KDE 3.4 already installed and you emerge KDE 3.5,
-you will have two versions, one installed in <path>/usr/kde/3.4/</path> and
-the other in <path>/usr/kde/3.5/</path>.
-</p>
-
-<p>
-It should be noted that your settings for different KDE installations will be
-kept separate in the home directory. KDE 3.4 reads its settings from the
-directory <path>/home/<user>/.kde3.4</path>, and the first time you run
-KDE 3.5 a directory named <path>/home/<user>/.kde3.5</path> will be
-created by migrating the settings in the 3.4 directory and will be then used to
-store preferences and data.
-</p>
-
-<p>
-Another important remark to keep in mind when upgrading your KDE installation
-is that you could have problems with the external KDE applications you have
-installed (such as <c>koffice</c>, <c>amarok</c> or <c>k3b</c>) until you
-recompile them against the new KDE version. So as soon as you start using the
-new KDE you should reemerge them to make them link against the new libraries.
-</p>
-
-</body>
-</section>
-<section>
-<title>Unmerging Old Versions</title>
-<body>
-
-<p>
-Having multiple versions of KDE installed poses the problem of how to remove
-the old ones when we decide that they are not needed anymore. Unfortunately
-portage does not support unmerging a package with all its dependencies with a
-single command, so if for instance you run <c>emerge --unmerge kde</c> you will
-not remove the actual kde packages.
-</p>
-
-<p>
-To remove a KDE installation (e.g. KDE 3.4), the single packages have to be
-removed.
-</p>
-
-<pre caption="Removing KDE 3.4 packages">
-# <i>emerge --unmerge =arts-3.4* =kdelibs-3.4* =kdebase-3.4* ...</i>
-</pre>
-
-<p>
-Obviously this is very frustrating if you have many KDE packages installed.
-However this operation can be automated in many ways. The following one is
-an example.
-</p>
-
-<p>
-First we list all the packages that we want to remove. We use the <c>equery</c>
-command for this, part of the <c>app-portage/gentoolkit</c> package:
-</p>
-
-<pre caption="Listing packages to remove">
-<comment>(List all the installed KDE packages)</comment>
-# <i>equery list kde-base/</i>
-<comment>(List all the installed KDE packages and select the ones from KDE 3.4)</comment>
-# <i>equery list kde-base/ | grep 3\.4</i>
-</pre>
-
-<p>
-At this point you should double-check that the list corresponds to the packages
-that should be removed from the system. If you think it is ok, you can go on
-and pass the list to the <c>emerge --unmerge</c> command.
-</p>
-
-<pre caption="Removing selected packages">
-# <i>equery list kde-base/ | grep 3\.4 | xargs emerge --unmerge --pretend</i>
-</pre>
-
-<p>
-Check again the output and reissue the command without <c>--pretend</c> to
-start the unmerging process.
-</p>
-
-<p>
-After the job has completed, the directory <path>/usr/kde/3.4/</path> should
-contain only a few files (mainly configuration files, portage has a policy to
-never touch configurations). If you desire, you can safely wipe out
-<path>/usr/kde/3.4/</path> with its content to remove what remains of KDE 3.4.
-</p>
-
-</body>
-</section>
-</chapter>
-<chapter>
-<title>Frequently Asked Questions</title>
-<section>
-<title>KDE is extremely slow during startup</title>
-<body>
-
-<p>
-Make sure your <path>/etc/hosts</path> file is correct:
-</p>
-
-<ul>
- <li>
- If you have a static IP address, make sure your FQDN and hostname are
- mentioned on that line, like <c>192.168.0.10 tux.mydomain tux</c>
- </li>
- <li>
- If you have a dynamic IP address or you do not have any additional
- interfaces at all, add your hostname after the localhost statement, like
- <c>127.0.0.1 localhost tux</c>
- </li>
-</ul>
-
-<p>
-Check if you have DMA enabled for your disks:
-</p>
-
-<pre caption="Verifying DMA settings">
-# <i>hdparm /dev/hda</i>
-<comment>(...)</comment>
-using_dma = 1 (on)
-<comment>(...)</comment>
-</pre>
-
-</body>
-</section>
-</chapter>
-
</guide>
1.16 xml/htdocs/doc/en/kde-split-ebuilds.xml
file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/kde-split-ebuilds.xml?rev=1.16&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/kde-split-ebuilds.xml?rev=1.16&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/kde-split-ebuilds.xml?r1=1.15&r2=1.16
Index: kde-split-ebuilds.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/kde-split-ebuilds.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- kde-split-ebuilds.xml 17 Jan 2008 00:14:40 -0000 1.15
+++ kde-split-ebuilds.xml 26 Apr 2008 19:21:00 -0000 1.16
@@ -1,10 +1,10 @@
<?xml version='1.0' encoding='UTF-8'?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/kde-split-ebuilds.xml,v 1.15 2008/01/17 00:14:40 jkt Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/kde-split-ebuilds.xml,v 1.16 2008/04/26 19:21:00 neysx Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<guide link="/doc/en/kde-split-ebuilds.xml">
+<guide redirect="/proj/en/desktop/kde/kde-split-ebuilds.xml">
<title>The KDE Split Ebuilds HOWTO</title>
@@ -25,437 +25,16 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>1.11</version>
-<date>2008-01-16</date>
+<version>2</version>
+<date>2008-04-26</date>
<chapter>
-<title>The Split KDE Ebuilds</title>
+<title>Moved</title>
<section>
-<title>What they are</title>
<body>
<p>
-Until January 2005, the only KDE ebuilds in Portage were 'monolithic' ones.
-That is to say, there were only 15 ebuilds (<c>kdebase</c>, <c>kdenetwork</c>,
-...), and each one installed many applications that did not, in fact, depend on
-one another. This was clearly a suboptimal situation, and not very Gentoo-ish,
-but it was tolerated for a long time.
-</p>
-
-<p>
-The new 'split' ebuilds (for <c>konqueror</c>, <c>kmail</c>, ...) rectified the
-situation by providing separate ebuilds for all the separate KDE applications.
-This gave us a grand total of about 330 new ebuilds in the kde-base category.
-</p>
-
-<p>
-We still provide monolithic ebuilds for 3.5 and they are cleanly interoperable
-with the split ones. However, the split ebuilds are the new default, and there
-will be no monolithic ebuilds after KDE 4.0.
-</p>
-
-<p>
-Finally, it should be mentioned that there are split ebuilds for Koffice as
-well. These provide <c>kword</c>, <c>kugar</c>, etc. as separate packages.
-</p>
-
-</body>
-</section>
-<section>
-<title>How to install the split ebuilds</title>
-<body>
-
-<p>
-The latest stable KDE release, as of this writing, is 3.5.7. The latest
-unstable (~arch) is 3.5.8. Split and monolithic ebuilds for both releases are
-present in Portage. The 4.0.0 release is about to enter the tree in hardmasked
-state.
-</p>
-
-<ul>
- <li>
- To emerge a particular package, such as kmail, simply <c>emerge
- kmail</c>.
- </li>
- <li>
- To emerge the basic KDE environment allowing you to login into a
- minimalistic KDE session, <c>emerge kdebase-startkde</c>.
- </li>
- <li>
- Finally, for the exact equivalent of one of the monolithic packages - for
- instance, to get all the applications included in <c>kdebase</c> using
- split ebuilds - you can <c>emerge kdebase-meta</c> (or <c>kdepim-meta</c>,
- etc.) To get absolutely all KDE split ebuilds, <c>emerge kde-meta</c>.
- </li>
-</ul>
-
-</body>
-</section>
-<section>
-<title>How to upgrade from the monolithic to the split ebuilds</title>
-<body>
-
-<p>
-If you have KDE 3.3.x installed, you can simply <c>emerge kde-meta</c> to
-install the 3.5.x split ebuilds without disturbing your existing installation.
-</p>
-
-<p>
-If you have the KDE 3.4.x or 3.5.x monolithic ebuilds installed, you must
-unmerge them before emerging the split ebuilds. However, this process can be
-done for each monolithic ebuild in turn; you don't have to unmerge all of KDE
-at once.
-</p>
-
-<p>
-If you're in doubt, remember there are blocking dependencies in place between
-each monolithic ebuild and the split ebuilds derived from it. Portage won't
-allow an illegal state to be created, so any emerge or unmerge it allows is
-OK.
-</p>
-
-</body>
-</section>
-<section>
-<title>Advantages of the split ebuilds</title>
-<body>
-
-<p>
-Here's a brief list of what we gain from switching to the split ebuilds:
-</p>
-
-<ul>
- <li>
- Most KDE packages aren't changed at all between minor KDE releases. For
- example, the update from 3.3.1 to 3.3.2 changed fewer than 100 packages out
- of 320. Split packages allow us to create new ebuilds only for the packages
- that are actually changed, saving (in this example) more than two-thirds of
- the compilation time on an upgrade.
- </li>
- <li>
- Patches usually affect a specific package. With split ebuilds, they can be
- tested, approved and committed faster, and the developers have less to do;
- and, as above, the user will spend less time upgrading. This is especially
- important for security updates.
- </li>
- <li>
- Users of other desktops and leaner WMs can emerge a few KDE apps they like
- without the (quite big) overhead of the rest of, say, <c>kdebase</c> or
- <c>kdepim</c>.
- </li>
- <li>
- Users can fine-tune the packages they have installed. Reasons you might
- want this include:
-
- <ul>
- <li>
- You care about compilation time. <c>emerge kdebase kdepim
- kdenetwork</c> takes far too long when what you really need is
- <c>konqueror</c>, <c>kmail</c> and <c>kopete</c>. Besides, CPU time is
- money... somewhere.
- </li>
- <li>
- You care about disk usage. Every unused package is that many megabytes
- blocking the pores between your disk's sectors. A disk with more free
- space breathes freely; it's a fast, happy disk.
- </li>
- <li>
- You care about system security. All installed software is a potential
- source of vulnerabilities, and there's no excuse for unused software
- left lying around.
- </li>
- <li>
- You faithfully adhere to the <uri link="/main/en/philosophy.xml">Gentoo
- Way</uri>, and can't stand packages being bundled together and forced
- on the user. (Neither could we.)
- </li>
- </ul>
- </li>
- <li>
- Finally, the split ebuilds also allow more compile-time flexibility with
- USE flags.
- </li>
-</ul>
-
-</body>
-</section>
-<section>
-<title>Split and monolithic ebuild interoperability</title>
-<body>
-
-<p>
-Split and monolithic ebuilds can be mixed freely. The only restriction is that
-a monolithic ebuild can't be installed at the same time as a split ebuild
-deriving from it. There are blocking dependencies in the ebuilds that enforce
-this, so you can do anything emerge allows you to do.
-</p>
-
-<p>
-Ordinarily, however, there's no reason to use such a mixed configuration. In
-fact, except for special cases like very slow-compiling boxes (mips), you should
-use the split ebuilds for all your needs.
-</p>
-
-<p>
-The split ebuilds are also the default ebuilds. This means that when some other
-ebuild depends on a KDE application, it will want to install a split ebuild.
-However, the matching monolithic ebuild will also satisfy that dependency, so
-you can emerge the monolithic ebuild manually and then emerge the ebuild that
-depended on it.
-</p>
-
-</body>
-</section>
-</chapter>
-
-<chapter>
-<title>Performance issues</title>
-<section>
-<title>Why split ebuilds are slow</title>
-<body>
-
-<p>
-It's been <uri link="http://bugs.gentoo.org/show_bug.cgi?id=11123">said</uri>
-before that split ebuilds would take much more time to emerge than the
-monolithic ones, due to the overhead of unpacking and running configure for
-every package. A complete <c>emerge kde-meta</c> could take 20-30% longer
-than a classic <c>emerge kde</c>, unacceptable in an already long compile.
-</p>
-
-<p>
-Moreover, at present the split ebuilds always run <c>make -f
-admin/Makefile.cvs</c> (this means running autoconf, automake, etc. and several
-related kde-specific scripts). This adds an additional slowdown of
-approximately the same order as a configure run.
-</p>
-
-<p>
-Finally, a split ebuild needs to extract specific files out of a large tarball.
-This is slower than extracting a dedicated, small tarball. However, creating
-such small tarballs for the autotools-based build system of KDE 3.x is
-difficult.
-</p>
-
-<p>
-It is worth reiterating here that with the split ebuilds a KDE upgrade's
-compilation time can be greatly reduced by only upgrading the packages that
-actually changed. The benefit from a single such update often overshadows the
-overhead incurred during the original installation.
-</p>
-
-<p>
-Finally, installing all of KDE makes sense if you want to explore the available
-packages or are setting up a multi-user environment; however, most people use
-only some of the 300+ KDE apps available. Anyone who really cares about
-compilation time, such as owners of older boxes, can gain more time by
-selectively installing packages than they might lose by the overhead incurred.
-</p>
-
-</body>
-</section>
-<section>
-<title>How split ebuilds will be made faster</title>
-<body>
-
-<p>
-Most or even all of the split ebuilds' performance issues are tied to autotools
-- autoconf, automake and other tools which manage the <c>./configure;make;make
-install</c> build system used in KDE 3.x.
-</p>
-
-<p>
-KDE 4 will (as far as we can tell now) adopt a completely new build system,
-which among other things will greatly reduce the time its equivalent of a
-<c>make -f admin/Makefile.common; ./configure</c> will take. Hopefully, it will
-also make it much easier to create a small tarball for each split ebuild by
-lowering the cost of generating its equivalent of configure scripts (if any).
-</p>
-
-</body>
-</section>
-</chapter>
-
-<chapter>
-<title>Split ebuilds FAQ</title>
-<section>
-<title>Why are some split packages missing the newest ebuild versions?</title>
-<body>
-
-<p>
-As explained above, not all applications are really updated between minor KDE
-releases, and so not all applications receive new ebuild versions. For
-instance, libkdenetwork wasn't updated in 3.5.0_beta2, so the latest ebuild
-available with that release was 3.5_beta1.
-</p>
-
-<p>
-This is done purely to reduce compilation time during an upgrade. If we had
-made a libkdenetwork-3.5.0_beta2 ebuild, it would have installed precisely the
-same files as the 3.5_beta1 ebuild. The various dependencies are updated to
-work correctly (i.e. no ebuild will depend on libkdenetwork-3.5.0_beta2).
-</p>
-
-</body>
-</section>
-<section>
-<title>Can't we do this already with DO_NOT_COMPILE?</title>
-<body>
-
-<p>
-DO_NOT_COMPILE is an environment variable internal to the KDE build system. It
-allows selectively disabling subdirectories from compilation. Some people used
-to use it to compile subsets of the monolithic KDE ebuilds. For instance,
-running <c>DO_NOT_COMPILE=konqueror emerge kdebase</c> would install a kdebase
-without the <c>konqueror</c> application.
-</p>
-
-<p>
-However, DO_NOT_COMPILE was never intended to be used to interfere with the
-operation of a package manager's automated builds. It does not work, it can
-break your system, and it was never supported. We request everyone to refrain
-from using it.
-</p>
-
-<p>
-Here is a partial list of the problems with DO_NOT_COMPILE:
-</p>
-
-<ul>
- <li>
- It completely breaks Portage's dependency tracking. Portage does not know
- about DO_NOT_COMPILE, and thinks the entire monolithic package has been
- installed and can satisfy other packages' deps. This can cause other
- packages not to emerge or not to run.
- </li>
- <li>
- It forces the user to know the names and meanings of all the different
- existing subdirs of the KDE modules. Very few users do know this, unless
- they're KDE developers, so they can't use DO_NOT_COMPILE properly.
- </li>
- <li>
- KDE module subdirs can have interdependencies between them, require a
- particular build order, require another dir to be present even if it does
- not have to be installed, and so forth. We put a lot of work into the split
- ebuilds to make them work properly in this regard. DO_NOT_COMPILE is not
- nearly a fine enough tool to achieve the same results, even given
- sufficient knowledge on the user's part. The only thing you can do with it
- is disable a few applications from compiling. It is practically impossible
- to use it to install only a few selected applications from modules like
- <c>kdebase</c> or <c>kdepim</c>.
- </li>
- <li>
- If I installed kmail yesterday and want to add korn today, using
- DO_NOT_COMPILE, it entails recompiling kmail as well. This means
- DO_NOT_COMPILE is always much slower than split ebuilds.
- </li>
- <li>
- DO_NOT_COMPILE can't be used to make precompiled packages (such as the GRP)
- containing individual KDE apps.
- </li>
-</ul>
-
-</body>
-</section>
-<section>
-<title>Aren't you putting too big a load on the Gentoo KDE maintainers?</title>
-<body>
-
-<p>
-Surprisingly, this question gets asked a lot. I'm glad users are so
-considerate of us maintainers. Let me take this opportunity to assure you that
-we're taking on the split ebuilds of our own free will; that we believe we'll
-be able to continue maintaining them well; and that there's no chance of
-talking us out of it :-)
-</p>
-
-<p>
-For completeness' sake, I should mention that maintainers from other archs
-have in fact complained about the increased workload of testing and keywording
-so many separate ebuilds. We're working to resolve this and it's a major reason
-why monolithic ebuilds are in fact still available for KDE 3.5.
-</p>
-
-</body>
-</section>
-<section>
-<title>Are you going to remove the old-style (monolithic) ebuilds?</title>
-<body>
-
-<p>
-We intend to do so eventually. However, there will be both monolithic and split
-ebuilds for all the KDE 3.x releases.
-</p>
-
-<p>
-If you prefer the monolithic ebuilds over the split ones, please
-<uri link="http://bugs.gentoo.org">tell us</uri> your reasons.
-</p>
-
-</body>
-</section>
-<section>
-<title>There are too many ebuilds! How am I going to find the one I need?</title>
-<body>
-
-<p>
-Well, first of all, if you know the package you're looking for came with
-kdebase, you can still <c>emerge kdebase-meta</c>, with much the same results
-as if you emerged the monolithic <c>kdebase</c>. So, things haven't actually
-become any worse due to the split ebuilds.
-</p>
-
-<p>
-Of course, all the usual ways of locating a package also apply. How would you
-find your ebuild if it was a Gnome application? As a minimum, you do have to
-know the name of the application you're looking for.
-</p>
-
-<p>
-The situation could, perhaps, be improved by introducing some more -meta
-ebuilds. They are merely lists of dependencies, so they don't cost us anything.
-This hasn't been decided yet. Also, it would be nice to have Portage sets
-functionality before we do this extensively.
-</p>
-
-</body>
-</section>
-<section>
-<title>How can I list/unmerge all split ebuilds derived from a given package?</title>
-<body>
-
-<p>
-The objective here is to list all split kde ebuilds derived from, say, the
-<c>kdebase</c> monolithic ebuild. Once again, the proper implementation (such as <uri
-link="/proj/en/glep/glep-0021.html">GLEP 21</uri>) would make this trivial.
-Today, however, you must become involved in the KDE eclasses' implementation
-details to some degree. So, if you use any of these approaches in a script
-that's not for private use, tell us about it.
-</p>
-
-<p>
-kde-functions.eclass defines functions called get-parent-package() and
-get-child-packages() which do the translation for you. These two functions are
-the correct way to accomplish this task from an ebuild or an external bash
-script. Here is an example:
-</p>
-
-<pre caption="Example usage of the kde-functions functions">
-$ <i>function die() { echo $@; }</i> <comment># called to report errors</comment>
-$ <i>source /usr/portage/eclass/kde-functions.eclass</i>
-$ <i>get-parent-package konqueror</i> <comment># won't work, you must specify full name</comment>
-Package konqueror not found in KDE_DERIVATION_MAP, please report bug <comment># error printed</comment>
-$ <i>get-parent-package kde-base/konqueror</i> <comment># fully qualified package name</comment>
-kde-base/kdebase <comment># result printed</comment>
-$ <i>get-child-packages kde-base/kdebase</i>
-<comment>(Long list of packages printed here)</comment>
-</pre>
-
-<p>
-If your script isn't in bash, you can grep kde-functions.eclass to extract the
-(multiline) definition of the variable KDE_DERIVATION_MAP, which the
-aforementioned functions use. This variable contains a whitespace-separated
-list of words, and each two consecutive words map a parent package to a child
-split ebuild.
+This document was moved to <uri>/proj/en/desktop/kde/kde-split-ebuilds.xml</uri>
</p>
</body>
--
gentoo-doc-cvs@lists.gentoo.org mailing list
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2008-04-26 19:21 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2008-04-26 19:21 [gentoo-doc-cvs] cvs commit: metadoc.xml kde-config.xml kde-split-ebuilds.xml Xavier Neys
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox