man-pages/man1/xdg-settings.1.html
2021-03-31 01:06:50 +01:00

262 lines
5.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of XDG-SETTINGS</TITLE>
</HEAD><BODY>
<H1>XDG-SETTINGS</H1>
Section: xdg-settings Manual (1)<BR>Updated: 01/11/2021<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
xdg-settings - get various settings from the desktop environment
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<DL COMPACT>
<DT id="1">
<B>xdg-settings</B> {<B></B><I>get</I> | <B></B><I>check</I> | <B></B><I>set</I>} {<B>property</B>} [<B>subproperty</B>] [<B>value</B>]
<DT id="2">
<B>xdg-settings</B> {<B>--help</B> | <B>--list</B> | <B>--manual</B> | <B>--version</B>}
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<DD>xdg-settings gets various settings from the desktop environment. For instance, desktop environments often provide proxy configuration and default web browser settings. Using xdg-settings these parameters can be extracted for use by applications that do not use the desktop environment's libraries (which would use the settings natively).
<P>
xdg-settings is for use inside a desktop session only. It is not recommended to use xdg-settings as root.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
<B>--help</B>
<DL COMPACT><DT id="3"><DD>
Show command synopsis.
</DL>
<P>
<B>--list</B>
<DL COMPACT><DT id="4"><DD>
List all properties xdg-settings knows about.
</DL>
<P>
<B>--manual</B>
<DL COMPACT><DT id="5"><DD>
Show this manual page.
</DL>
<P>
<B>--version</B>
<DL COMPACT><DT id="6"><DD>
Show the xdg-utils version information.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>PROPERTIES</H2>
<P>
When using xdg-settings to get, check or set a desktop setting, properties and possibly sub-properties are used to specify the setting to be changed.
<P>
Some properties (such as default-web-browser) fully describe the setting to be changed. Other properties (such as default-url-scheme-handler) require more information (in this case the actual scheme to set the default handler for) which must be provided in a sub-property.
<A NAME="lbAG">&nbsp;</A>
<H2>EXIT CODES</H2>
<P>
An exit code of 0 indicates success while a non-zero exit code indicates failure. The following failure codes can be returned:
<P>
<B>1</B>
<DL COMPACT><DT id="7"><DD>
Error in command line syntax.
</DL>
<P>
<B>2</B>
<DL COMPACT><DT id="8"><DD>
One of the files passed on the command line did not exist.
</DL>
<P>
<B>3</B>
<DL COMPACT><DT id="9"><DD>
A required tool could not be found.
</DL>
<P>
<B>4</B>
<DL COMPACT><DT id="10"><DD>
The action failed.
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+xdg-mime">xdg-mime</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?1+xdg-open">xdg-open</A></B>(1),
m[blue]<B>MIME applications associations specification</B>m[]<FONT SIZE="-2">[1]</FONT>
<A NAME="lbAI">&nbsp;</A>
<H2>EXAMPLES</H2>
<P>
Get the desktop file name of the current default web browser
<P>
<DL COMPACT><DT id="11"><DD>
<PRE>
xdg-settings get default-web-browser
</PRE>
</DL>
<P>
Check whether the default web browser is firefox.desktop, which can be false even if &quot;get default-web-browser&quot; says that is the current value (if only some of the underlying settings actually reflect that value)
<P>
<DL COMPACT><DT id="12"><DD>
<PRE>
xdg-settings check default-web-browser firefox.desktop
</PRE>
</DL>
<P>
Set the default web browser to google-chrome.desktop
<P>
<DL COMPACT><DT id="13"><DD>
<PRE>
xdg-settings set default-web-browser google-chrome.desktop
</PRE>
</DL>
<P>
Set the default mailto URL scheme handler to be evolution.desktop
<P>
<DL COMPACT><DT id="14"><DD>
<PRE>
xdg-settings set default-url-scheme-handler mailto evolution.desktop
</PRE>
</DL>
<P>
<A NAME="lbAJ">&nbsp;</A>
<H2>AUTHOR</H2>
<P>
<B>Mike Mammarella</B>
<DL COMPACT><DT id="15"><DD>
Author.
</DL>
<A NAME="lbAK">&nbsp;</A>
<H2>COPYRIGHT</H2>
<BR>
Copyright &#169; 2009-2011
<BR>
<A NAME="lbAL">&nbsp;</A>
<H2>NOTES</H2>
<DL COMPACT>
<DT id="16"> 1.<DD>
MIME applications associations specification
<DL COMPACT><DT id="17"><DD>
<A HREF="http://www.freedesktop.org/wiki/Specifications/mime-apps-spec/">http://www.freedesktop.org/wiki/Specifications/mime-apps-spec/</A>
</DL>
<P>
</DL>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="18"><A HREF="#lbAB">NAME</A><DD>
<DT id="19"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="20"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="21"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="22"><A HREF="#lbAF">PROPERTIES</A><DD>
<DT id="23"><A HREF="#lbAG">EXIT CODES</A><DD>
<DT id="24"><A HREF="#lbAH">SEE ALSO</A><DD>
<DT id="25"><A HREF="#lbAI">EXAMPLES</A><DD>
<DT id="26"><A HREF="#lbAJ">AUTHOR</A><DD>
<DT id="27"><A HREF="#lbAK">COPYRIGHT</A><DD>
<DT id="28"><A HREF="#lbAL">NOTES</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:30 GMT, March 31, 2021
</BODY>
</HTML>