Skip to content

Commit 6006280

Browse files
SimonSchubertSimonSchubert
committed
Add commands
1 parent 4dac6b7 commit 6006280

7 files changed

Lines changed: 495 additions & 0 deletions

File tree

‎assets/commands/con2fbmap.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# TAGLINE
2+
3+
Show or set console-to-framebuffer mappings
4+
5+
# TLDR
6+
7+
**Show** which framebuffer device is mapped to console 1
8+
9+
```con2fbmap 1```
10+
11+
**Map** console 1 to framebuffer device 0
12+
13+
```con2fbmap 1 0```
14+
15+
**Map** console 3 to framebuffer device 1
16+
17+
```con2fbmap 3 1```
18+
19+
# SYNOPSIS
20+
21+
**con2fbmap** _console_ [_framebuffer_]
22+
23+
# PARAMETERS
24+
25+
**console**
26+
> The virtual console number to query or modify (required).
27+
28+
**framebuffer**
29+
> The framebuffer device number to map the console to. If omitted, the current mapping is displayed.
30+
31+
# DESCRIPTION
32+
33+
**con2fbmap** shows or sets the mapping between Linux virtual consoles and framebuffer devices. Framebuffer devices provide a unified interface for accessing graphics displays and are accessed through device nodes **/dev/fb\<n\>**, where **n** is the device number.
34+
35+
When called with only a console number, it displays the current framebuffer mapping for that console. When called with both a console number and a framebuffer number, it reassigns the console to use the specified framebuffer device.
36+
37+
This is useful on systems with multiple graphics adapters or displays, allowing different virtual consoles to render on different screens.
38+
39+
# CAVEATS
40+
41+
Requires root privileges to change mappings. Only works on systems using the Linux framebuffer subsystem. On modern systems using KMS/DRM, framebuffer devices may be provided through the **vesafb**, **simplefb**, or DRM framebuffer emulation layers.
42+
43+
# HISTORY
44+
45+
**con2fbmap** is part of the **fbset** package, a collection of framebuffer utilities for Linux. The framebuffer subsystem was introduced in **Linux 2.1.107** in **1998**, originally ported from the Amiga and Atari Linux kernels. The fbset package was maintained by **Geert Uytterhoeven** as part of the early Linux framebuffer infrastructure.
46+
47+
# SEE ALSO
48+
49+
[fbset](/man/fbset)(1), [setterm](/man/setterm)(1)

‎assets/commands/index.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1251,6 +1251,7 @@ compress.md
12511251
compseq.md
12521252
compsize.md
12531253
compton.md
1254+
con2fbmap.md
12541255
conan.md
12551256
concourse.md
12561257
conda-activate.md
@@ -6050,12 +6051,16 @@ pw-cli.md
60506051
pw-config.md
60516052
pw-container.md
60526053
pw-dot.md
6054+
pw-dsdplay.md
60536055
pw-dump.md
6056+
pw-encplay.md
60546057
pw-jack.md
60556058
pw-link.md
60566059
pw-loopback.md
60576060
pw-metadata.md
60586061
pw-mididump.md
6062+
pw-midiplay.md
6063+
pw-midirecord.md
60596064
pw-mon.md
60606065
pw-play.md
60616066
pw-profiler.md
@@ -6759,6 +6764,7 @@ showconsolefont.md
67596764
showfigfonts.md
67606765
showkey.md
67616766
showmount.md
6767+
shpool.md
67626768
shred.md
67636769
shuf.md
67646770
shutdown.md

