diff --git a/docs/reference/gio/Makefile.am b/docs/reference/gio/Makefile.am index 64e227ad5..802767b5a 100644 --- a/docs/reference/gio/Makefile.am +++ b/docs/reference/gio/Makefile.am @@ -168,15 +168,17 @@ man_MANS = if ENABLE_MAN -man_MANS += \ - gapplication.1 \ - gio-querymodules.1 \ - glib-compile-schemas.1 \ +man_MANS += \ + gapplication.1 \ + gio-querymodules.1 \ + glib-compile-schemas.1 \ glib-compile-resources.1 \ - gsettings.1 \ - gresource.1 \ - gdbus.1 \ - gdbus-codegen.1 + gsettings.1 \ + gresource.1 \ + gdbus.1 \ + gdbus-codegen.1 \ + gio.1 \ + $(NULL) XSLTPROC_FLAGS = \ --nonet \ diff --git a/docs/reference/gio/gio-docs.xml b/docs/reference/gio/gio-docs.xml index 1c774e293..2f3eab076 100644 --- a/docs/reference/gio/gio-docs.xml +++ b/docs/reference/gio/gio-docs.xml @@ -248,6 +248,7 @@ + GIO Testing diff --git a/docs/reference/gio/gio.xml b/docs/reference/gio/gio.xml new file mode 100644 index 000000000..d3e878a17 --- /dev/null +++ b/docs/reference/gio/gio.xml @@ -0,0 +1,720 @@ + + + + + gio + GIO + + + Developer + Matthias + Clasen + mclasen@redhat.com + + + + + + gio + 1 + User Commands + + + + gio + GIO commandline tool + + + + + gio + help + COMMAND + + + gio + version + + + gio + cat + LOCATION + + + gio + copy + OPTION + SOURCE + DESTINATION + + + gio + info + OPTION + LOCATION + + + gio + list + OPTION + LOCATION + + + gio + mime + MIMETYPE + HANDLER + + + gio + mkdir + OPTION + LOCATION + + + gio + monitor + OPTION + LOCATION + + + gio + mount + OPTION + LOCATION + + + gio + move + OPTION + SOURCE + DESTINATION + + + gio + open + LOCATION + + + gio + rename + LOCATION + NAME + + + gio + remove + OPTION + LOCATION + + + gio + save + OPTION + DESTINATION + + + gio + set + OPTION + LOCATION + ATTRIBUTE + VALUE + + + gio + trash + OPTION + LOCATION + + + gio + tree + OPTION + LOCATION + + + + + Description + gio 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 smb://server/resource/file.txt + as location. + + + + Commands + + + + + help + COMMAND + + + Displays a short synopsis of the available commands or provides + detailed help on a specific command. + + + + + + version + + + Prints the GLib version to which gio + belongs. + + + + + + cat + LOCATION + + + Concatenates the given files and prints them to the standard + output. + The cat command works just like the traditional cat utility. + Note: just pipe through cat if you need its formatting options + like -n, -T or other. + + + + + + copy + OPTION + SOURCE + DESTINATION + + + Copies one or more files from SOURCE + to DESTINATION. If more than one source + is specified, the destination must be a directory. + The copy command is similar to the traditional cp utility. + + Options + + + , + Don't copy into DESTINATION even if it is a directory. + + + , + Show progress. + + + , + Prompt for confirmation before overwriting files. + + + + Preserve all attributes of copied files. + + + , + Create backups of existing destination files. + + + , + Never follow symbolic links. + + + + + + + + info + OPTION + LOCATION + + + Shows information about the given locations. + The info command is similar to the traditional ls utility. + + Options + + + , + List writable attributes. + + + , + Show information about the filesystem that the given + locations reside on. + + + + The attributes to get. + Attributes can be specified with their GIO name, e.g. + standard::icon, or just by namespace, e.g. unix, or by '*', + which matches all attributes. Several attributes or groups + of attributes can be specified, separated by comma. + By default, all attributes are listed. + + + , + Don't follow symbolic links. + + + + + + + + + list + OPTION + LOCATION + + + Lists the contents of the given locations. If no location is + given, the contents of the current directory are shown. + The list command is similar to the traditional ls utility. + + Options + + + + The attributes to get. + Attributes can be specified with their GIO name, e.g. + standard::icon, or just by namespace, e.g. unix, or by '*', + which matches all attributes. Several attributes or groups + of attributes can be specified, separated by comma. + By default, all attributes are listed. + + + , + Show hidden files. + + + , + Use a long listing format. + + + , + Don't follow symbolic links. + + + , + Print full URIs. + + + + + + + + + mime + MIMETYPE + HANDLER + + + If no handler is given, the mime command lists the + registered and recommended applications for the mimetype. + If a handler is given, it is set as the default handler for + the mimetype. + Handlers must be specified by their desktop file name, + including the extension. Example: org.gnome.gedit.desktop. + + + + + + mkdir + OPTION + LOCATION + + + Creates directories. + The mkdir command is similar to the traditional mkdir utility. + + Options + + + , + Create parent directories when necessary. + + + + + + + + + monitor + OPTION + LOCATION + + + Monitors files or directories for changes, such as creation + deletion, content and attribute changes, and mount and unmount + operations affecting the monitored locations. + The monitor command uses the GIO file monitoring APIs to do + its job. GIO has different implementations for different platforms. + The most common implementation on Linux uses inotify. + + Options + + + , + Monitor the given location as a directory. Normally, + the file type is used to determine whether to monitor a file or directory. + + + , + Monitor the given location as a file. Normally, + the file type is used to determine whether to monitor a file or directory. + + + , + Monitor the file directly. This allows to capture changes made via hardlinks. + + + , + Monitor the file directly, but don't report changes. + + + , + Report moves and renames as simple deleted/created events. + + + , + Watch for mount events. + + + + + + + + + mount + OPTION + LOCATION + + + Provides commandline access to various aspects of GIOs mounting + functionality. + Mounting refers to the traditional concept of arranging multiple + file systems and devices in a single tree, rooted at /. Classical + mounting happens in the kernel and is controlle by the mount utility. + GIO expands this concept by introducing mount daemons that can make + file systems available to GIO applications without kernel + involvement. + GIO mounts can require authentication, and the mount command + may ask for user IDs, passwords, and so on, when required. + + Options + + + , + Mount as mountable. + + + , + Mount volume with device file. + + + , + Unmount the location. + + + , + Eject the location. + + + , + Unmount all mounts with the given scheme. + + + , + Ignore outstanding file operations when unmounting or ejecting. + + + , + Use an anonymous user when authenticating. + + + , + List all GIO mounts. + + + , + Monitor mount-related events. + + + + , + Show extra information. + + + + + + + + + + move + OPTION + SOURCE + DESTINATION + + + Moves one or more files from SOURCE + to DESTINATION. If more than one source + is specified, the destination must be a directory. + The move command is similar to the traditional mv utility. + + + + + + open + LOCATION + + + Opens files with the default application that is registered + to handle files of this type. + GIO obtains this information from the shared-mime-info + database, with per-user overrides stored in + $XDG_DATA_HOME/applications/mimeapps.list. + The mime command can be used to change the default handler for + a mimetype. + + + + + + rename + LOCATION + NAME + + + Renames a file. + The rename command is similar to the traditional rename utility. + + + + + + remove + OPTION + LOCATION + + + Deletes each given file. + This command removes files irreversibly. If you want a reversible + way to remove files, see the trash command. + Note that not all URI schemes that are supported by GIO may + allow deletion of files. + The remove command is similar to the traditional rm utility. + + Options + + + , + Ignore non-existent and non-deletable files. + + + + + + + + + save + OPTION + DESTINATION + + + Reads from standard input and saves the data to the given + location. + This is similar to just redirecting output to a file using + traditional shell syntax, but the save command allows saving to + location that GIO can write to. + + Options + + + , + Backup existing destination files. + + + , + Only create the destination if it doesn't exist yet. + + + , + Append to the end of the file. + + + , + When creating, restrict access to the current user. + + + , + When replacing, replace as if the destination did not exist. + + + , + Print the new etag in the end. + + + , + The etag of the file that is overwritten. + + + + + + + + + set + LOCATION + ATTRIBUTE + VALUE + + + Allows to set a file attribute on a file. + File attributes can be specified with their GIO name, e.g + standard::icon. Note that not all GIO file attributes are writable. + Use the --query-writable option of the info command to list + writable file attributes. + If the TYPE is unset, + VALUE does not have to be specified. + If the type is stringv, multiple values can be given. + + Options + + + , + Specifies the type of the attribute. Supported + types are string, stringv, bytestring, boolean, uint32, int32, + uint64, int64 and unset. + If the type is not specified, string is assumed. + + + + , + Don't follow symbolic links. + + + + + + + + + trash + OPTION + LOCATION + + + Sends files or directories to the "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 users home directory, the trash folder is + $XDG_DATA_HOME/Trash. + Note that moving files to the trash does not free up space on + the file system until the "Trashcan" is emptied. If you are interested + in deleting a file irreversibly, see the remove command. + Inspecting and emptying the "Trashcan" is normally supported by + graphical file managers such as nautilus, but you can also see the + trash with the command: gio list trash://. + + Options + + + , + Ignore non-existent and non-deletable files. + + + + Empty the trash. + + + + + + + + + tree + OPTION + LOCATION + + + Lists the contents of the given locations recursively, in a + tree-like format. If no location is given, it defaults to the current + directory. + The tree command is similar to the traditional tree utility. + + Options + + + , + Show hidden files. + + + , + Show hidden files. + + + , + Follow symbolic links. + + + + + + + + + + Exit status + On success 0 is returned, a non-zero failure code otherwise. + + + + See Also + + + cat + 1 + , + + cp + 1 + , + + ls + 1 + , + + mkdir + 1 + , + + mv + 1 + , + + rm + 1 + , + + tree + 1 + . + + +