novaburst
/
gmrun
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

add gmrun.1 (manual)

This commit is contained in:
wdlkmpx 2020-10-07 00:57:40 +08:00
parent 771e5f5cfa
commit b00981c4b3
2 changed files with 74 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
data/Makefile.am
View File

@ -6,3 +6,5 @@ app_DATA = gmrun.desktop
icondir = $(datadir)/pixmaps
icon_DATA = gmrun.png
manualdir = $(mandir)/man1
manual_DATA = gmrun.1

72
data/gmrun.1 Normal file
View File

@ -0,0 +1,72 @@
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH gmrun 1 "2020"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
.\" .ad l left justify
.\" .ad b justify to both left and right margins
.\" .nf disable filling
.\" .fi enable filling
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
gmrun \- Featureful CLI-like GTK+ application launcher
.SH SYNOPSIS
.B gmrun \fR\fI[TEXT]\fR
.br
.SH DESCRIPTION
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
\fBgmrun\fP is a GTK program that allows a user to use a CLI-like interface to launch applications.
.SH OPTIONS
If gmrun is invoked with a command-line parameter, that will be the initial content of the dialog box.
.PP
gmrun can be customized using a configuration file, ~/.gmrunrc . The system-wide configuration file is /etc/gmrunrc .
.PP
The format of the configuration file is simple; "variable = value".
.TP
.B Example:
variable1 = foobar
.br
.TP
.B Terminal
The command to run when Ctrl+Enter is pressed with no command entered; used to start a new terminal.
.TP
.B TermExec
The command to run when Ctrl+Enter is pressed with a command entered. The entered command is supplied as an argument to TermExec.
.TP
.B Geometry
see /etc/gmrunrc for more info
.TP
.B History
Number of entered commands which should be kept in gmrun's history(~/.gmrun_history). Using the Up and Down arrow keys within the gmrun window will cycle through the history. You can search backwards through the history with Ctrl+R, and forward with Ctrl+S. To cancel a search, hit the \fIESC\fP key. Otherwise, after you have found the history item you wish to run, hit Enter.
.TP
.B ShowLast
Whether to show the last command as initial text, or an empty textarea (1 or 0).
.TP
.B Selected
Whether the initial text should be selected or not (1 or 0).
.SH URL/File HANDLING
.TP
.B USE_XDG = 1
For automatic URL and File handling using the freedesktop specification.
.TP
See /etc/gmrunrc for custom URL and extension handlers (USE_XDG = 0)
.TP
The included configuration files have a few examples which you can work with. You should also note that the protocol part of URL_protocol can be *anything*. You can set up "URL_foobarbazcustom", and so long as you enter in "foobarbazcustom:<whatever>", it will use the given program.
.SH SEE ALSO
.BR /etc/gmrunrc.
.br
.SH AUTHOR
Originally written by
.B Mihai Bazon
, the latest version is available from
\fIhttps://github.com/wdlkmpx/gmrun/\fP
.PP
This manual page was originally written by David B Harris <david@eelf.ddts.net>