isa/gnome-shell
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
6272490b0d
gnome-shell/man/gnome-shell.xml

166 lines
6.6 KiB
XML
Raw Normal View History

Convert man page to Docbook This make it easier to update the content and to transform the man page into other output formats, like HTML. https://bugzilla.gnome.org/show_bug.cgi?id=680601
2012-07-25 02:00:55 +00:00
<?xml version='1.0'?>
docs: Unify on single DocBook version DocBook 4.5 is backwards compatible. https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/1464
2020-10-13 00:58:16 +00:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
Convert man page to Docbook This make it easier to update the content and to transform the man page into other output formats, like HTML. https://bugzilla.gnome.org/show_bug.cgi?id=680601
2012-07-25 02:00:55 +00:00
<refentry id="gnome-shell">
<refentryinfo>
<title>gnome-shell</title>
<productname>gnome-shell</productname>
<authorgroup>
<author>
<contrib>wrote the original gnome-shell man page</contrib>
<firstname>Marcelo Jorge</firstname>
<surname>Vieira</surname>
<email>metal@alucinados.com</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>gnome-shell</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>gnome-shell</refname>
<refpurpose>Graphical shell for the GNOME desktop</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>gnome-shell <arg choice="opt" rep="repeat">OPTION</arg></command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>GNOME shell provides core user
interface functions for the GNOME 3 desktop, like switching
to windows and launching applications. GNOME shell takes
advantage of the capabilities of modern graphics hardware
and introduces innovative user interface concepts to provide
a visually attractive and easy to use experience.</para>
Some updates to the man page Mention relevant files, and how gnome-shell gets started in the session. https://bugzilla.gnome.org/show_bug.cgi?id=680601
2012-07-25 02:11:18 +00:00
<para>gnome-shell is a required component of
the GNOME desktop, i.e. it is listed in the
RequiredComponents field of
<filename>/usr/share/gnome-session/sessions/gnome.session</filename>.
It is started in the window manager phase of the session.
</para>
Convert man page to Docbook This make it easier to update the content and to transform the man page into other output formats, like HTML. https://bugzilla.gnome.org/show_bug.cgi?id=680601
2012-07-25 02:00:55 +00:00
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
Some updates to the man page Mention relevant files, and how gnome-shell gets started in the session. https://bugzilla.gnome.org/show_bug.cgi?id=680601
2012-07-25 02:11:18 +00:00
<term><option>-r</option>, <option>--replace</option></term>
Convert man page to Docbook This make it easier to update the content and to transform the man page into other output formats, like HTML. https://bugzilla.gnome.org/show_bug.cgi?id=680601
2012-07-25 02:00:55 +00:00
<listitem><para>Replace the running window manager</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--sm-disable</option></term>
<listitem><para>Disable connection to the session manager</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--sm-client-id=<replaceable>ID</replaceable></option></term>
<listitem><para>Specify session management <replaceable>ID</replaceable></para></listitem>
</varlistentry>
<varlistentry>
<term><option>--sm-save-file=<replaceable>FILE</replaceable></option></term>
<listitem><para>Initialize session from <replaceable>FILE</replaceable></para></listitem>
</varlistentry>
<varlistentry>
<term><option>--screen=<replaceable>SCREEN</replaceable></option></term>
<listitem><para>X screen to use</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option>, <option>--display=<replaceable>DISPLAY</replaceable></option></term>
<listitem><para>X Display to use</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--sync</option></term>
<listitem><para>Make X calls synchronous</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<listitem><para>Print version and exit</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--help</option></term>
<listitem><para>Display help and exit</para></listitem>
</varlistentry>
Some updates to the man page Mention relevant files, and how gnome-shell gets started in the session. https://bugzilla.gnome.org/show_bug.cgi?id=680601
2012-07-25 02:11:18 +00:00
<varlistentry>
<term><option>--mode=<replaceable>MODE</replaceable></option></term>
<listitem><para>Use a specific mode, e.g. "gdm" for login screen</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--list-modes</option></term>
<listitem><para>List possible modes and exit</para></listitem>
</varlistentry>
Document --clutter-display in the man page This is the sole option that was missing from the man page. https://bugzilla.gnome.org/show_bug.cgi?id=700339
2013-05-14 20:20:43 +00:00
<varlistentry>
<term><option>--clutter-display=<replaceable>DISPLAY</replaceable></option></term>
<listitem><para>Clutter the option display (otherwise ignored)</para></listitem>
</varlistentry>
Convert man page to Docbook This make it easier to update the content and to transform the man page into other output formats, like HTML. https://bugzilla.gnome.org/show_bug.cgi?id=680601
2012-07-25 02:00:55 +00:00
</variablelist>
</refsect1>
Some updates to the man page Mention relevant files, and how gnome-shell gets started in the session. https://bugzilla.gnome.org/show_bug.cgi?id=680601
2012-07-25 02:11:18 +00:00
<refsect1>
<title>Files</title>
<para>
<filename>/usr/share/gnome-session/sessions/gnome.session</filename>,
data: merge gnome-shell.desktop and gnome-shell-wayland.desktop into one file We can autodetect what to do based on the user's session, so drop the separate desktop files. This, along with some future changes, will enable us to be bus activatable. https://bugzilla.gnome.org/show_bug.cgi?id=741666
2014-12-17 17:31:38 +00:00
<filename>/usr/share/applications/org.gnome.Shell.desktop</filename>.</para>
Some updates to the man page Mention relevant files, and how gnome-shell gets started in the session. https://bugzilla.gnome.org/show_bug.cgi?id=680601
2012-07-25 02:11:18 +00:00
</refsect1>
Convert man page to Docbook This make it easier to update the content and to transform the man page into other output formats, like HTML. https://bugzilla.gnome.org/show_bug.cgi?id=680601
2012-07-25 02:00:55 +00:00
<refsect1>
<title>Bugs</title>
<para>The bug tracker can be reached by visiting the
website <ulink url="https://bugzilla.gnome.org/buglist.cgi?product=gnome-shell">https://bugzilla.gnome.org/buglist.cgi?product=gnome-shell</ulink>.
Before sending a bug report, please verify that you have
the latest version of gnome-shell. Many bugs (major and
minor) are fixed at each release, and if yours is out of
date, the problem may already have been solved.</para>
</refsect1>
<refsect1>
<title>Additional Information</title>
<para>For further information, visit the website
man: Update project website
2018-01-07 20:39:18 +00:00
<ulink url="https://wiki.gnome.org/Projects/GnomeShell">https://wiki.gnome.org/Projects/GnomeShell</ulink>.</para>
Convert man page to Docbook This make it easier to update the content and to transform the man page into other output formats, like HTML. https://bugzilla.gnome.org/show_bug.cgi?id=680601
2012-07-25 02:00:55 +00:00
</refsect1>
</refentry>
Reference in New Issue Copy Permalink