aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMrt134 <timmoore88@gmail.com>2017-03-30 12:35:30 -0400
committerMrt134 <timmoore88@gmail.com>2017-03-30 12:35:30 -0400
commit5bef811947f2b6c904fc7342a2e1e55d40a56da5 (patch)
treefa128eb4dedf4b3890077719beef340f76cd227e
parentMerge remote-tracking branch 'origin/master' (diff)
downloadlumina-5bef811947f2b6c904fc7342a2e1e55d40a56da5.tar.gz
lumina-5bef811947f2b6c904fc7342a2e1e55d40a56da5.tar.bz2
lumina-5bef811947f2b6c904fc7342a2e1e55d40a56da5.zip
Add new lumina-open manpage:
- Adjusts lumina build system to have additional variables for manpage placement and generation.
-rw-r--r--src-qt5/OS-detect.pri5
-rw-r--r--src-qt5/core/lumina-open/lumina-open.1114
-rw-r--r--src-qt5/core/lumina-open/lumina-open.pro5
3 files changed, 122 insertions, 2 deletions
diff --git a/src-qt5/OS-detect.pri b/src-qt5/OS-detect.pri
index 4ac280cf..eb7fd231 100644
--- a/src-qt5/OS-detect.pri
+++ b/src-qt5/OS-detect.pri
@@ -16,6 +16,7 @@
# L_SHAREDIR: Directory to install the general Lumina files
# L_INCLUDEDIR: Directory to install include files
# L_SESSDIR: Directory to place *.desktop file for starting the Lumina session
+# L_MANDIR: Directory to place man files
# LRELEASE: binary path to the Qt lrelease utility (usually auto-set)
# =============================================
# Note: Make sure the OS variable matches the name of a libLumina/LuminaOS-<OS>.cpp file
@@ -93,8 +94,9 @@ isEmpty(OS){
isEmpty(L_SHAREDIR){ L_SHAREDIR = $${PREFIX}/share }
isEmpty(L_INCLUDEDIR){ L_INCLUDEDIR = $${PREFIX}/include }
isEmpty(L_SESSDIR){ L_SESSDIR = $${L_SHAREDIR}/xsessions }
+ isEmpty(L_MANDIR){ L_MANDIR = $${PREFIX}/man }
isEmpty(LRELEASE){ LRELEASE = $$[QT_INSTALL_BINS]/lrelease }
-
+ isEmpty(MAN_ZIP){ MAN_ZIP = "gzip -c" }
!exists(LRELEASE){ NO_I18N=true } #translations unavailable
#Now convert any of these install path variables into defines for C++ usage
@@ -110,5 +112,6 @@ isEmpty(OS){
L_SHAREDIR = $$DESTDIR$${L_SHAREDIR}
L_INCLUDEDIR = $$DESTDIR$${L_INCLUDEDIR}
L_SESSDIR = $$DESTDIR$${L_SESSDIR}
+ L_MANDIR = $$DESTDIR$${L_MANDIR}
}
}
diff --git a/src-qt5/core/lumina-open/lumina-open.1 b/src-qt5/core/lumina-open/lumina-open.1
new file mode 100644
index 00000000..e8c555ee
--- /dev/null
+++ b/src-qt5/core/lumina-open/lumina-open.1
@@ -0,0 +1,114 @@
+.Dd March 29, 2017
+.Dt LUMINA-OPEN 1
+.Os Lumina Desktop Environment
+.\"-------------------------------------------------------------------
+.Sh NAME
+.Nm lumina-open
+.Nd Application launcher for the Lumina Desktop Environment.
+.\"-------------------------------------------------------------------
+.Sh SYNOPSIS
+.Nm
+.Pp
+.Nm
+.Cm [-select | -action <ActionID>] <file path or URL>
+.Pp
+.Nm
+.Cm [-volumeup | -volumedown | -brightnessup | -brightnessdown |
+-autostart-apps | -terminal]
+.\"-------------------------------------------------------------------
+.Sh DESCRIPTION
+Given a file with an absolute pathway or URL, the
+.Nm
+utility finds the appropriate application which which to open the
+file. If the file is a *.desktop application shortcut,
+.Nm
+starts the application automatically. Using the appropriate flags
+allows
+.Nm
+to perform a few specific system operations. Here are the commands,
+flags, and descriptions of their functionality:
+.Pp
+.Bl -tag -width indent
+.It Ic lumina-open
+Displays the description and usage for lumina-open.
+.It Ic lumina-open [-select | -action <ActionID>] <file path or URL>
+Opens the file using the appropriate application.
+.It Fl select
+Optional flag. Bypasses any default application settings to display
+the application selector window.
+.It Fl action\ <ActionID>
+Optional flag. Runs the specified ActionID that is listed in
+a .desktop registration file rather than the main command.
+.It Ic lumina-open [-volumeup | -volumedown | -brightnessup |
+-brightnessdown | -autostart-apps | -terminal]
+.Pp
+This command is used to perform system operations, depending on the
+specific flags.
+.It Fl volumeup
+Increase system audio volume by 5%.
+.It Fl volumedown
+Decrease system audio volume by 5%.
+.It Fl brightnessup
+Increase screen brightness by 5%.
+.It Fl brightnessdown
+Decrease screen brightness by 5%.
+.It Fl autostart-apps
+Launches all applications registered with the XDG autostart
+application. Typically run by the desktop and not manually launched.
+.It Fl terminal
+Open the user's default terminal.
+.El
+.\"-------------------------------------------------------------------
+.Sh EXAMPLES
+.Bl -tag -width indent
+.It lumina-open -brightnessup
+Increase screen brightness.
+.Pp
+.It lumina-open sample.txt
+.Nm
+finds the default program for .txt files and opens sample.txt with
+the appropriate application.
+.It lumina-open ~/Documents
+.Nm
+launches the default file manager, pointed to the current user's
+Documents directory.
+.It lumina-open http://lumina-desktop.org
+Launches the default web browser pointed to the Lumina website.
+.El
+.\"-------------------------------------------------------------------
+.Sh FILES
+.Bl -tag -width indent
+.It Pa ${XDG_CONFIG_HOME}/mimeapps.list
+Default file that saves mimetype to application associations.
+.It Pa ${XDG_CONFIG_HOME}/${XDG_CURRENT_DESKTOP}-mimeapps.list
+Default file that saves mimetype to application associations for the
+current desktop session. This file is used before the generic
+associations file.
+.El
+.\"-------------------------------------------------------------------
+.Sh SEE ALSO
+.Xr XDG-OPEN(1)
+.\"-------------------------------------------------------------------
+.Sh REFERENCES
+For .desktop entry specifications and formatting, refer to these
+websites:
+.Bl -tag -width indent
+.Pp
+.Cm https://specifications.freedesktop.org/desktop-entry-spec/latest/
+.Pp
+Specifications for .desktop files.
+.Pp
+.Cm https://specifications.freedesktop.org/mime-apps-spec/latest/
+.Pp
+Details how default applications are registered.
+.Pp
+.Cm https://specifications.freedesktop.org/autostart-spec/latest/
+.Pp
+Used in the -autostart-apps action. Determines which applications
+are automatically started.
+.Pp
+.El
+.\"-------------------------------------------------------------------
+.Sh AUTHOR
+.An Tim Moore
+.Aq timmoore88@gmail.com
diff --git a/src-qt5/core/lumina-open/lumina-open.pro b/src-qt5/core/lumina-open/lumina-open.pro
index 96d879bd..1110a2fa 100644
--- a/src-qt5/core/lumina-open/lumina-open.pro
+++ b/src-qt5/core/lumina-open/lumina-open.pro
@@ -88,7 +88,10 @@ TRANSLATIONS = i18n/lumina-open_af.ts \
dotrans.path=$${L_SHAREDIR}/lumina-desktop/i18n/
dotrans.extra=cd i18n && $${LRELEASE} -nounfinished *.ts && cp *.qm $(INSTALL_ROOT)$${L_SHAREDIR}/lumina-desktop/i18n/
-INSTALLS += target
+manpage.path=$${L_MANDIR}/man1/
+manpage.extra="$${MAN_ZIP} lumina-open.1 > $(INSTALL_ROOT)$${L_MANDIR}/man1/lumina-open.1.gz"
+
+INSTALLS += target manpage
WITH_I18N{
INSTALLS += dotrans
bgstack15