‎assets/commands/pw-dsdplay.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# TAGLINE
2+
3+
Play DSD audio files through PipeWire
4+
5+
# TLDR
6+
7+
**Play a DSF file**
8+
9+
```pw-dsdplay [path/to/file.dsf]```
10+
11+
**Play with a specific volume**
12+
13+
```pw-dsdplay --volume [0.5] [path/to/file.dsf]```
14+
15+
**Play to a specific target node**
16+
17+
```pw-dsdplay --target [node_id] [path/to/file.dsf]```
18+
19+
**Play with verbose output**
20+
21+
```pw-dsdplay -v [path/to/file.dsf]```
22+
23+
# SYNOPSIS
24+
25+
**pw-dsdplay** [_options_] [_FILE_ | **-**]
26+
27+
# PARAMETERS
28+
29+
**--volume** _level_
30+
> Stream volume (default 1.0).
31+
32+
**--rate** _hz_
33+
> Sample rate in Hz (default 48000).
34+
35+
**--channels** _num_
36+
> Number of audio channels (default 2).
37+
38+
**--channel-map** _map_
39+
> Channel layout (e.g. stereo, surround-51, or custom FL,FR mapping).
40+
41+
**--format** _fmt_
42+
> Sample format: u8, s8, s16, s24, s32, f32, f64 (default s16).
43+
44+
**--target** _value_
45+
> Target node: auto, 0, or a specific node ID.
46+
47+
**--latency** _value_
48+
> Node latency (default 100ms).
49+
50+
**-q**, **--quality** _level_
51+
> Resampler quality (0-15, default 4).
52+
53+
**-R**, **--remote** _name_
54+
> Connect to a specific PipeWire instance.
55+
56+
**-P**, **--properties** _json_
57+
> Extra stream properties as a JSON object.
58+
59+
**-v**, **--verbose**
60+
> Enable verbose output.
61+
62+
**-h**, **--help**
63+
> Display help information.
64+
65+
**--version**
66+
> Show version details.
67+
68+
# DESCRIPTION
69+
70+
**pw-dsdplay** plays DSD (Direct Stream Digital) audio files in DSF format through a PipeWire server. It is a convenience wrapper for **pw-cat --playback --dsd**, making DSD data available to the PipeWire audio graph.
71+
72+
DSD is a high-resolution audio format used in Super Audio CDs (SACDs) that encodes audio as a stream of single-bit values at very high sample rates (typically 2.8224 MHz or higher). Native DSD playback requires compatible hardware that supports DSD natively.
73+
74+
When **-** is given as the file, data is read from stdin.
75+
76+
# CAVEATS
77+
78+
Requires native DSD-capable hardware to produce audible output. Without compatible hardware, no audio will be heard. DSF is the only supported file format for DSD playback.
79+
80+
# HISTORY
81+
82+
Part of **PipeWire**, the modern multimedia framework for Linux created by **Wim Taymans** at Red Hat. PipeWire was first released in **2017** and has become the default audio and video server in major Linux distributions, replacing both PulseAudio and JACK. The pw-cat family of tools provides simple command-line media playback and capture.
83+
84+
# SEE ALSO
85+
86+
[pw-cat](/man/pw-cat)(1), [pw-play](/man/pw-play)(1), [pw-record](/man/pw-record)(1), [pipewire](/man/pipewire)(1)

‎assets/commands/pw-encplay.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# TAGLINE
2+
3+
Play encoded audio streams through PipeWire
4+
5+
# TLDR
6+
7+
**Play an encoded audio file**
8+
9+
```pw-encplay [path/to/file]```
10+
11+
**Play with a specific volume**
12+
13+
```pw-encplay --volume [0.8] [path/to/file]```
14+
15+
**Play to a specific target node**
16+
17+
```pw-encplay --target [node_id] [path/to/file]```
18+
19+
**Play with verbose output**
20+
21+
```pw-encplay -v [path/to/file]```
22+
23+
# SYNOPSIS
24+
25+
**pw-encplay** [_options_] [_FILE_ | **-**]
26+
27+
# PARAMETERS
28+
29+
**--volume** _level_
30+
> Stream volume (default 1.0).
31+
32+
**--rate** _hz_
33+
> Sample rate in Hz (default 48000).
34+
35+
**--channels** _num_
36+
> Number of audio channels (default 2).
37+
38+
**--channel-map** _map_
39+
> Channel layout (e.g. stereo, surround-51, or custom FL,FR mapping).
40+
41+
**--format** _fmt_
42+
> Sample format: u8, s8, s16, s24, s32, f32, f64 (default s16).
43+
44+
**--target** _value_
45+
> Target node: auto, 0, or a specific node ID.
46+
47+
**--latency** _value_
48+
> Node latency (default 100ms).
49+
50+
**-q**, **--quality** _level_
51+
> Resampler quality (0-15, default 4).
52+
53+
**-R**, **--remote** _name_
54+
> Connect to a specific PipeWire instance.
55+
56+
**-P**, **--properties** _json_
57+
> Extra stream properties as a JSON object.
58+
59+
**-v**, **--verbose**
60+
> Enable verbose output.
61+
62+
**-h**, **--help**
63+
> Display help information.
64+
65+
**--version**
66+
> Show version details.
67+
68+
# DESCRIPTION
69+
70+
**pw-encplay** plays encoded (compressed) audio streams through a PipeWire server. It is a convenience wrapper for **pw-cat** in encoded playback mode, passing encoded audio data directly to the PipeWire graph without decoding it first.
71+
72+
This enables passthrough of compressed audio formats (such as AC3, DTS, or AAC) to hardware decoders or receivers that support native decoding, preserving the original encoded stream quality.
73+
74+
When **-** is given as the file, data is read from stdin.
75+
76+
# CAVEATS
77+
78+
Requires a sink that supports the encoded format for passthrough playback. If the connected output does not support the format, no audio will be produced. Typically used with HDMI or S/PDIF outputs connected to AV receivers.
79+
80+
# HISTORY
81+
82+
Part of **PipeWire**, the modern multimedia framework for Linux created by **Wim Taymans** at Red Hat. PipeWire was first released in **2017** and provides unified audio and video handling, replacing PulseAudio and JACK. The pw-cat family of tools provides simple command-line media playback and capture.
83+
84+
# SEE ALSO
85+
86+
[pw-cat](/man/pw-cat)(1), [pw-play](/man/pw-play)(1), [pw-record](/man/pw-record)(1), [pipewire](/man/pipewire)(1)

