diff options
Diffstat (limited to 'doc/operations.qdoc')
| -rw-r--r-- | doc/operations.qdoc | 108 |
1 files changed, 54 insertions, 54 deletions
diff --git a/doc/operations.qdoc b/doc/operations.qdoc index 5f959002e..c2cd5dc12 100644 --- a/doc/operations.qdoc +++ b/doc/operations.qdoc @@ -47,52 +47,52 @@ \table \header - \o Operation - \o Syntax - \o Use + \li Operation + \li Syntax + \li Use \row - \o Copy - \o "Copy" \a source \a target - \o Copies a file from \a source to \a target. + \li Copy + \li "Copy" \a source \a target + \li Copies a file from \a source to \a target. \row - \o Move - \o "Move" \a source \a target - \o Moves a file from \a source to \a target. + \li Move + \li "Move" \a source \a target + \li Moves a file from \a source to \a target. \row - \o Delete - \o "Delete" \a filename - \o Deletes the file specified by \a filename. + \li Delete + \li "Delete" \a filename + \li Deletes the file specified by \a filename. \row - \o Mkdir - \o "Mkdir" \a path - \o Creates the directory path \a path. + \li Mkdir + \li "Mkdir" \a path + \li Creates the directory path \a path. \row - \o Rmdir - \o "Rmdir" \a path - \o Removes the directory path \a path. + \li Rmdir + \li "Rmdir" \a path + \li Removes the directory path \a path. \row - \o AppendFile - \o "AppendFile" \a filename \a text - \o Appends \a text to the file specified by \a filename. \a text is + \li AppendFile + \li "AppendFile" \a filename \a text + \li Appends \a text to the file specified by \a filename. \a text is treated as ASCII text. \row - \o PrependFile - \o "PrependFile" \a filename \a text - \o Prepends \a text to the file specified by \a filename. \a text + \li PrependFile + \li "PrependFile" \a filename \a text + \li Prepends \a text to the file specified by \a filename. \a text is treated as ASCII text. \row - \o Replace - \o "Replace" \a file \a search \ replace - \o Opens \a file to find \a search string and replaces that with the \a replace string. + \li Replace + \li "Replace" \a file \a search \ replace + \li Opens \a file to find \a search string and replaces that with the \a replace string. \row - \o LineReplace - \o "LineReplace" \a file \a search \ replace - \o Opens \a file to find lines that start with \a search string and + \li LineReplace + \li "LineReplace" \a file \a search \ replace + \li Opens \a file to find lines that start with \a search string and replaces that with the \a replace string. \row - \o Execute - \o "Execute" [{\a exitcodes}] \a command [\a parameter1 [\a parameter... [\a parameter10]]] - \o Executes the command specified by \a command. Up to 10 + \li Execute + \li "Execute" [{\a exitcodes}] \a command [\a parameter1 [\a parameter... [\a parameter10]]] + \li Executes the command specified by \a command. Up to 10 parameters can be passed. If that is not enough, you can use a JavaScript string array. Optionally, you can pass a comma-separated list of exit codes @@ -110,16 +110,16 @@ component.addOperation("Execute", "touch", "test.txt", "UNDOEXECUTE", "rm", "test.txt") \endcode \row - \o CreateShortcut - \o "CreateShortcut" \a filename \a linkname [\a arguments] - \o Creates a shortcut from the file specified by \a filename to + \li CreateShortcut + \li "CreateShortcut" \a filename \a linkname [\a arguments] + \li Creates a shortcut from the file specified by \a filename to \a linkname. On Windows, this creates a .lnk file which can have \a arguments. On Unix, this creates a symbolic link. \row - \o CreateDesktopEntry - \o "CreateDesktopEntry" \a filename \a "key=value[\nkey2=value2[\nkey3=value3]]]" - \o Creates a .desktop initialization file, as specified by + \li CreateDesktopEntry + \li "CreateDesktopEntry" \a filename \a "key=value[\nkey2=value2[\nkey3=value3]]]" + \li Creates a .desktop initialization file, as specified by freedesktop.org. If \a filename is absolute, the desktop entry is stored there. @@ -132,9 +132,9 @@ The file is set to use UTF-8 encoding. \row - \o InstallIcons - \o "InstallIcons" \a directory \a [Vendorprefix] - \o Installs the contents of \a directory into a location, as + \li InstallIcons + \li "InstallIcons" \a directory \a [Vendorprefix] + \li Installs the contents of \a directory into a location, as specified by freedesktop.org. That is, into \c {$XDG_DATA_DIRS/icons}, \c {/usr/share/icons}, or \c {$HOME/.icons}. The files are removed from their initial @@ -143,33 +143,33 @@ If you provide a \a Vendorprefix it replaces all characters up to the first dash (-) in the filename of the icon with this prefix. \row - \o Extract - \o "Extract" \a archive \a targetdirectory - \o Extracts \a archive to \a targetdirectory. + \li Extract + \li "Extract" \a archive \a targetdirectory + \li Extracts \a archive to \a targetdirectory. \row - \o GlobalConfig - \o "GlobalConfig" \a company \a application \a key \a value + \li GlobalConfig + \li "GlobalConfig" \a company \a application \a key \a value or "GlobalConfig" \a filename \a key \a value - \o Stores \a value for \a key in a configuration file. The + \li Stores \a value for \a key in a configuration file. The configuration file is specified either by \a filename (using \a QSettings::NativeFormat, which might be the Windows registry) or by \a application and \a company name. \row - \o EnvironmentVariable - \o "EnvironmentVariable" \a key \a value [[\a persistent] \a system] - \o Sets the environment variable \a key to \a value. If + \li EnvironmentVariable + \li "EnvironmentVariable" \a key \a value [[\a persistent] \a system] + \li Sets the environment variable \a key to \a value. If \a persistent is set to \c true, the variable is set persistently. This is currently only supported on Windows. If \a system is set to \c true, the persistent variable is set system-wide, not only for the current user. \row - \o RegisterFileType - \o "RegisterFileType" \a extension \a command [\a description [\a contentType [\a icon]]]. - \o Registers the file type with \a extension to be opened via + \li RegisterFileType + \li "RegisterFileType" \a extension \a command [\a description [\a contentType [\a icon]]]. + \li Registers the file type with \a extension to be opened via \a command. Optionally, you can specify \a description, \a contentType, and \a icon. This is currently only supported on Windows. |