luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-10-31 19:46:16 +01:00
Code Issues Packages Projects Releases Wiki Activity
147777e342
glib/docs/reference/gio/gio.xml

810 lines
37 KiB
XML
Raw Normal View History

Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="gio">
<refentryinfo>
<title>gio</title>
<productname>GIO</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Matthias</firstname>
<surname>Clasen</surname>
<email>mclasen@redhat.com</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>gio</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gio</refname>
<refpurpose>GIO commandline tool</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">help</arg>
<arg choice="opt"><replaceable>COMMAND</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">version</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">cat</arg>
<arg choice="plain" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">copy</arg>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>SOURCE</replaceable></arg>
<arg choice="plain"><replaceable>DESTINATION</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">info</arg>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</cmdsynopsis>
Add gio launch command to execute desktop file This command will try to execute a desktop file, before that it will load the input as a keyfile for checking its existence and its validity (as a keyfile). File arguments are allowed after the desktop file. Closes #54 Signed-off-by: Frederic Martinsons <frederic.martinsons@sigfox.com>
2020-12-03 10:42:47 +01:00
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">launch</arg>
<arg choice="plain"><replaceable>DESKTOP-FILE</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>FILE-ARG</replaceable></arg>
</cmdsynopsis>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">list</arg>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">mime</arg>
<arg choice="plain"><replaceable>MIMETYPE</replaceable></arg>
<arg choice="opt"><replaceable>HANDLER</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">mkdir</arg>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">monitor</arg>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">mount</arg>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">move</arg>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>SOURCE</replaceable></arg>
<arg choice="plain"><replaceable>DESTINATION</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">open</arg>
<arg choice="plain" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">rename</arg>
<arg choice="plain"><replaceable>LOCATION</replaceable></arg>
<arg choice="plain"><replaceable>NAME</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">remove</arg>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">save</arg>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain"><replaceable>DESTINATION</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">set</arg>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain"><replaceable>LOCATION</replaceable></arg>
<arg choice="plain"><replaceable>ATTRIBUTE</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>VALUE</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">trash</arg>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>gio</command>
<arg choice="plain">tree</arg>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><command>gio</command> is a utility that makes many of the GIO
features available from the commandline. In doing so, it provides
commands that are similar to traditional utilities, but let you
use GIO locations instead of local files: for example you can use
something like <filename>smb://server/resource/file.txt</filename>
docs: Fix some minor wording problems in the gio documentation And some missing apostrophes. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:17:49 +01:00
as a location.</para>
docs: Mention handling of filenames containing colons in gio docs Signed-off-by: Philip Withnall <withnall@endlessm.com> https://gitlab.gnome.org/GNOME/glib/issues/1623
2018-12-19 13:24:17 +01:00
<para>Plain filenames which contain a colon will be interpreted as URIs
with an unknown protocol. To avoid this, prefix them with a path such as
<filename>./</filename>, or with the <literal>file:</literal> protocol.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</refsect1>
<refsect1>
<title>Commands</title>
<variablelist>
<varlistentry>
<term>
<command>help</command>
<arg choice="opt"><replaceable>COMMAND</replaceable></arg>
</term>
<listitem>
<para>Displays a short synopsis of the available commands or provides
detailed help on a specific command.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>version</command>
</term>
<listitem>
<para>Prints the GLib version to which <command>gio</command>
belongs.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>cat</command>
<arg choice="plain" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</term>
<listitem>
<para>Concatenates the given files and prints them to the standard
output.</para>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>The <command>cat</command> command works just like the traditional <command>cat</command> utility.</para>
<para>Note: just pipe through <command>cat</command> if you need its formatting options
like <option>-n</option>, <option>-T</option> or other.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>copy</command>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>SOURCE</replaceable></arg>
<arg choice="plain"><replaceable>DESTINATION</replaceable></arg>
</term>
<listitem>
<para>Copies one or more files from <replaceable>SOURCE</replaceable>
to <replaceable>DESTINATION</replaceable>. If more than one source
is specified, the destination must be a directory.</para>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>The <command>copy</command> command is similar to the traditional <command>cp</command> utility.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<refsect3>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-T</option>, <option>--no-target-directory</option></term>
docs: Use Unicode apostrophes in gio documentation Let’s move into the 21st century. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:20:01 +01:00
<listitem><para>Don’t copy into <replaceable>DESTINATION</replaceable> even if it is a directory.</para></listitem>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</varlistentry>
<varlistentry>
<term><option>-p</option>, <option>--progress</option></term>
<listitem><para>Show progress.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-i</option>, <option>--interactive</option></term>
<listitem><para>Prompt for confirmation before overwriting files.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--preserve</option></term>
<listitem><para>Preserve all attributes of copied files.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-b</option>, <option>--backup</option></term>
<listitem><para>Create backups of existing destination files.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-P</option>, <option>--no-dereference</option></term>
<listitem><para>Never follow symbolic links.</para></listitem>
</varlistentry>
gio-tool: Add a --default-permissions argument to `gio copy` This sets the `G_FILE_COPY_DEFAULT_PERMS` flag on the operation, creating the copied file with default permissions rather than the same permissions as the source file. Signed-off-by: Philip Withnall <withnall@endlessm.com> Fixes: #174
2019-09-27 18:24:36 +02:00
<varlistentry>
<term><option>--default-permissions</option></term>
<listitem><para>Use the default permissions of the current process for the destination file, rather than copying the permissions of the source file.</para></listitem>
</varlistentry>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</variablelist>
</refsect3>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>info</command>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</term>
<listitem>
<para>Shows information about the given locations.</para>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>The <command>info</command> command is similar to the traditional <command>ls</command> utility.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<refsect3>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-w</option>, <option>--query-writable</option></term>
<listitem><para>List writable attributes.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option>, <option>--filesystem</option></term>
<listitem><para>Show information about the filesystem that the given
locations reside on.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-a</option> <option>--attributes=<replaceable>ATTRIBUTES</replaceable></option></term>
<listitem><para>The attributes to get.</para>
<para>Attributes can be specified with their GIO name, e.g.
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<literal>standard::icon</literal>, or just by namespace, e.g. <literal>unix</literal>, or by <literal>*</literal>,
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
which matches all attributes. Several attributes or groups
of attributes can be specified, separated by comma.</para>
<para>By default, all attributes are listed.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option>, <option>--nofollow-symlinks</option></term>
docs: Use Unicode apostrophes in gio documentation Let’s move into the 21st century. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:20:01 +01:00
<listitem><para>Don’t follow symbolic links.</para></listitem>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</varlistentry>
</variablelist>
</refsect3>
</listitem>
</varlistentry>
Add gio launch command to execute desktop file This command will try to execute a desktop file, before that it will load the input as a keyfile for checking its existence and its validity (as a keyfile). File arguments are allowed after the desktop file. Closes #54 Signed-off-by: Frederic Martinsons <frederic.martinsons@sigfox.com>
2020-12-03 10:42:47 +01:00
<varlistentry>
<term>
<command>launch</command>
<arg choice="plain"><replaceable>DESKTOP-FILE</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>FILE-ARG</replaceable></arg>
</term>
<listitem>
<para>Launch a desktop file from any location given.</para>
<para>The <command>launch</command> command extends the behavior of the <command>open</command> command by allowing
any desktop file to be launched, not only those registered as file handlers.</para>
</listitem>
</varlistentry>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<varlistentry>
<term>
<command>list</command>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</term>
<listitem>
<para>Lists the contents of the given locations. If no location is
given, the contents of the current directory are shown.</para>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>The <command>list</command> command is similar to the traditional <command>ls</command> utility.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<refsect3>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-a</option> <option>--attributes=<replaceable>ATTRIBUTES</replaceable></option></term>
<listitem><para>The attributes to get.</para>
<para>Attributes can be specified with their GIO name, e.g.
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<literal>standard::icon</literal>, or just by namespace, e.g. <literal>unix</literal>, or by <literal>*</literal>,
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
which matches all attributes. Several attributes or groups
of attributes can be specified, separated by comma.</para>
<para>By default, all attributes are listed.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>, <option>--hidden</option></term>
<listitem><para>Show hidden files.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-l</option>, <option>--long</option></term>
<listitem><para>Use a long listing format.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option>, <option>--nofollow-symlinks</option></term>
docs: Use Unicode apostrophes in gio documentation Let’s move into the 21st century. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:20:01 +01:00
<listitem><para>Don’t follow symbolic links.</para></listitem>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</varlistentry>
docs: Mention new gio tool options New features were added for gio tool, but they are not mentioned in man pages as it is not generated from GOptionEntry in contrast to the help output. Let's update the man pages to reflect the recent changes.
2020-04-02 10:45:11 +02:00
<varlistentry>
<term><option>-d</option>, <option>--print-display-names</option></term>
<listitem><para>Print display names.</para></listitem>
</varlistentry>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<varlistentry>
<term><option>-u</option>, <option>--print-uris</option></term>
<listitem><para>Print full URIs.</para></listitem>
</varlistentry>
</variablelist>
</refsect3>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>mime</command>
<arg choice="plain"><replaceable>MIMETYPE</replaceable></arg>
<arg choice="opt"><replaceable>HANDLER</replaceable></arg>
</term>
<listitem>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>If no handler is given, the <command>mime</command> command lists the
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
registered and recommended applications for the mimetype.
If a handler is given, it is set as the default handler for
the mimetype.</para>
<para>Handlers must be specified by their desktop file name,
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
including the extension. Example: <literal>org.gnome.gedit.desktop</literal>.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>mkdir</command>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</term>
<listitem>
<para>Creates directories.</para>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>The <command>mkdir</command> command is similar to the traditional <command>mkdir</command> utility.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<refsect3>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-p</option>, <option>--parent</option></term>
<listitem><para>Create parent directories when necessary.</para></listitem>
</varlistentry>
</variablelist>
</refsect3>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>monitor</command>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</term>
<listitem>
<para>Monitors files or directories for changes, such as creation
deletion, content and attribute changes, and mount and unmount
operations affecting the monitored locations.</para>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>The <command>monitor</command> command uses the GIO file monitoring APIs to do
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
its job. GIO has different implementations for different platforms.
The most common implementation on Linux uses inotify.</para>
<refsect3>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-d</option>, <option>--dir=<replaceable>LOCATION</replaceable></option></term>
<listitem><para>Monitor the given location as a directory. Normally,
the file type is used to determine whether to monitor a file or directory.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option>, <option>--file=<replaceable>LOCATION</replaceable></option></term>
<listitem><para>Monitor the given location as a file. Normally,
the file type is used to determine whether to monitor a file or directory.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-D</option>, <option>--direct=<replaceable>LOCATION</replaceable></option></term>
Spelling: avoid the "allows to" pattern This is detected by Debian's Lintian tool, which suggests "allows one to" as a replacement. I've rephrased the documentation in question to avoid both of those. Signed-off-by: Simon McVittie <smcv@collabora.com>
2018-09-25 16:56:47 +02:00
<listitem><para>Monitor the file directly. This allows changes made via hardlinks to be captured.</para></listitem>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</varlistentry>
<varlistentry>
<term><option>-s</option>, <option>--silent=<replaceable>LOCATION</replaceable></option></term>
docs: Use Unicode apostrophes in gio documentation Let’s move into the 21st century. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:20:01 +01:00
<listitem><para>Monitor the file directly, but don’t report changes.</para></listitem>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</varlistentry>
<varlistentry>
<term><option>-n</option>, <option>--no-moves</option></term>
<listitem><para>Report moves and renames as simple deleted/created events.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-m</option>, <option>--mounts</option></term>
<listitem><para>Watch for mount events.</para></listitem>
</varlistentry>
</variablelist>
</refsect3>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>mount</command>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</term>
<listitem>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>Provides commandline access to various aspects of GIO’s mounting
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
functionality.</para>
<para>Mounting refers to the traditional concept of arranging multiple
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
file systems and devices in a single tree, rooted at <filename>/</filename>. Classical
Fixing a small typo in docs/references/gio/gio.xml Fix issue #1828
2019-07-12 17:49:51 +02:00
mounting happens in the kernel and is controlled by the mount utility.
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
GIO expands this concept by introducing mount daemons that can make
file systems available to GIO applications without kernel
involvement.</para>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>GIO mounts can require authentication, and the <command>mount</command> command
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
may ask for user IDs, passwords, and so on, when required.</para>
<refsect3>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-m</option>, <option>--mountable</option></term>
<listitem><para>Mount as mountable.</para></listitem>
</varlistentry>
<varlistentry>
docs: Mention new gio tool options New features were added for gio tool, but they are not mentioned in man pages as it is not generated from GOptionEntry in contrast to the help output. Let's update the man pages to reflect the recent changes.
2020-04-02 10:45:11 +02:00
<term><option>-d</option>, <option>--device=<replaceable>ID</replaceable></option></term>
<listitem><para>Mount volume with device file, or other identifier.</para></listitem>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</varlistentry>
<varlistentry>
<term><option>-u</option>, <option>--unmount</option></term>
<listitem><para>Unmount the location.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-e</option>, <option>--eject</option></term>
<listitem><para>Eject the location.</para></listitem>
</varlistentry>
docs: Mention new gio tool options New features were added for gio tool, but they are not mentioned in man pages as it is not generated from GOptionEntry in contrast to the help output. Let's update the man pages to reflect the recent changes.
2020-04-02 10:45:11 +02:00
<varlistentry>
<term><option>-t</option>, <option>--stop=<replaceable>DEVICE</replaceable></option></term>
<listitem><para>Stop drive with device file.</para></listitem>
</varlistentry>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<varlistentry>
<term><option>-s</option>, <option>--unmount-scheme=<replaceable>SCHEME</replaceable></option></term>
<listitem><para>Unmount all mounts with the given scheme.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option>, <option>--force</option></term>
<listitem><para>Ignore outstanding file operations when unmounting or ejecting.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-a</option>, <option>--anonymous</option></term>
<listitem><para>Use an anonymous user when authenticating.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-l</option>, <option>--list</option></term>
<listitem><para>List all GIO mounts.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-o</option>, <option>--monitor</option></term>
<listitem><para>Monitor mount-related events.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-i</option>, <option>--detail</option></term>
<listitem><para>Show extra information.</para>
</listitem>
</varlistentry>
Add support for TCRYPT volumes to GMountOperation Add G_ASK_PASSWORD_TCRYPT flag to GAskPasswordFlags and add the following properties to GMountOperation: - hidden_volume [1] - system_volume [2] - pim [3] [1] https://www.veracrypt.fr/en/Hidden%20Volume.html [2] https://www.veracrypt.fr/en/System%20Encryption.html [3] https://www.veracrypt.fr/en/Personal%20Iterations%20Multiplier%20(PIM).html
2018-03-09 00:40:17 +01:00
<varlistentry>
<term><option>--tcrypt-pim</option></term>
<listitem><para>The numeric PIM when unlocking a VeraCrypt volume.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--tcrypt-hidden</option></term>
<listitem><para>Mount a TCRYPT hidden volume.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--tcrypt-system</option></term>
<listitem><para>Mount a TCRYPT system volume.</para>
</listitem>
</varlistentry>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</variablelist>
</refsect3>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>move</command>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>SOURCE</replaceable></arg>
<arg choice="plain"><replaceable>DESTINATION</replaceable></arg>
</term>
<listitem>
<para>Moves one or more files from <replaceable>SOURCE</replaceable>
to <replaceable>DESTINATION</replaceable>. If more than one source
is specified, the destination must be a directory.</para>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>The <command>move</command> command is similar to the traditional <command>mv</command> utility.</para>
docs: Add missing `gio move` options The `gio move` tool has plenty of options, which are listed by `gio help move`, however, the `man gio` page doesn't mention them. Let's add these missing options to the man page as well.
2019-06-07 09:09:09 +02:00
<refsect3>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-T</option>, <option>--no-target-directory</option></term>
<listitem><para>Don’t copy into <replaceable>DESTINATION</replaceable> even if it is a directory.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option>, <option>--progress</option></term>
<listitem><para>Show progress.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-i</option>, <option>--interactive</option></term>
<listitem><para>Prompt for confirmation before overwriting files.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-b</option>, <option>--backup</option></term>
<listitem><para>Create backups of existing destination files.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-C</option>, <option>--no-copy-fallback</option></term>
<listitem><para>Don’t use copy and delete fallback.</para></listitem>
</varlistentry>
</variablelist>
</refsect3>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>open</command>
<arg choice="plain" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</term>
<listitem>
<para>Opens files with the default application that is registered
to handle files of this type.</para>
<para>GIO obtains this information from the shared-mime-info
database, with per-user overrides stored in
<filename><envar>$XDG_DATA_HOME</envar>/applications/mimeapps.list</filename>.</para>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>The <command>mime</command> command can be used to change the default handler for
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
a mimetype.</para>
docs: Mention environment variables in `gio open` documentation Signed-off-by: Philip Withnall <withnall@endlessm.com> Closes: #1803
2019-08-25 10:05:07 +02:00
<para>Environment variables will not be set on the application, as it
may be an existing process which is activated to handle the new file.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>rename</command>
<arg choice="plain"><replaceable>LOCATION</replaceable></arg>
<arg choice="plain"><replaceable>NAME</replaceable></arg>
</term>
<listitem>
<para>Renames a file.</para>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>The <command>rename</command> command is similar to the traditional <command>rename</command> utility.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>remove</command>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</term>
<listitem>
<para>Deletes each given file.</para>
<para>This command removes files irreversibly. If you want a reversible
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
way to remove files, see the <command>trash</command> command.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<para>Note that not all URI schemes that are supported by GIO may
allow deletion of files.</para>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>The <command>remove</command> command is similar to the traditional <command>rm</command> utility.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<refsect3>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-f</option>, <option>--force</option></term>
<listitem><para>Ignore non-existent and non-deletable files.</para></listitem>
</varlistentry>
</variablelist>
</refsect3>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>save</command>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="plain"><replaceable>DESTINATION</replaceable></arg>
</term>
<listitem>
<para>Reads from standard input and saves the data to the given
location.</para>
<para>This is similar to just redirecting output to a file using
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
traditional shell syntax, but the <command>save</command> command allows saving to
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
location that GIO can write to.</para>
<refsect3>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-b</option>, <option>--backup</option></term>
docs: Fix some minor wording problems in the gio documentation And some missing apostrophes. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:17:49 +01:00
<listitem><para>Back up existing destination files.</para></listitem>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</varlistentry>
<varlistentry>
<term><option>-c</option>, <option>--create</option></term>
docs: Use Unicode apostrophes in gio documentation Let’s move into the 21st century. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:20:01 +01:00
<listitem><para>Only create the destination if it doesn’t exist yet.</para></listitem>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</varlistentry>
<varlistentry>
<term><option>-a</option>, <option>--append</option></term>
<listitem><para>Append to the end of the file.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option>, <option>--private</option></term>
<listitem><para>When creating, restrict access to the current user.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-u</option>, <option>--unlink</option></term>
<listitem><para>When replacing, replace as if the destination did not exist.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option>, <option>--print-etag</option></term>
docs: Fix capitalisation of ‘ETag’ Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:17:32 +01:00
<listitem><para>Print the new ETag in the end.</para></listitem>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</varlistentry>
<varlistentry>
<term><option>-e</option>, <option>--etag=<replaceable>ETAG</replaceable></option></term>
docs: Fix capitalisation of ‘ETag’ Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:17:32 +01:00
<listitem><para>The ETag of the file that is overwritten.</para></listitem>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</varlistentry>
</variablelist>
</refsect3>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>set</command>
<arg choice="plain"><replaceable>LOCATION</replaceable></arg>
<arg choice="plain"><replaceable>ATTRIBUTE</replaceable></arg>
<arg choice="plain" rep="repeat"><replaceable>VALUE</replaceable></arg>
</term>
<listitem>
Spelling: avoid the "allows to" pattern This is detected by Debian's Lintian tool, which suggests "allows one to" as a replacement. I've rephrased the documentation in question to avoid both of those. Signed-off-by: Simon McVittie <smcv@collabora.com>
2018-09-25 16:56:47 +02:00
<para>Sets a file attribute on a file.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<para>File attributes can be specified with their GIO name, e.g
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<literal>standard::icon</literal>. Note that not all GIO file attributes are writable.
Use the <option>--query-writable</option> option of the <command>info</command> command to list
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
writable file attributes.</para>
<para>If the <replaceable>TYPE</replaceable> is unset,
<replaceable>VALUE</replaceable> does not have to be specified.
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
If the <replaceable>TYPE</replaceable> is <literal>stringv</literal>, multiple values can be given.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<refsect3>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-t</option>, <option>--type=<replaceable>TYPE</replaceable></option></term>
<listitem><para>Specifies the type of the attribute. Supported
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
types are <literal>string</literal>, <literal>stringv</literal>,
<literal>bytestring</literal>, <literal>boolean</literal>,
<literal>uint32</literal>, <literal>int32</literal>,
<literal>uint64</literal>, <literal>int64</literal> and <literal>unset</literal>.</para>
<para>If the type is not specified, <literal>string</literal> is assumed.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</listitem>
</varlistentry>
docs: Add --delete option to gio-tool attributes documentation It was added via !2845 but not documented.
2022-08-05 22:23:49 +02:00
<varlistentry>
<term><option>-d</option>, <option>--delete</option></term>
<listitem><para>Unsets an attribute (same as setting it's type to <literal>unset</literal>).</para></listitem>
</varlistentry>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<varlistentry>
<term><option>-n</option>, <option>--nofollow-symlinks</option></term>
docs: Use Unicode apostrophes in gio documentation Let’s move into the 21st century. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:20:01 +01:00
<listitem><para>Don’t follow symbolic links.</para></listitem>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</varlistentry>
</variablelist>
</refsect3>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>trash</command>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</term>
<listitem>
gio-tool-trash: Add --restore subcommand It search for attribute trash::orig-path and move the input file to it. Possibly recreating the directory of orignal path and/or overwritting the destination. Closes #2098 Signed-off-by: Frederic Martinsons <frederic.martinsons@sigfox.com>
2020-12-07 16:46:14 +01:00
<para>Sends files or directories to the ‘Trashcan’ or restore them from
‘Trashcan’. This can be a different folder depending on where the file
is located, and not all file systems support this concept. In the common
case that the file lives inside a user’s home directory, the trash folder is
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<filename><envar>$XDG_DATA_HOME</envar>/Trash</filename>.</para>
<para>Note that moving files to the trash does not free up space on
docs: Use Unicode apostrophes in gio documentation Let’s move into the 21st century. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:20:01 +01:00
the file system until the ‘Trashcan’ is emptied. If you are interested
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
in deleting a file irreversibly, see the <command>remove</command> command.</para>
docs: Use Unicode apostrophes in gio documentation Let’s move into the 21st century. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:20:01 +01:00
<para>Inspecting and emptying the ‘Trashcan’ is normally supported by
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
graphical file managers such as Nautilus, but you can also see the
gio-tool-trash: Add --restore subcommand It search for attribute trash::orig-path and move the input file to it. Possibly recreating the directory of orignal path and/or overwritting the destination. Closes #2098 Signed-off-by: Frederic Martinsons <frederic.martinsons@sigfox.com>
2020-12-07 16:46:14 +01:00
trash with the command: <command>gio trash --list</command> or
<command>gio list trash://</command>.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<refsect3>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-f</option>, <option>--force</option></term>
<listitem><para>Ignore non-existent and non-deletable files.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--empty</option></term>
<listitem><para>Empty the trash.</para></listitem>
</varlistentry>
gio-tool-trash: Add --list subcommand This will print all the files in TrashCan along with their original location. Signed-off-by: Frederic Martinsons <frederic.martinsons@sigfox.com>
2020-12-07 16:35:55 +01:00
<varlistentry>
<term><option>--list</option></term>
<listitem><para>List files in the trash with their original locations</para></listitem>
</varlistentry>
gio-tool-trash: Add --restore subcommand It search for attribute trash::orig-path and move the input file to it. Possibly recreating the directory of orignal path and/or overwritting the destination. Closes #2098 Signed-off-by: Frederic Martinsons <frederic.martinsons@sigfox.com>
2020-12-07 16:46:14 +01:00
<varlistentry>
<term><option>--restore</option></term>
<listitem><para>Restore a file from trash to its original location. A URI beginning
with <literal>trash://</literal> is expected here. If the original
directory doesn't exist, it will be recreated.</para></listitem>
</varlistentry>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
</variablelist>
</refsect3>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>tree</command>
<arg choice="opt" rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>LOCATION</replaceable></arg>
</term>
<listitem>
<para>Lists the contents of the given locations recursively, in a
tree-like format. If no location is given, it defaults to the current
directory.</para>
docs: Improve formatting of literals in gio documentation There was no distinction between literals which need to be typed, and normal words in the prose. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2018-12-19 13:16:48 +01:00
<para>The <command>tree</command> command is similar to the traditional <command>tree</command> utility.</para>
Document the gio tool Add a man page, and integrate it in the reference docs.
2015-05-25 22:40:55 +02:00
<refsect3>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-h</option>, <option>--hidden</option></term>
<listitem><para>Show hidden files.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-l</option>, <option>--follow-symlinks</option></term>
<listitem><para>Follow symbolic links.</para></listitem>
</varlistentry>
</variablelist>
</refsect3>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Exit status</title>
<para>On success 0 is returned, a non-zero failure code otherwise.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry>
<refentrytitle>cat</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>cp</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>ls</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>mkdir</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>mv</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>rm</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>tree</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>.
</para>
</refsect1>
</refentry>
Reference in New Issue Copy Permalink