Skip to content

Commit a7c06fb

Browse files
committed
Update README.md
1 parent f40d2b1 commit a7c06fb

File tree

2 files changed

+18
-31
lines changed

2 files changed

+18
-31
lines changed

README.md

+12-17
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
[![Latest Version](https://img.shields.io/crates/v/run-or-raise.svg)](https://crates.io/crates/run-or-raise)
55
[![GitHub release](https://img.shields.io/github/release/Soft/run-or-raise.svg)](https://github.com/Soft/run-or-raise/releases)
66
[![dependency status](https://deps.rs/repo/github/soft/run-or-raise/status.svg)](https://deps.rs/repo/github/soft/run-or-raise)
7-
[![Rust Documentation](https://img.shields.io/badge/api-rustdoc-blue.svg)](https://docs.rs/crate/run-or-raise)
87
[![AUR version](https://img.shields.io/aur/version/run-or-raise.svg)](https://aur.archlinux.org/packages/run-or-raise/)
98
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
109

@@ -17,36 +16,32 @@ This can be useful when combined with a tiling window manager such as
1716
[i3](https://i3wm.org) or a general purpose keyboard shortcut manager such as
1817
[xbindkeys](http://www.nongnu.org/xbindkeys/) that allow binding arbitrary
1918
commands to keybindings. In such setup, one might use `run-or-raise` to, for
20-
example, launch or focus a web browser with a single key.
19+
example, launch or focus a web browser with a single key press.
2120

2221
`run-or-raise` is designed to work with X11 based Linux systems.
2322

2423
## Installation
2524

26-
The easiest way to obtain the latest version of `run-or-raise` is to download a
27-
precompiled, statically-linked, program binary from [GitHub releases
28-
page](https://github.com/Soft/run-or-raise/releases). These binaries should work
29-
on most recent Linux systems without any additional dependencies.
30-
31-
Alternatively, `run-or-raise` can be easily installed from the source using
25+
`run-or-raise` can be installed using
3226
[cargo](https://doc.rust-lang.org/cargo/index.html):
3327

3428
``` shell
35-
$ cargo install run-or-raise
29+
cargo install run-or-raise
3630
```
3731

3832
Compiling and running `run-or-raise` requires [libxcb](https://xcb.freedesktop.org)
39-
library to be installed. To get the latest development version of
40-
`run-or-raise`, you can direct cargo to install from the git repository:
33+
library to be installed.
34+
35+
To get the latest development version of `run-or-raise`, you can direct cargo to
36+
install from the git repository:
4137

4238
``` shell
43-
$ cargo install --git 'https://github.com/Soft/run-or-raise.git'
39+
cargo install --git 'https://github.com/Soft/run-or-raise.git'
4440
```
4541

46-
However, just downloading the application binary or installing with cargo will
47-
not install program’s man page. To also get the manual pages installed, invoke
48-
`make install` in the project directory. By default, the install script will
49-
place the files under `/usr/local/` hierarchy.
42+
Note that cargo will not install man pages. To install `run-or-raise` along with
43+
its manual invoke `make install` in the project directory. By default, the
44+
installation script will place the files under `/usr/local/` hierarchy.
5045

5146
## Usage
5247

@@ -55,7 +50,7 @@ run-or-raise CONDITION PROGRAM [ARGS...]
5550
```
5651

5752
When invoked, `run-or-raise` matches existing windows against `CONDITION`. If a
58-
matching window is found, it is focused. If none of the windows fulfill the
53+
matching window is found, it is focused. If none of the windows match the
5954
criteria, `run-or-raise` executes `PROGRAM` passing any `ARGS` to it as
6055
arguments.
6156

man/run-or-raise.1

+6-14
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,20 @@
1-
.TH RUN-OR-RAISE 1 2018
2-
1+
.TH RUN-OR-RAISE 1 2021
32
.SH NAME
43
run\-or\-raise \- utility for launching applications or focusing their windows
5-
64
.SH SYNOPSIS
7-
85
.B run\-or\-raise
96
\fICONDITION PROGRAM\fR [\fIARGS\fR...]
10-
117
.SH DESCRIPTION
12-
138
\fBrun\-or\-raise\fR is a utility for launching applications or focusing their
149
windows. When invoked, \fBrun\-or\-raise\fR matches existing windows against
1510
\fICONDITION\fR. If a matching window is found, it is focused. If none of the
16-
windows fulfill the criteria, \fBrun\-or\-raise\fR executes \fIPROGRAM\fR
17-
passing any \fIARGS\fR to it as arguments.
18-
11+
windows match the criteria, \fBrun\-or\-raise\fR executes \fIPROGRAM\fR passing
12+
any \fIARGS\fR to it as arguments.
1913
.SH CONDITIONS
20-
2114
Conditions select windows based on their properties. Conditions support two
2215
comparison operators: \fB=\fR for exact equality comparison with a string
2316
literal and \fB~\fR work comparing with a regular expression.
24-
17+
.P
2518
Comparisons can be combined using logical operators: \fB&&\fR for logical
2619
\fIAND\fR, \fB||\fR for logical \fIOR\fR, and \fB!\fR for logical \fINOT\fR.
2720
Operators in matching expressions are left-associative and \fB!\fR (not) binds
@@ -30,10 +23,10 @@ Possible properties are \fBclass\fR, \fBname\fR, and \fBrole\fR. Additionally,
3023
parentheses can be used to alter evaluation order. Strings and regular
3124
expressions are written inside double quotes. If multiple windows match the
3225
criteria, the first matching window is selected.
33-
26+
.P
3427
Bellow are some examples of how conditions can be used to select windows in
3528
various ways:
36-
29+
.P
3730
.nf
3831
.RS
3932
# Launch or focus emacs
@@ -48,6 +41,5 @@ run-or-raise 'name ~ ".*Firefox$"' firefox
4841
run-or-raise 'role = "browser" && ! class = "Chromium"' firefox
4942
.RE
5043
.fi
51-
5244
.SH AUTHORS
5345
Samuel Laurén <samuel.lauren@iki.fi>

0 commit comments

Comments
 (0)