summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorAlexander Schwinn <alexxcons@xfce.org>2020-05-14 20:23:45 +0200
committerAlexander Schwinn <alexxcons@xfce.org>2020-05-14 20:23:45 +0200
commit48503ff6d7a6f08fa8effe02c364f39f68c90f11 (patch)
tree43b35029d85fae1391d96bb0301fb47720392231 /plugins
parentc3aae2e7d9aa901b5b7efa2f36fe636a4903c9ab (diff)
downloadthunar-48503ff6d7a6f08fa8effe02c364f39f68c90f11.tar.gz
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
Diffstat (limited to 'plugins')
-rw-r--r--plugins/thunar-apr/Makefile.am2
-rw-r--r--plugins/thunar-apr/README29
-rw-r--r--plugins/thunar-apr/README.md13
-rw-r--r--plugins/thunar-sbr/Makefile.am2
-rw-r--r--plugins/thunar-sbr/README37
-rw-r--r--plugins/thunar-sbr/README.md24
-rw-r--r--plugins/thunar-sendto-email/Makefile.am2
-rw-r--r--plugins/thunar-sendto-email/README12
-rw-r--r--plugins/thunar-sendto-email/README.md6
-rw-r--r--plugins/thunar-tpa/Makefile.am2
-rw-r--r--plugins/thunar-tpa/README30
-rw-r--r--plugins/thunar-tpa/README.md20
-rw-r--r--plugins/thunar-uca/Makefile.am2
-rw-r--r--plugins/thunar-uca/README38
-rw-r--r--plugins/thunar-uca/README.md23
-rw-r--r--plugins/thunar-wallpaper/README7
-rw-r--r--plugins/thunar-wallpaper/README.md6
17 files changed, 97 insertions, 158 deletions
diff --git a/plugins/thunar-apr/Makefile.am b/plugins/thunar-apr/Makefile.am
index b0ed555f..e78e3863 100644
--- a/plugins/thunar-apr/Makefile.am
+++ b/plugins/thunar-apr/Makefile.am
@@ -51,6 +51,6 @@ thunar_apr_la_DEPENDENCIES = \
EXTRA_DIST = \
- README
+ README.md
# vi:set ts=8 sw=8 noet ai nocindent syntax=automake:
diff --git a/plugins/thunar-apr/README b/plugins/thunar-apr/README
deleted file mode 100644
index 7ae42c12..00000000
--- a/plugins/thunar-apr/README
+++ /dev/null
@@ -1,29 +0,0 @@
-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).
-
diff --git a/plugins/thunar-apr/README.md b/plugins/thunar-apr/README.md
new file mode 100644
index 00000000..8d1fbc83
--- /dev/null
+++ b/plugins/thunar-apr/README.md
@@ -0,0 +1,13 @@
+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
diff --git a/plugins/thunar-sbr/Makefile.am b/plugins/thunar-sbr/Makefile.am
index a05b014a..dbf7e268 100644
--- a/plugins/thunar-sbr/Makefile.am
+++ b/plugins/thunar-sbr/Makefile.am
@@ -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:
diff --git a/plugins/thunar-sbr/README b/plugins/thunar-sbr/README
deleted file mode 100644
index d2a11887..00000000
--- a/plugins/thunar-sbr/README
+++ /dev/null
@@ -1,37 +0,0 @@
-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:
-
- * Insert / Overwrite
- * Insert Date / Time
- * Numbering
- * Remove Characters
- * 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).
-
-
-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:
-
- * 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.
-
-
diff --git a/plugins/thunar-sbr/README.md b/plugins/thunar-sbr/README.md
new file mode 100644
index 00000000..f2000810
--- /dev/null
+++ b/plugins/thunar-sbr/README.md
@@ -0,0 +1,24 @@
+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:
+
+ * Insert / Overwrite
+ * Insert Date / Time
+ * Numbering
+ * Remove Characters
+ * 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).
+
+
+Regular Expressions
+-------------------
+
+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.
+
+
diff --git a/plugins/thunar-sendto-email/Makefile.am b/plugins/thunar-sendto-email/Makefile.am
index a9fdf446..379a5428 100644
--- a/plugins/thunar-sendto-email/Makefile.am
+++ b/plugins/thunar-sendto-email/Makefile.am
@@ -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) \
diff --git a/plugins/thunar-sendto-email/README b/plugins/thunar-sendto-email/README
deleted file mode 100644
index 26019266..00000000
--- a/plugins/thunar-sendto-email/README
+++ /dev/null
@@ -1,12 +0,0 @@
-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).
-
-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.
diff --git a/plugins/thunar-sendto-email/README.md b/plugins/thunar-sendto-email/README.md
new file mode 100644
index 00000000..4d3b1989
--- /dev/null
+++ b/plugins/thunar-sendto-email/README.md
@@ -0,0 +1,6 @@
+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).
+
+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.
diff --git a/plugins/thunar-tpa/Makefile.am b/plugins/thunar-tpa/Makefile.am
index dd093ec1..7ffcea57 100644
--- a/plugins/thunar-tpa/Makefile.am
+++ b/plugins/thunar-tpa/Makefile.am
@@ -54,7 +54,7 @@ endif
EXTRA_DIST = \
$(desktop_in_files) \
thunar-tpa-bindings.xml \
- README
+ README.md
CLEANFILES = \
$(desktop_DATA)
diff --git a/plugins/thunar-tpa/README b/plugins/thunar-tpa/README
deleted file mode 100644
index 319df842..00000000
--- a/plugins/thunar-tpa/README
+++ /dev/null
@@ -1,30 +0,0 @@
-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
-
- * 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.
-
-
-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.
-
-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.
-
diff --git a/plugins/thunar-tpa/README.md b/plugins/thunar-tpa/README.md
new file mode 100644
index 00000000..0946b3e9
--- /dev/null
+++ b/plugins/thunar-tpa/README.md
@@ -0,0 +1,20 @@
+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
+
+ * 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.
+
+
+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.
+
+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.
+
diff --git a/plugins/thunar-uca/Makefile.am b/plugins/thunar-uca/Makefile.am
index c1944691..84ec0d02 100644
--- a/plugins/thunar-uca/Makefile.am
+++ b/plugins/thunar-uca/Makefile.am
@@ -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 \
diff --git a/plugins/thunar-uca/README b/plugins/thunar-uca/README
deleted file mode 100644
index 9a3fda9b..00000000
--- a/plugins/thunar-uca/README
+++ /dev/null
@@ -1,38 +0,0 @@
-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).
diff --git a/plugins/thunar-uca/README.md b/plugins/thunar-uca/README.md
new file mode 100644
index 00000000..e6b2ff03
--- /dev/null
+++ b/plugins/thunar-uca/README.md
@@ -0,0 +1,23 @@
+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
diff --git a/plugins/thunar-wallpaper/README b/plugins/thunar-wallpaper/README
deleted file mode 100644
index fb880f12..00000000
--- a/plugins/thunar-wallpaper/README
+++ /dev/null
@@ -1,7 +0,0 @@
-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.
-
-To disable this plugin, pass --disable-wallpaper-plugin to ./configure.
diff --git a/plugins/thunar-wallpaper/README.md b/plugins/thunar-wallpaper/README.md
new file mode 100644
index 00000000..0176291c
--- /dev/null
+++ b/plugins/thunar-wallpaper/README.md
@@ -0,0 +1,6 @@
+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.
+
+To disable this plugin, pass `--disable-wallpaper-plugin` to ./configure.