Codebase list gnome-user-docs / f06328c
Improve favorite-applications, dconf-profiles, add markup & navigation Petr Kovar authored 5 years ago Petr Kovář committed 5 years ago
23 changed file(s) with 155 addition(s) and 103 deletion(s). Raw diff Collapse all Expand all
1010 <link xref="desktop-shield">Change the lock screen shield</link>,
1111 <link xref="desktop-favorite-applications">default favorite
1212 applications</link>,
13 <link xref="desktop-lockscreen">lock the screen when user is idle</link>…
13 <link xref="desktop-lockscreen">lock the screen when idle</link>…
1414 </desc>
1515
1616 </info>
7777 </p>
7878 <p>Below is a sample <file><var>filename</var>.xml</file> file:</p>
7979
80 <code><![CDATA[
80 <code mime="application/xml"><![CDATA[
8181 <?xml version="1.0" encoding="UTF-8"?>
8282 <!DOCTYPE wallpapers SYSTEM "gnome-wp-list.dtd">
8383 <wallpapers>
111111 <p>See the following example with two <code>&lt;wallpaper&gt;</code> elements,
112112 adding two different backgrounds:</p>
113113
114 <code><![CDATA[
114 <code mime="application/xml"><![CDATA[
115115 <?xml version="1.0" encoding="UTF-8"?>
116116 <!DOCTYPE wallpapers SYSTEM "gnome-wp-list.dtd">
117117 <wallpapers>
66 <link type="guide" xref="setup" />
77 <link type="seealso" xref="dconf-custom-defaults" />
88 <link type="seealso" xref="dconf" />
9 <revision pkgversion="3.30" date="2019-02-08" status="incomplete"/>
9 <revision pkgversion="3.30" date="2019-02-22" status="incomplete"/>
1010
1111 <credit type="author copyright">
1212 <name>Ryan Lortie</name>
5858 <title>Sample profile</title>
5959 <code its:translate="no">
6060 user-db:user
61 system-db:<input>local</input>
62 system-db:<input>site</input>
61 system-db:<var>local</var>
62 system-db:<var>site</var>
6363 </code>
6464 </listing>
6565 </example>
6767 <!-- TODO: explain the profile syntax (maybe new page) -->
6868 <!--TODO: explain local and site -->
6969
70 <p>Configuring a single user and multiple system databases allows for layering
71 of preferences. Settings from the <code>user</code> database file take
72 precedence over the settings in the <code>local</code> database file, and the
73 <code>local</code> database file in turn takes precedence over the
74 <code>site</code> database file.</p>
75
76 <p>However, the order of precedence for <link xref="dconf-lockdown">locks</link>
77 is reversed. Locks introduced in the <code>site</code> or <code>local</code>
78 database files take priority over those present in <code>user</code>.</p>
79
7080 <note style="important">
7181 <p>The <sys>dconf</sys> profile for a session is determined at login, so users
7282 will have to log out and log in to apply a new <sys>dconf</sys> user profile
7383 to their session.</p>
7484 </note>
85
86 <p>For more information, see the <link its:translate="no" href="man:dconf(7)">
87 <cmd>dconf</cmd>(7)</link> man page.</p>
7588
7689 <section id="dconf-profiles">
7790
87100 <sys>dconf</sys> attempts to open the profile named “user”. If that
88101 fails, it will fall back to an internal hard-wired configuration.</p>
89102
103 <p>For more information, see the <link its:translate="no" href="man:dconf(7)">
104 <cmd>dconf</cmd>(7)</link> man page.</p>
105
90106 </section>
91107
92108 </page>
44
55 <info>
66 <link type="guide" xref="appearance" />
7 <link type="seealso" xref="backgrounds-extra" />
78 <revision pkgversion="3.11" date="2014-01-29" status="draft"/>
89 <revision pkgversion="3.14" date="2014-06-17" status="incomplete">
910 <desc>All prose and instructions are up to par. Extra info needs
44
55 <info>
66 <link type="guide" xref="appearance"/>
7 <revision pkgversion="3.8" date="2013-04-28" status="draft"/>
7 <revision pkgversion="3.30" date="2019-02-22" status="review"/>
88
99 <credit type="author">
1010 <name>Aruna Sankaranarayanan</name>
1111 <email>aruna.evam@gmail.com</email>
1212 </credit>
13 <credit type="editor">
14 <name>Petr Kovar</name>
15 <email>pknbe@volny.cz</email>
16 <years>2019</years>
17 </credit>
1318
1419 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
1520
16 <desc>Customize the default favourites in the Activities overview.</desc>
21 <desc>Customize the default favorites in the Activities overview.</desc>
1722
1823 </info>
1924
20 <title>Default favorite applications</title>
25 <title>Set default favorite applications</title>
2126
22 <p>Favorite applications are those visible on the
23 <link href="help:gnome-help/shell-terminology">dash</link>. You can use
24 <sys its:translate="no">dconf</sys> to set favorite applications
27 <p>Favorite applications are those visible on the GNOME Shell
28 <link href="help:gnome-help/shell-introduction#activities">dash</link>.
29 You can use <sys its:translate="no">dconf</sys> to set favorite applications
2530 for one user, or to set the same favorite applications
2631 for all users. For both cases, you must first edit the
2732 <sys its:translate="no">dconf</sys> profile found in
3439 their user database file found in
3540 <file its:translate="no">~/.config/dconf/user</file>. The following example
3641 snippet uses <sys its:translate="no">dconf</sys> to set <app>gedit</app>,
37 <app>Terminal</app> and <app>Nautilus</app> as default favorites for a user.
38 The example code allows users to modify the list later, if they wish to do
39 so.</p>
40
41 <!--The code itself need not be translated but the comments withing the
42 code have to be translated.-Aruna-->
42 <app>Terminal</app> and <app>Files</app> (<sys>nautilus</sys>) as default
43 favorites for a user. The example code allows users to modify the list later,
44 if they wish to do so.</p>
4345
4446 <listing>
4547 <title>Contents of <file its:translate="no">/etc/dconf/profile</file>:</title>
46 <code>
47 #This line allows the user to change the default favorites later.
48 user-db:user
49 </code>
48 <code its:translate="no">
49 # <span its:translate="yes">This line allows the user to change the default favorites later</span>
50 user-db:user
51 </code>
5052 </listing>
5153
5254 <listing>
5355 <title>Contents of <file its:translate="no">~/.config/dconf/user</file>:</title>
54 <code>
55 #Set gedit, terminal and nautilus as default favorites
56 [org/gnome/shell]
57 favorite-apps = [<input>'gedit.desktop'</input>, <input>'gnome-terminal.desktop'</input>, <input>'nautilus.desktop'</input>]
58 </code>
56 <code its:translate="no">
57 # <span its:translate="yes">Set gedit, terminal and nautilus as default favorites</span>
58 [org/gnome/shell]
59 favorite-apps = [<var>'gedit.desktop'</var>, <var>'gnome-terminal.desktop'</var>, <var>'nautilus.desktop'</var>]
60 </code>
5961 </listing>
6062
6163 <note style="tip">
7072
7173 <p>In order to have the same favorites for all users, you must modify system
7274 database files using <link xref="dconf-keyfiles">dconf keyfiles</link>. The
73 following code snippets edit the <sys its:translate="no">dconf</sys> profile
75 following steps edit the <sys its:translate="no">dconf</sys> profile
7476 and then create a keyfile to set default favorite applications for all
75 employees in the first floor of an organization.</p>
77 users in the <code>local</code> configuration database.</p>
7678
77 <!--The code itself need not be translated but the comments within the
78 code have to be translated.-Aruna-->
79
80 <listing>
81 <title>Contents of <file its:translate="no">/etc/dconf/profile</file>:</title>
82 <code>
83 user-db:user
84
85 #This line defines a system database file called first_floor
86 system-db:first_floor
87 </code>
88 </listing>
89
90 <note style="info">
91 <p>Settings from the <code>user</code> database file
92 will take precedence over the settings in the
93 <code>first_floor</code> database file, but
94 <link xref="dconf-lockdown">locks</link> introduced in the
95 <code>first_floor</code> database file will take priority over
96 those present in <code>user</code>.</p>
97 </note>
98
99 <listing>
100 <title>Contents of <file its:translate="no">/etc/dconf/db/first_floor.d/00_floor1_settings</file>:</title>
101 <code>
102 # Snippet sets gedit, terminal and nautilus as default favorites
103 # for all users in the first floor
104
105 [org/gnome/shell]
106 favorite-apps = [<input>'gedit.desktop'</input>, <input>'gnome-terminal.desktop'</input>, <input>'nautilus.desktop'</input>]
107 </code>
108 </listing>
109
110 <p>Incorporate your changes into the system databases by running
111 <cmd>dconf update</cmd>.</p>
79 <steps>
80 <title>Set the favorite applications</title>
81 <include href="dconf-snippets.xml"
82 xpointer="xpointer(/*/*[@xml:id='dconf-profile-user'])"
83 xmlns="http://www.w3.org/2001/XInclude"/>
84 <include href="dconf-snippets.xml"
85 xpointer="xpointer(/*/*[@xml:id='dconf-profile-user-dir'])"
86 xmlns="http://www.w3.org/2001/XInclude"/>
87 <item>
88 <p>Create the key file
89 <file>/etc/dconf/db/local.d/00-favorite-apps</file> to provide
90 information for the <sys>local</sys> database.</p>
91 <listing>
92 <title>Contents of
93 <file its:translate="no">/etc/dconf/db/local.d/00-favorite-apps</file>:
94 </title>
95 <code>
96 # Snippet sets gedit, terminal and nautilus as default favorites for all users
97 [org/gnome/shell]
98 favorite-apps = [<var>'gedit.desktop'</var>, <var>'gnome-terminal.desktop'</var>, <var>'nautilus.desktop'</var>]
99 </code>
100 </listing>
101 </item>
102 <item>
103 <p>To prevent the user from overriding these settings, create the file
104 <file>/etc/dconf/db/local.d/locks/favorite-apps</file> with the following
105 content:</p>
106 <listing>
107 <title><file>/etc/dconf/db/local.db/locks/favorite-apps</file></title>
108 <code>
109 # Lock default favorite applications
110 /org/gnome/shell/favorite-apps
111 </code>
112 </listing>
113 </item>
114 <include href="dconf-snippets.xml"
115 xpointer="xpointer(/*/*[@xml:id='dconf-update'])"
116 xmlns="http://www.w3.org/2001/XInclude"/>
117 <include href="dconf-snippets.xml"
118 xpointer="xpointer(/*/*[@xml:id='dconf-logoutin'])"
119 xmlns="http://www.w3.org/2001/XInclude"/>
120 </steps>
112121
113122 </section>
114123
2828 enter a password after being idle.</desc>
2929 </info>
3030
31 <title>Lock the screen when user is idle</title>
31 <title>Lock the screen when the user is idle</title>
3232
33 <p>You can make the screen lock automatically whenever a user
34 is idle for some amount of time. This is useful if your users
33 <p>You can make the screen lock automatically whenever the user
34 is idle for some amount of time. This is useful if users
3535 may leave their computers unattended in public or unsecure
3636 locations.</p>
3737
99 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
1010
1111 <desc>A guide for GNOME 3 system administrators</desc>
12
1213 </info>
1314
1415 <title>GNOME System Administration Guide</title>
8585 <p>Add the layout codes to
8686 <file>/usr/share/X11/xorg.conf.d/10-evdev.conf</file> in the following
8787 way:</p>
88 <screen>
89 Section "InputClass"
90 Identifier "evdev keyboard catchall"
91 MatchIsKeyboard "on"
92 MatchDevicePath "/dev/input/event*"
93 Driver "evdev"
94 <input>Option "XkbLayout" "en,fr"</input>
95 EndSection
96 </screen>
88 <screen>
89 Section "InputClass"
90 Identifier "evdev keyboard catchall"
91 MatchIsKeyboard "on"
92 MatchDevicePath "/dev/input/event*"
93 Driver "evdev"
94 <input>Option "XkbLayout" "en,fr"</input>
95 EndSection
96 </screen>
9797 <p>Multiple layouts can be added as a comma separated list, as shown in
9898 the example for English (<sys>en</sys>) and French (<sys>fr</sys>)
9999 layouts.</p>
44
55 <info>
66 <link type="guide" xref="user-settings#lockdown"/>
7 <link type="guide" xref="sundry#session"/>
78 <link type="seealso" xref="lockdown-printing" />
89 <link type="seealso" xref="lockdown-file-saving" />
910 <link type="seealso" xref="lockdown-repartitioning" />
1011 <link type="seealso" xref="lockdown-command-line" />
1112 <link type="seealso" xref="login-automatic" />
13 <link type="seealso" xref="session-custom" />
14 <link type="seealso" xref="session-user" />
1215
1316 <revision pkgversion="3.30" date="2019-02-08" status="review"/>
1417
3235
3336 <desc>Set up a kiosk-like, single-application system.</desc>
3437 </info>
35
38
3639 <title>Configure single-application mode</title>
3740
3841 <p>Single-application mode is a modified GNOME Shell which configures the
44
55 <info>
66 <link type="guide" xref="login#appearance"/>
7 <link type="seealso" xref="login-banner"/>
78 <!--<link type="seealso" xref="gdm-restart"/>-->
89 <revision pkgversion="3.11" date="2014-01-29" status="draft"/>
910
88 <desc>
99 <link xref="login-userlist-disable">Disable the user list</link>,
1010 <link xref="session-user">configure a user default session</link>,
11 <link xref="login-automatic">configure automatic login</link>…
11 <link xref="login-automatic">automatic login</link>…
1212 </desc>
1313
1414 </info>
77 <link type="seealso" xref="mime-types-custom" />
88 <revision pkgversion="3.30" date="2019-02-08" status="review"/>
99
10 <credit type="author">
10 <credit type="author copyright">
1111 <name>Petr Kovar</name>
1212 <email>pknbe@volny.cz</email>
13 <years>2014</years>
1314 </credit>
1415
1516 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
1617
18 <desc>Customize per user which application opens a specific MIME type.
19 </desc>
1720 </info>
1821
1922 <title>Override the default registered application for individual users</title>
88 <link type="seealso" xref="mime-types-custom" />
99 <revision pkgversion="3.30" date="2019-02-08" status="review"/>
1010
11 <credit type="author">
11 <credit type="author copyright">
1212 <name>Petr Kovar</name>
1313 <email>pknbe@volny.cz</email>
14 <years>2014</years>
1415 </credit>
1516
1617 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
1718
19 <desc>Customize which application opens a specific MIME type.</desc>
1820 </info>
1921
2022 <title>Override the default registered application for all users</title>
66 <link type="seealso" xref="mime-types" />
77 <revision pkgversion="3.12" date="2014-06-17" status="review"/>
88
9 <credit type="author">
9 <credit type="author copyright">
1010 <name>Petr Kovar</name>
1111 <email>pknbe@volny.cz</email>
12 <years>2014</years>
1213 </credit>
1314
1415 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
1516
17 <desc>Create a user's MIME type specification and register a default
18 application.</desc>
1619 </info>
1720
1821 <title>Add a custom MIME type for individual users</title>
77 <link type="seealso" xref="mime-types-custom-user" />
88 <revision pkgversion="3.12" date="2014-06-17" status="review"/>
99
10 <credit type="author">
10 <credit type="author copyright">
1111 <name>Petr Kovar</name>
1212 <email>pknbe@volny.cz</email>
13 <years>2014</years>
1314 </credit>
1415
1516 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
1617
18 <desc>Create a MIME type specification and register a default
19 application.</desc>
1720 </info>
1821
1922 <title>Add a custom MIME type for all users</title>
88 <link type="seealso" xref="mime-types-custom-user" />
99 <revision pkgversion="3.12" date="2014-06-17" status="review"/>
1010
11 <credit type="author">
11 <credit type="author copyright">
1212 <name>Petr Kovar</name>
1313 <email>pknbe@volny.cz</email>
14 <years>2014</years>
1415 </credit>
1516
1617 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
33 id="network-printer-config">
44
55 <info>
6 <link type="guide" xref="network" />
7 <revision pkgversion="3.8" date="2013-03-19" status="draft"/>
6 <link type="guide" xref="network" />
7 <revision pkgversion="3.30" date="2019-02-22" status="review"/>
88
99 <credit type="author copyright">
1010 <name>Jana Svarova</name>
1111 <email>jana.svarova@gmail.com</email>
1212 <years>2013</years>
1313 </credit>
14 <credit type="editor">
15 <name>Petr Kovar</name>
16 <email>pknbe@volny.cz</email>
17 <years>2019</years>
18 </credit>
1419
1520 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
1621
17 <desc>How do I preconfigure my Samba printer</desc>
22 <desc>How do I configure a Samba printer?</desc>
1823 </info>
1924
20 <title>Configure a printer</title>
25 <title>Configure a network printer</title>
2126
22 <comment>
23 <cite date="2013-03-19" href="mailto:jsvarova@gmail.com">Jana Svarova</cite>
24 <p>Adapted from GNOME Bugzilla – Bug 694569</p>
25 </comment>
26
27 <p>This topic explains how to make printers, Windows printers in particular,
28 available in GNOME.</p>
27 <p>This topic explains how to make network printers, Windows printers in
28 particular, available in GNOME.</p>
2929
3030 <p>There is no preconfiguration needed for being able to install Samba
31 printers using gnome-control-center. To add a new Samba printer to your CUPS
32 (Common UNIX Printing System) server, simply follow the steps below.</p>
31 printers using <app>GNOME Settings</app>. To add a new Samba printer to your
32 CUPS (Common UNIX Printing System) server, simply follow the steps below.</p>
3333
3434 <steps>
3535 <title>Configure your printer</title>
88
99 <desc>
1010 <link xref="network-server-list">Configure a default server list</link>,
11 <link xref="network-printer-config">configure a printer</link>,
11 <link xref="network-printer-config">a network printer</link>,
1212 <link xref="network-vpn">default VPN settings</link>…
1313 </desc>
1414
1515 </info>
1616
17 <title>Network &amp; Hardware</title>
17 <title>Network &amp; hardware</title>
18
1819 </page>
55
66 <info>
77 <link type="guide" xref="software#management" />
8 <link type="guide" xref="sundry#session"/>
89 <revision pkgversion="3.12" date="2014-06-17" status="review"/>
910
1011 <credit type="author copyright">
22 id="setup">
33
44 <info>
5
56 <link type="guide" xref="index" group="#first"/>
67
78 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
9
10 <desc>User and system settings management</desc>
11
812 </info>
913
1014 <title>Setup</title>
77 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
88
99 <desc>
10 <link xref="extensions">What are GNOME Shell extensions?</link>,
11 <link xref="mime-types">what are MIME types?</link>,
12 <link xref="mime-types-application">override the default registered
13 application for all users</link>…
10 <link xref="extensions">GNOME Shell extensions</link>,
11 <link xref="mime-types">MIME types</link>,
12 <link xref="mime-types-application">override default applications</link>…
1413 </desc>
1514
1615 </info>
22 id="sundry">
33
44 <info>
5
56 <link type="guide" xref="index" group="#last"/>
67
78 <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
9
10 <desc>Session management and troubleshooting</desc>
11
812 </info>
913
1014 <title>Other</title>
1515
1616 </info>
1717
18 <title>User Settings</title>
18 <title>User settings</title>
1919
2020 <!--<section id="default">
2121 <title>Pre-seed user defaults</title>