Commit 48503ff6 authored by Alexander Schwinn's avatar Alexander Schwinn
Browse files

renamed all README files to README.md and modified the content in order

to use markdown language.

Slightly updated the main README.md according to our current environment
parent c3aae2e7
......@@ -23,7 +23,7 @@ Autotools has be installed on your system in order to run './autogen.sh'
The following text originally referred to './configure' ... usually you
can just replace all calls of './configure' directly with './autogen.sh'.
The following more-detailed instructions are generic; see the `README'
The following more-detailed instructions are generic; see the `README.md'
file for instructions specific to this package. Some packages provide
this `INSTALL' file but do not implement all of the features documented
below. The lack of an optional feature in a given package is not
......@@ -47,7 +47,7 @@ cache files.
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
diffs or instructions to the address given in the `README.md' so they can
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
......@@ -219,7 +219,7 @@ option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
`README.md' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
......
......@@ -89,6 +89,7 @@ polkit_policy_DATA = $(polkit_in_files:.policy.in=.policy)
EXTRA_DIST = \
FAQ \
HACKING \
README.md \
intltool-extract.in \
intltool-merge.in \
intltool-update.in \
......
What is it?
===========
Thunar is a modern file manager for the Unix/Linux desktop, aiming to be
easy-to-use and fast.
Thunar is a modern file manager for the Unix/Linux desktop, aiming to be easy-to-use and fast.
Required packages
=================
......@@ -23,70 +21,50 @@ Thunar can optionally use the following packages:
- xfce4-panel 4.10.0 or above (for the trash applet)
- xfconf-query
Installation
============
The file 'INSTALL' contains generic installation instructions. For more
detailed information, visit https://docs.xfce.org/xfce/thunar/start.
The file 'INSTALL' contains generic installation instructions. For more general information, check the [thunar documentation](https://docs.xfce.org/xfce/thunar/start).
Debugging Support
=================
Thunar currently supports four different levels of debugging support, which
can be setup using the configure flag `--enable-debug' (check the output of
`configure --help'):
Thunar currently supports four different levels of debugging support, which can be setup using the configure flag `--enable-debug` (check the output of `configure --help`):
`full' Use this if you want to debug Thunar to locate a bug. The
build will most probably be noticably slower. This is also
recommended for people that want to develop Thunar stuff.
**full:**
`yes' This is the default for SVN snapshot builds. It adds all
kinds of checks to the code, and is therefore likely to run
slower. Use this if you want to develop for Thunar (e.g.
writing Thunar extensions and such).
Use this if you want to debug Thunar to locate a bug. The build will most probably be noticably slower. This is also recommended for people that want to develop Thunar stuff.
`minimum' This is the default for release builds, and presents the
recommended behaviour.
**yes**
`no' Disables all sanity checks. Don't use this unless you know
exactly what you do.
Adds all kinds of checks to the code, and is therefore likely to run slower. Use this if you want to develop for Thunar (e.g. writing Thunar extensions and such).
**minimum**
Standards compliance
====================
Thunar supports the following standards/specifications:
This is the default for release builds, and presents the recommended behaviour.
* XDG Base Directory Specification
https://freedesktop.org/wiki/Specifications/basedir-spec
**no**
* Shared MIME Database Specification
https://freedesktop.org/wiki/Specifications/shared-mime-info-spec
Disables all sanity checks. Don't use this unless you know exactly what you do.
* X Direct Save (XDS) Protocol for the X Window System
https://freedesktop.org/wiki/Specifications/direct-save
* Icon Theme Specification
https://freedesktop.org/wiki/Specifications/icon-theme-spec
* Thumbnail Managing Standard
https://freedesktop.org/wiki/Specifications/thumbnails
* File URI Specification
https://freedesktop.org/wiki/Specifications/file-uri-spec
Standards compliance
====================
* Desktop Trash Can Specification
https://freedesktop.org/wiki/Specifications/trash-spec
Thunar supports the following standards/specifications:
* [XDG Base Directory Specification](http://https://freedesktop.org/wiki/Specifications/basedir-spec)
* [Shared MIME Database Specification](http://https://freedesktop.org/wiki/Specifications/shared-mime-info-spec)
* [X Direct Save (XDS) Protocol for the X Window System](https://freedesktop.org/wiki/Specifications/direct-save)
* [Icon Theme Specification](https://freedesktop.org/wiki/Specifications/icon-theme-spec)
* [Thumbnail Managing Standard](https://freedesktop.org/wiki/Specifications/thumbnails)
* [File URI Specification](https://freedesktop.org/wiki/Specifications/file-uri-spec)
* [Desktop Trash Can Specification](https://freedesktop.org/wiki/Specifications/trash-spec)
How to report bugs?
===================
Bugs should be reported to the Xfce bug tracking system
(https://bugzilla.xfce.org, product Thunar). You will need to
Bugs should be reported to https://bugzilla.xfce.org, product Thunar. You will need to
create an account for yourself.
Please read the HACKING file for information on where to send
changes or bugfixes for this package.
Please read [how to report bugs ](https://docs.xfce.org/contribute/start#bug_reporting_and_testing) for information on where to send
changes or bugfixes.
......@@ -13,7 +13,7 @@ dnl # should be built and installed.
dnl #
AC_DEFUN([BM_THUNAR_PLUGIN_APR],
[
AC_ARG_ENABLE([apr-plugin], [AC_HELP_STRING([--disable-apr-plugin], [Don't build the thunar-apr plugin, see plugins/thunar-apr/README])],
AC_ARG_ENABLE([apr-plugin], [AC_HELP_STRING([--disable-apr-plugin], [Don't build the thunar-apr plugin, see plugins/thunar-apr/README.md])],
[ac_bm_thunar_plugin_apr=$enableval], [ac_bm_thunar_plugin_apr=yes])
AC_MSG_CHECKING([whether to build the thunar-apr plugin])
AM_CONDITIONAL([THUNAR_PLUGIN_APR], [test x"$ac_bm_thunar_plugin_apr" = x"yes"])
......@@ -32,7 +32,7 @@ dnl # should be built and installed.
dnl #
AC_DEFUN([BM_THUNAR_PLUGIN_SBR],
[
AC_ARG_ENABLE([sbr-plugin], AC_HELP_STRING([--disable-sbr-plugin], [Don't build the thunar-sbr plugin, see plugins/thunar-sbr/README]),
AC_ARG_ENABLE([sbr-plugin], AC_HELP_STRING([--disable-sbr-plugin], [Don't build the thunar-sbr plugin, see plugins/thunar-sbr/README.md]),
[ac_bm_thunar_plugin_sbr=$enableval], [ac_bm_thunar_plugin_sbr=yes])
AC_MSG_CHECKING([whether to build the thunar-sbr plugin])
AM_CONDITIONAL([THUNAR_PLUGIN_SBR], [test x"$ac_bm_thunar_plugin_sbr" = x"yes"])
......@@ -52,7 +52,7 @@ dnl # for the Xfce panel, not for Thunar).
dnl #
AC_DEFUN([BM_THUNAR_PLUGIN_TPA],
[
AC_ARG_ENABLE([tpa-plugin], AC_HELP_STRING([--disable-tpa-plugin], [Don't build the thunar-tpa plugin, see plugins/thunar-tpa/README]),
AC_ARG_ENABLE([tpa-plugin], AC_HELP_STRING([--disable-tpa-plugin], [Don't build the thunar-tpa plugin, see plugins/thunar-tpa/README.md]),
[ac_bm_thunar_plugin_tpa=$enableval], [ac_bm_thunar_plugin_tpa=yes])
if test x"$ac_bm_thunar_plugin_tpa" = x"yes"; then
XDT_CHECK_PACKAGE([LIBXFCE4PANEL], [libxfce4panel-2.0], [4.12.0],
......@@ -80,7 +80,7 @@ dnl # should be built and installed.
dnl #
AC_DEFUN([BM_THUNAR_PLUGIN_UCA],
[
AC_ARG_ENABLE([uca-plugin], AC_HELP_STRING([--disable-uca-plugin], [Don't build the thunar-uca plugin, see plugins/thunar-uca/README]),
AC_ARG_ENABLE([uca-plugin], AC_HELP_STRING([--disable-uca-plugin], [Don't build the thunar-uca plugin, see plugins/thunar-uca/README.md]),
[ac_bm_thunar_plugin_uca=$enableval], [ac_bm_thunar_plugin_uca=yes])
AC_MSG_CHECKING([whether to build the thunar-uca plugin])
AM_CONDITIONAL([THUNAR_PLUGIN_UCA], [test x"$ac_bm_thunar_plugin_uca" = x"yes"])
......@@ -94,7 +94,7 @@ dnl # should be built and installed.
dnl #
AC_DEFUN([BM_THUNAR_PLUGIN_WALLPAPER],
[
AC_ARG_ENABLE([wallpaper-plugin], AC_HELP_STRING([--disable-wallpaper-plugin], [Don't build the thunar-wallpaper plugin, see plugins/thunar-wallpaper/README]),
AC_ARG_ENABLE([wallpaper-plugin], AC_HELP_STRING([--disable-wallpaper-plugin], [Don't build the thunar-wallpaper plugin, see plugins/thunar-wallpaper/README.md]),
[ac_bm_thunar_plugin_wallpaper=$enableval], [ac_bm_thunar_plugin_wallpaper=yes])
AC_MSG_CHECKING([whether to build the thunar-wallpaper plugin])
AM_CONDITIONAL([THUNAR_PLUGIN_WALLPAPER], [test x"$ac_bm_thunar_plugin_wallpaper" = x"yes"])
......
......@@ -35,7 +35,7 @@ tex_open_terminal_la_LDFLAGS = \
$(PLATFORM_LDFLAGS)
EXTRA_DIST = \
README
README.md
# Don't install/uninstall examples by default
install:
......
This is an example for a Thunar Extension that provides additional context
menu items. It adds an "Open Terminal Here" action to the folder context
menu and to the file context menu of directories, and thereby allows you
to open a new Terminal instance in the given folder.
The example is mainly provided for developers to get an idea about how
to write an extension that implements the ThunarxMenuProvider interface.
The extension is not installed by default, as every installed extension
increases the resources required to run Thunar. If you want to install
this extension, you can use the command
make install-extensionsLTLIBRARIES
in this directory.
Please note that this extension is not meant for daily use, but should just
serve as an example of how to write a simple Thunar extension. If you want
to be able to open a terminal in a specific folder, you should consider
installing the thunar-uca extension (see thunar-uca/README) and adding an
"Open Terminal Here" action there (there's already such an action available
by default).
This is an example for a Thunar Extension that provides additional context menu items.
It adds an "Open Terminal Here" action to the folder context menu and to the file context menu of directories, and thereby allows you to open a new Terminal instance in the given folder.
The example is mainly provided for developers to get an idea about how to write an extension that implements the ThunarxMenuProvider interface.
The extension is not installed by default, as every installed extension increases the resources required to run Thunar. If you want to install this extension, you can use the command `make install-extensions LTLIBRARIES` in this directory.
Please note that this extension is not meant for daily use, but should just serve as an example of how to write a simple Thunar extension. If you want to be able to open a terminal in a specific folder, you should consider installing the thunar-uca extension (see thunar-uca/README.md) and adding an "Open Terminal Here" action there (there's already such an action available by default).
......@@ -51,6 +51,6 @@ thunar_apr_la_DEPENDENCIES = \
EXTRA_DIST = \
README
README.md
# vi:set ts=8 sw=8 noet ai nocindent syntax=automake:
Thunar Advanced Properties (thunar-apr)
=======================================
Thunar-apr is an extension to Thunar, which provides additional pages for
the file properties dialog, that are displayed for certain kinds of files:
* Launcher/Link
* Image
The Launcher/Link page is displayed for .desktop files and allows users to
easily edit the most important values (i.e. the command for a launcher and
the URL for a link).
The Image page is displayed for all kinds of image files supported by the
GTK+ version used by Thunar. The page displays atleast the exact format of
the image and the dimensions in pixels. If the plugin is build with support
for libexif (you can explicitly disable this using the `--disable-exif'
configure option) and the image file includes Exif tags, the most important
Exif tags found in the image file will also be displayed.
By default the thunar-apr extension will be installed, but as with every
extension, it will slightly increase the resource usage of Thunar (this
shouldn't be a real problem unless you're targeting an embedded system),
and so you can pass `--disable-apr-plugin' to configure and the plugin
won't be built and installed. Since it is an extension, you can also
easily uninstall it afterwards by removing the thunar-apr.so file from
the lib/thunarx-2/ directory of your installation (be sure to quit Thunar
before removing files though).
Thunar Advanced Properties (thunar-apr)
=======================================
Thunar-apr is an extension to Thunar, which provides additional pages forthe file properties dialog, that are displayed for certain kinds of files:
* Launcher/Link
* Image
The Launcher/Link page is displayed for .desktop files and allows users to easily edit the most important values (i.e. the command for a launcher and the URL for a link).
The Image page is displayed for all kinds of image files supported by the GTK+ version used by Thunar. The page displays atleast the exact format of the image and the dimensions in pixels. If the plugin is build with support for libexif (you can explicitly disable this using the `--disable-exif` configure option) and the image file includes Exif tags, the most important Exif tags found in the image file will also be displayed.
By default the thunar-apr extension will be installed, but as with every extension, it will slightly increase the resource usage of Thunar (this shouldn't be a real problem unless you're targeting an embedded system), and so you can pass `--disable-apr-plugin` to configure and the plugin won't be built and installed. Since it is an extension, you can also easily uninstall it afterwards by removing the thunar-apr.so file from the lib/thunarx-2/ directory of your installation (be sure to quit Thunar before removing files though).
\ No newline at end of file
......@@ -55,6 +55,6 @@ thunar_sbr_la_DEPENDENCIES = \
$(top_builddir)/thunarx/libthunarx-$(THUNARX_VERSION_API).la
EXTRA_DIST = \
README
README.md
# vi:set ts=8 sw=8 noet ai nocindent syntax=automake:
Thunar Simple Builtin Renamers (thunar-sbr)
===========================================
Thunar-sbr is an extension to Thunar, which includes a bunch of simple renamers
for the bulk rename dialog:
Thunar-sbr is an extension to Thunar, which includes a bunch of simple renamers for the bulk rename dialog:
* Insert / Overwrite
* Insert Date / Time
......@@ -11,27 +10,15 @@ for the bulk rename dialog:
* Search & Replace
* Uppercase / Lowercase
By default the thunar-sbr extension will be installed, but as with every
extension, it will slightly increase the resource usage of Thunar (this
shouldn't be a real problem unless you're targeting an embedded system), and so
you can pass `--disable-sbr-plugin' to configure and the plugin won't be built
and installed. Since it is an extension, you can also easily uninstall it
afterwards by removing the thunar-sbr.so file from the lib/thunarx-2/ directory
of your installation (be sure to quit Thunar before removing files though).
By default the thunar-sbr extension will be installed, but as with every extension, it will slightly increase the resource usage of Thunar (this shouldn't be a real problem unless you're targeting an embedded system), and so you can pass `--disable-sbr-plugin` to configure and the plugin won't be built and installed. Since it is an extension, you can also easily uninstall it afterwards by removing the thunar-sbr.so file from the lib/thunarx-2/ directory of your installation (be sure to quit Thunar before removing files though).
Regular Expressions
-------------------
The "Search & Replace" renamer can be built with support for regular ex-
pressions using the Perl-compatible regular expression (PCRE) library
version 6.0 or above. The reasons to use PCRE instead of the POSIX regular
expressions, that are part of the system C library, are:
The "Search & Replace" renamer can be built with support for regular expressions using the Perl-compatible regular expression (PCRE) library version 6.0 or above. The reasons to use PCRE instead of the POSIX regular expressions, that are part of the system C library, are:
* PCRE supports UTF-8, which Thunar uses internally for all user visible
texts (be sure to enable this when installing PCRE using the --enable-utf8
configure switch).
* PCRE uses a more consistent syntax, which is easier to understand for
most people.
* PCRE supports UTF-8, which Thunar uses internally for all user visible texts (be sure to enable this when installing PCRE using the `--enable-utf8` configure switch).
* PCRE uses a more consistent syntax, which is easier to understand for most people.
......@@ -34,7 +34,7 @@ desktop_DATA = $(desktop_in_files:.desktop.in=.desktop)
EXTRA_DIST = \
$(desktop_in_in_files) \
README
README.md
DISTCLEANFILES = \
$(desktop_in_files) \
......
Thunar Sendto Email (thunar-sendto-email)
=========================================
Thunar-sendto-email is an extension to Thunar, which adds an additional entry
to the "Send To" sub menu, named "Mail Recipient", that starts the mail composer
and attaches the selected files (using the exo-open mechanism).
Thunar-sendto-email is an extension to Thunar, which adds an additional entry to the "Send To" sub menu, named "Mail Recipient", that starts the mail composer and attaches the selected files (using the exo-open mechanism).
The extension uses the zip command to compress folders prior to sending them
to the mail client, since most mail clients cannot handle directories as at-
tachments. For regular files, larger than 200KiB, the extension prompts the
user whether to compress the files (using the zip command) prior to sending
them to the mail client.
The extension uses the zip command to compress folders prior to sending them to the mail client, since most mail clients cannot handle directories as attachments. For regular files, larger than 200KiB, the extension prompts the user whether to compress the files (using the zip command) prior to sending them to the mail client.
......@@ -54,7 +54,7 @@ endif
EXTRA_DIST = \
$(desktop_in_files) \
thunar-tpa-bindings.xml \
README
README.md
CLEANFILES = \
$(desktop_DATA)
......
Thunar Trash Panel Applet (thunar-tpa)
======================================
Thunar-tpa is an extension for the Xfce Panel, which enables users to add a
trash can to their panel, that
Thunar-tpa is an extension for the Xfce Panel, which enables users to add a trash can to their panel, that
* displays the current state of the trash can
* can move files to the trash by dropping them on the trash icon
* can empty the trash can
* can open the trash can
In order to build and install this plugin, you will need to have the xfce4-panel
development headers and libraries installed (the appropriate package is usually
called xfce4-panel-dev or xfce4-panel-devel). In addition, you'll need to have
D-BUS 0.34 or above installed and Thunar must be built with D-BUS support.
In order to build and install this plugin, you will need to have the xfce4-panel development headers and libraries installed (the appropriate package is usually called xfce4-panel-dev or xfce4-panel-devel). In addition, you'll need to have D-BUS 0.34 or above installed and Thunar must be built with D-BUS support.
How does it work?
=================
To avoid running several desktop processes that all monitor and manage the
trash can by itself, and thereby create an unnecessary maintaince and resource
overhead, the trash applet simply connects to Thunar via D-BUS to query the
state of the trash and send commands to the Trash.
To avoid running several desktop processes that all monitor and manage the trash can by itself, and thereby create an unnecessary maintaince and resource overhead, the trash applet simply connects to Thunar via D-BUS to query the state of the trash and send commands to the Trash.
The trash applet is not limited to Thunar, but can work with any file manager
that implements the org.xfce.Trash interface and owns the org.xfce.FileManager
service. See the thunar-tpa-bindings.xml file for a details about the inter-
face.
The trash applet is not limited to Thunar, but can work with any file manager that implements the org.xfce.Trash interface and owns the org.xfce.FileManager service. See the thunar-tpa bindings.xml file for a details about the inter- face.
......@@ -71,7 +71,7 @@ defaults_DATA = $(defaults_in_files:.xml.in=.xml)
@INTLTOOL_XML_RULE@
EXTRA_DIST = \
README \
README.md \
thunar-uca.gresource.xml \
thunar-uca-editor.ui \
thunar-uca-chooser.ui \
......
Thunar User Customizable Actions (thunar-uca)
=============================================
Thunar-uca is an extension to Thunar, which enables sophisticated users to add
additional actions to the file managers context menus, without having to write
their own extensions for each and every action they want to use.
By default the thunar-uca extension will be installed, but as with every
extension, it will slightly increase the resource usage of Thunar (this
shouldn't be a real problem unless you're targeting an embedded system), and so
can you pass `--disable-uca-plugin' to configure and the plugin won't be built
and installed. Since it is an extension, you can also easily uninstall it
afterwards by removing the thunar-uca.so file from the lib/thunarx-2/ directory
of your installation (be sure to quit Thunar before removing files though).
To actually manage the actions open the "Edit" menu in the menu bar of a
Thunar window and select "Configure Custom Actions...". A dialog will appear
which lists the currently configured actions.
List of valid command parameter variables
=========================================
%f The path of the first selected file.
%F The paths to all selected files.
%u The URI of the first selected file (using the file:-URI scheme).
%U The URIs of all selected files (using the file:-URI scheme).
%d The directory of the first selected file.
%D The directories to all selected files.
%n The name of the first selected file (without the path).
%N The names of all selected files (without the paths).
Thunar User Customizable Actions (thunar-uca)
=============================================
Thunar-uca is an extension to Thunar, which enables sophisticated users to add additional actions to the file managers context menus, without having to write their own extensions for each and every action they want to use.
By default the thunar-uca extension will be installed, but as with every extension, it will slightly increase the resource usage of Thunar (this shouldn't be a real problem unless you're targeting an embedded system), and so can you pass `--disable-uca-plugin` to configure and the plugin won't be built and installed. Since it is an extension, you can also easily uninstall it
afterwards by removing the thunar-uca.so file from the lib/thunarx-2/ directory of your installation (be sure to quit Thunar before removing files though).
To actually manage the actions open the "Edit" menu in the menu bar of a Thunar window and select "Configure Custom Actions...". A dialog will appear which lists the currently configured actions.
List of valid command parameter variables
=========================================
| Variable | Usage |
| :------------ | :------------ |
| %f | The path of the first selected file. |
| %F | The paths to all selected files. |
|%u |The URI of the first selected file (using the file:-URI scheme). |
|%U |The URIs of all selected files (using the file:-URI scheme). |
| %d |The directory of the first selected file. |
| %D |The directories to all selected files. |
| %n |The name of the first selected file (without the path). |
|%N |The names of all selected files (without the paths). |
\ No newline at end of file
Thunar Wallpaper Plugin (thunar-wallpaper)
===========================================
The Thunar Wallpaper plugin is an extension to Thunar. It depends on the
xfconf-query command line to set the correct settings on the Xfce4 desktop.
The Thunar Wallpaper plugin is an extension to Thunar. It depends on the xfconf-query command line to set the correct settings on the Xfce4 desktop.
To disable this plugin, pass --disable-wallpaper-plugin to ./configure.
To disable this plugin, pass `--disable-wallpaper-plugin` to ./configure.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment