-
Notifications
You must be signed in to change notification settings - Fork 4
/
xstarter.1
103 lines (93 loc) · 2.83 KB
/
xstarter.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
.\" Manpage for xstarter.
.TH xstarter 1 "13 Sep 2022" "0.8.2" "xstarter man page"
.SH NAME
xstarter \- application launcher
.SH SYNOPSIS
xstarter
.SH DESCRIPTION
.LP
xstarter is a free (GPL) ncurses-based terminal launcher for Linux
.SH FEATURES
.TP
* a clean, simple interface that works on various terminals
.TP
* able to search for applications using environment variables (e.g. `$PATH`) and user-provided list of directories
.TP
* can be configured to launch via a key-binding
.TP
* can optionally open an application in terminal (see key shortcuts)
.TP
* allows to provide arguments to applications (see key shortcuts)
.TP
* remembers previously launched applications allowing to find them more quickly
.TP
* allows fuzzy search (parts of the query can be separated with a space)
.TP
* applications can be launched with 1, 2, ..., 0 keys, depending on their position in the search results
.TP
* fast, uses cache by default
.TP
* easy to configure via a single text file
.TP
* is able to run an application and detach it from terminal (e.g. xstarter -e firefox)
.TP
* can provide contents of the cache to outside programs (xstarter -P)
.SH USAGE
.TP
xstarter needs to be launched from a terminal. It is useful to run it using a key binding, preferably by binding your preferred key to a command starting xstarter from a terminal of your choice, e.g. xterm -e xstarter. Alternatively, you can simply bind it to xstarter in which case xstarter will open itself in a terminal.
.TP
You can also create an alias in your shell (e.g. bash, zsh): alias xs=xstarter.
.TP
It should run on any modern terminal. It is tested on: xterm, rxvt, gnome-terminal, xfce4-terminal, konsole. In case of any problems please report it: (https://github.com/lchsk/xstarter/issues/new).
.SH CONFIGURATION
Configuration file "xstarter.conf" is available in the main repository and includes comments that explain configuration variables. By default, it should be placed in the ~/.xstarter.d/ directory.
.SH KEY SHORTCUTS
Use numbers 1..9 and 0 to open an application from the list.
By default, the following shortcuts are available:
.TP
Return (enter)
Open selected application
.TP
C-o
Open selected application in terminal (defined by "terminal" variable in the config file, xterm by default)
.TP
C-n / Down
Move down the list
.TP
C-p / Up
Move up the list
.TP
C-g / Esc
Quit
.TP
C-d / Backspace
Delete entered character
.TP
C-w
Delete entire query
.TP
Tab
Auto-complete using current selection; allow to provide arguments
.SH UPDATE
See https://lchsk.com/xstarter.html or https://github.com/lchsk/xstarter to get the latest version.
.SH OPTIONS
.LP
.TP
\fB\-h\fR
Show help screen
.TP
\fB\-v\fR
Show xstarter version
.TP
\fB\-V\fR
Be verbose
.TP
\fB\-r\fR
Refresh cache
.TP
\fB\-c\fR
Path to the configuration file
.SH BUGS
No known bugs.
.SH AUTHOR
Maciej Lechowski (https://github.com/lchsk https://lchsk.com)