‎assets/commands/pw-midiplay.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# TAGLINE
2+
3+
Play MIDI files through PipeWire
4+
5+
# TLDR
6+
7+
**Play a MIDI file**
8+
9+
```pw-midiplay [path/to/file.mid]```
10+
11+
**Play with a specific volume**
12+
13+
```pw-midiplay --volume [0.5] [path/to/file.mid]```
14+
15+
**Play to a specific target node**
16+
17+
```pw-midiplay --target [node_id] [path/to/file.mid]```
18+
19+
**Play with verbose output**
20+
21+
```pw-midiplay -v [path/to/file.mid]```
22+
23+
# SYNOPSIS
24+
25+
**pw-midiplay** [_options_] [_FILE_ | **-**]
26+
27+
# PARAMETERS
28+
29+
**--volume** _level_
30+
> Stream volume (default 1.0).
31+
32+
**--rate** _hz_
33+
> Sample rate in Hz (default 48000).
34+
35+
**--channels** _num_
36+
> Number of audio channels (default 2).
37+
38+
**--channel-map** _map_
39+
> Channel layout (e.g. stereo, surround-51, or custom FL,FR mapping).
40+
41+
**--format** _fmt_
42+
> Sample format: u8, s8, s16, s24, s32, f32, f64 (default s16).
43+
44+
**--target** _value_
45+
> Target node: auto, 0, or a specific node ID.
46+
47+
**--latency** _value_
48+
> Node latency (default 100ms).
49+
50+
**-q**, **--quality** _level_
51+
> Resampler quality (0-15, default 4).
52+
53+
**-R**, **--remote** _name_
54+
> Connect to a specific PipeWire instance.
55+
56+
**-P**, **--properties** _json_
57+
> Extra stream properties as a JSON object.
58+
59+
**-v**, **--verbose**
60+
> Enable verbose output.
61+
62+
**-h**, **--help**
63+
> Display help information.
64+
65+
**--version**
66+
> Show version details.
67+
68+
# DESCRIPTION
69+
70+
**pw-midiplay** plays MIDI files through a PipeWire server. It is a convenience wrapper for **pw-cat --playback --midi**, making MIDI events available to the PipeWire audio graph.
71+
72+
The tool does not render MIDI into audible audio by itself. It sends MIDI events into the PipeWire graph where they must be routed to a MIDI synthesizer (such as **qsynth**, **fluidsynth**, or **timidity**) or hardware MIDI device to produce sound.
73+
74+
When **-** is given as the file, data is read from stdin.
75+
76+
# CAVEATS
77+
78+
Does not produce audible output on its own. A separate MIDI synthesizer or compatible hardware must be connected in the PipeWire graph to render MIDI events into audio. Standard MIDI File format (.mid) is supported.
79+
80+
# HISTORY
81+
82+
Part of **PipeWire**, the modern multimedia framework for Linux created by **Wim Taymans** at Red Hat. PipeWire was first released in **2017** and has become the default audio and video server in major Linux distributions, replacing both PulseAudio and JACK. The pw-cat family of tools provides simple command-line media playback and capture.
83+
84+
# SEE ALSO
85+
86+
[pw-cat](/man/pw-cat)(1), [pw-midirecord](/man/pw-midirecord)(1), [pw-mididump](/man/pw-mididump)(1), [pw-play](/man/pw-play)(1), [pipewire](/man/pipewire)(1)

0 commit comments

Comments
 (0)