Skip to content

Commit ab57a24

Browse files
committed
Improve command detail quality
1 parent bf5f255 commit ab57a24

122 files changed

Lines changed: 3313 additions & 1922 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

assets/commands/Xnest.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# TAGLINE
22

3-
Nested X server within a window
3+
A nested X server that runs as a client window
44

55
# TLDR
66

@@ -31,10 +31,10 @@ Nested X server within a window
3131
# PARAMETERS
3232

3333
**-display** _name_
34-
> Parent X server to connect to.
34+
> Parent X server to connect to. Defaults to DISPLAY environment variable.
3535
3636
**-geometry** _WxH+X+Y_
37-
> Window geometry for nested server.
37+
> Window geometry for the nested server.
3838
3939
**-scrns** _num_
4040
> Number of screens to create.
@@ -43,21 +43,27 @@ Nested X server within a window
4343
> Default color depth.
4444
4545
**-fullscreen**
46-
> Run fullscreen on parent display.
46+
> Run fullscreen on the parent display.
4747
4848
**-bw** _n_
4949
> Border width in pixels.
5050
5151
**-name** _string_
52-
> Window name.
52+
> Window name for the nested server.
53+
54+
**-sss**
55+
> Enable separate screen saver for each screen.
56+
57+
**-sync**
58+
> Synchronize window and graphics operations with the parent server. Useful for debugging but significantly slows performance.
5359
5460
# DESCRIPTION
5561

56-
**Xnest** is a nested X server that runs as a window within another X server. It appears as a regular X client to the parent server while providing a complete X server environment to its own clients.
62+
**Xnest** is both an X client and an X server. It runs as a window within another X server (the parent), appearing as a regular X client to the parent while providing a complete X server environment to its own clients.
5763

58-
Applications connect to Xnest using its display number (e.g., :1) and receive a fully functional X environment. This enables testing window managers, running isolated X sessions, or displaying remote X applications in a contained window.
64+
Applications connect to Xnest using its display number (e.g., `:1`) and receive a fully functional X environment. Multiple screens can be referenced by the number after the dot in the display name (e.g., `xterm -display :1.1` for the second screen). This enables testing window managers, running isolated X sessions, or displaying remote X applications in a contained window.
5965

60-
Xnest is resource-intensive since most requests pass through to the parent server. For better performance and modern extension support, Xephyr is recommended as a replacement.
66+
Xnest manages fonts by loading them locally and passing the font name to the real server. For better performance and modern X extension support, **Xephyr** is recommended as a replacement.
6167

6268
# CAVEATS
6369

@@ -69,4 +75,4 @@ Lacks modern X extensions (XRender, Composite, RandR). No hardware acceleration.
6975

7076
# SEE ALSO
7177

72-
[Xephyr](/man/Xephyr)(1), [Xvfb](/man/Xvfb)(1), [Xorg](/man/Xorg)(1), [startx](/man/startx)(1)
78+
[Xvfb](/man/Xvfb)(1), [Xorg](/man/Xorg)(1), [startx](/man/startx)(1)

assets/commands/abrt-cli.md

Lines changed: 43 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,64 +4,81 @@ command-line interface for automatic bug reporting
44

55
# TLDR
66

7-
**List** detected problems
7+
**List all detected problems**
88

99
```abrt-cli list```
1010

11-
Show **details** of a specific problem
11+
**List only unreported problems**
1212

13-
```abrt-cli info [problem_id]```
13+
```abrt-cli list -n```
1414

15-
**Remove** a crash report
15+
**Show detailed info about a specific problem**
1616

17-
```abrt-cli remove [problem_id]```
17+
```abrt-cli info [problem_dir]```
1818

19-
**Report** a problem to the configured bug tracker
19+
**Report a problem to the configured bug tracker**
2020

21-
```abrt-cli report [problem_id]```
21+
```abrt-cli report [problem_dir]```
2222

23-
Generate a report for **debugging** manually
23+
**Remove a crash report**
2424

25-
```abrt-cli report --analyze [problem_id]```
25+
```abrt-cli remove [problem_dir]```
26+
27+
**Show count of detected problems**
28+
29+
```abrt-cli status```
30+
31+
**Enable or disable auto-reporting**
32+
33+
```abrt-cli auto-report [on|off]```
2634

2735
# SYNOPSIS
2836

29-
**abrt-cli** [_list_] [_info_] [_report_] [_remove_] [_problem_id_]
37+
**abrt-cli** _command_ [_options_] [_problem_dir_]
3038

3139
# DESCRIPTION
3240

33-
**abrt-cli** is the command-line interface for the Automatic Bug Reporting Tool (ABRT) used on Fedora-based systems. It detects, analyzes, and reports application crashes, sending them to bug tracking systems like Bugzilla.
41+
**abrt-cli** is the command-line interface for the Automatic Bug Reporting Tool (ABRT) used on Fedora and RHEL systems. It manages detected application crashes, kernel oopses, and other software defects, allowing users to list, inspect, report, and remove problem data.
3442

3543
Crash information includes identifiers, timestamps, package names, crash reasons, and report status/URLs when applicable.
3644

3745
# PARAMETERS
3846

39-
**list**
40-
> Display all detected crashes on the machine
47+
**list** [**-n**] [**--detailed**] [**--since** _NUM_] [**--until** _NUM_]
48+
> Display detected crashes. **-n** shows only unreported problems. **--detailed** shows full report. **--since**/**--until** filter by timestamp.
49+
50+
**info** [**-d**] [**-s** _SIZE_] _PROBLEM_DIR_
51+
> Show details of a specific problem. **-d** for detailed output. **-s** abridges text larger than SIZE bytes.
52+
53+
**report** [**--delete**] [**--unsafe**] _PROBLEM_DIR_
54+
> Submit a problem for analysis and reporting. **--delete** removes the problem dir after reporting. **--unsafe** ignores security checks.
55+
56+
**remove** _PROBLEM_DIR_
57+
> Delete a problem from the system.
4158
42-
**list -d ID_OR_PATH**
43-
> Display detailed report for a specific problem
59+
**status** [**-b**] [**--since** _NUM_]
60+
> Show count of detected problems. **-b** prints only the count (bare mode).
4461
45-
**info PROBLEM_ID**
46-
> Show details of a specific problem
62+
**process** [**--since** _NUM_] [**--unsafe**] _PROBLEM_DIR_
63+
> Analyze and report problems in batch.
4764
48-
**report PROBLEM_ID**
49-
> Submit a problem for analysis and reporting
65+
**auto-report** [**on**|**off**]
66+
> Enable or disable automatic reporting of detected problems.
5067
51-
**report -a, --analyze PROBLEM_ID**
52-
> Generate a report for manual debugging
68+
**-v**, **--verbose**
69+
> Increase verbosity.
5370
54-
**remove PROBLEM_ID**
55-
> Delete a problem from the system
71+
**-V**, **--version**
72+
> Show version information.
5673
5774
# CAVEATS
5875

59-
The reporting workflow opens a text editor. Editor selection uses environment variables in order: **$ABRT_EDITOR**, **$VISUAL**, **$EDITOR**, or defaults to **vi**.
76+
The reporting workflow opens a text editor. Editor selection uses environment variables in order: **$ABRT_EDITOR**, **$VISUAL**, **$EDITOR**, or defaults to **vi**. The ABRT daemon must be running for new problems to be detected.
6077

6178
# HISTORY
6279

63-
Part of **ABRT** (Automatic Bug Reporting Tool), developed by Red Hat for Fedora-based systems starting around **2009** as a replacement for bug-buddy.
80+
Part of **ABRT** (Automatic Bug Reporting Tool), developed by **Red Hat** for Fedora-based systems starting around **2009** as a replacement for bug-buddy.
6481

6582
# SEE ALSO
6683

67-
[abrt-action-analyze-backtrace](/man/abrt-action-analyze-backtrace)(1), [abrt-action-analyze-c](/man/abrt-action-analyze-c)(1), [journalctl](/man/journalctl)(1)
84+
[abrt](/man/abrt)(1), [abrt-action-analyze-backtrace](/man/abrt-action-analyze-backtrace)(1), [abrt-action-analyze-c](/man/abrt-action-analyze-c)(1), [coredumpctl](/man/coredumpctl)(1), [journalctl](/man/journalctl)(1)

assets/commands/airserv-ng.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,56 @@
11
# TAGLINE
22

3-
Serve a wireless card over TCP/IP for remote access
3+
Wireless card server for remote access over TCP/IP
44

55
# TLDR
66

7-
**Start** the wireless server
7+
**Start the wireless server on an interface with a specific channel and port**
88

9-
```sudo airserv-ng -p [666] -c [6] -d [wlan0mon]```
9+
```sudo airserv-ng -d [wlan0mon] -c [6] -p [666]```
1010

11-
Start on **specific interface**
11+
**Start the server on the default port**
1212

13-
```sudo airserv-ng -d [wlan0] -p [666]```
13+
```sudo airserv-ng -d [wlan0mon]```
14+
15+
**Start with verbose debug output**
16+
17+
```sudo airserv-ng -d [wlan0mon] -v [3]```
1418

1519
# SYNOPSIS
1620

17-
**airserv-ng** [_-d device_] [_-c channel_] [_-p port_]
21+
**airserv-ng** [_options_]
1822

19-
# DESCRIPTION
23+
# PARAMETERS
2024

21-
**airserv-ng** is a wireless card server that allows remote access to a wireless interface over TCP/IP. This enables using aircrack-ng tools on one computer while the wireless card is physically connected to another.
25+
**-d** _IFACE_
26+
> Wireless interface to serve (required).
2227
23-
The server provides network access to the wireless interface, and clients connect using the interface specification format **ip:port** instead of a local device name.
28+
**-c** _CHAN_
29+
> Lock the interface to a specific channel.
2430
25-
# PARAMETERS
31+
**-p** _PORT_
32+
> TCP port to listen on (default: 666).
33+
34+
**-v** _LEVEL_
35+
> Debug level. Level 1 shows client connect/disconnect (default), higher levels show more detail.
2636
27-
**-d** _device_
28-
> Wireless interface to serve
37+
**-h**
38+
> Display help information.
39+
40+
# DESCRIPTION
2941

30-
**-c** _channel_
31-
> Lock interface to specific channel
42+
**airserv-ng** is a wireless card server that allows multiple wireless application programs to independently use a wireless card via a client-server TCP network connection. All operating system and wireless card driver specific code is incorporated into the server.
3243

33-
**-p** _port_
34-
> TCP port to listen on (default: 666)
44+
Clients connect by specifying **host:port** as the interface name instead of a local device. This enables using aircrack-ng tools on one machine while the wireless card is physically connected to another.
3545

3646
# CAVEATS
3747

38-
No built-in authentication or encryption; use SSH tunneling for secure remote access. Network latency may affect real-time packet injection. The server must have the wireless card in monitor mode.
48+
No built-in authentication or encryption; use SSH tunneling for secure remote access. Network latency may affect real-time packet injection. The wireless card should typically be in monitor mode before starting the server.
3949

4050
# HISTORY
4151

42-
**airserv-ng** was created as part of the aircrack-ng suite to enable distributed wireless testing scenarios where the wireless hardware and analysis software are on different machines.
52+
**airserv-ng** was created as part of the **aircrack-ng** suite to enable distributed wireless testing scenarios where the wireless hardware and analysis software run on different machines.
4353

4454
# SEE ALSO
4555

46-
[aircrack-ng](/man/aircrack-ng)(1), [airodump-ng](/man/airodump-ng)(1)
56+
[aircrack-ng](/man/aircrack-ng)(1), [airodump-ng](/man/airodump-ng)(1), [aireplay-ng](/man/aireplay-ng)(1), [airmon-ng](/man/airmon-ng)(1)

assets/commands/apache.md

Lines changed: 16 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ Control the Apache HTTP web server
44

55
# TLDR
66

7-
**Start Apache** in the foreground
7+
**Start Apache** daemon
88

99
```apachectl start```
1010

11-
**Stop Apache** gracefully
11+
**Stop Apache** gracefully (finish current requests)
1212

1313
```apachectl graceful-stop```
1414

15-
**Restart Apache** gracefully (finish current requests)
15+
**Gracefully restart** Apache (finish current requests, then restart)
1616

1717
```apachectl graceful```
1818

@@ -28,13 +28,13 @@ Control the Apache HTTP web server
2828

2929
```apachectl -l```
3030

31-
**Show loaded modules**
31+
**Show all loaded modules** (static and shared)
3232

3333
```apachectl -M```
3434

35-
**Display full status** (requires mod_status)
35+
**Show parsed virtual host settings**
3636

37-
```apachectl fullstatus```
37+
```apachectl -S```
3838

3939
# SYNOPSIS
4040

@@ -51,7 +51,7 @@ Control the Apache HTTP web server
5151
> Stop the daemon immediately.
5252
5353
**restart**
54-
> Restart the daemon (abort current connections).
54+
> Restart the daemon (aborts current connections).
5555
5656
**graceful**
5757
> Gracefully restart (finish current requests, then restart).
@@ -62,6 +62,9 @@ Control the Apache HTTP web server
6262
**configtest**
6363
> Check configuration file syntax.
6464
65+
**fullstatus**
66+
> Display full server status (requires **mod_status** and a text-based browser).
67+
6568
**-v**
6669
> Show version number.
6770
@@ -75,7 +78,7 @@ Control the Apache HTTP web server
7578
> List all loaded modules (static and shared).
7679
7780
**-t**
78-
> Test configuration syntax.
81+
> Test configuration syntax (same as configtest).
7982
8083
**-S**
8184
> Show parsed virtual host settings.
@@ -88,31 +91,17 @@ Control the Apache HTTP web server
8891
8992
# DESCRIPTION
9093

91-
**Apache HTTP Server** (httpd) is the world's most widely used web server software. It serves static and dynamic content over HTTP/HTTPS, supporting virtual hosting, URL rewriting, authentication, and extensive module-based extensibility.
92-
93-
The **apachectl** script provides a convenient interface for controlling the Apache daemon. It wraps the **httpd** binary with init-script-style commands for starting, stopping, and managing the server.
94-
95-
Configuration is primarily done through **httpd.conf** and related files in the Apache configuration directory. The modular architecture allows enabling features like SSL/TLS (mod_ssl), URL rewriting (mod_rewrite), proxying (mod_proxy), and dynamic content via CGI, PHP, or mod_wsgi.
96-
97-
Apache supports two primary Multi-Processing Modules: **prefork** (process-based) for compatibility and **event/worker** (threaded) for higher concurrency.
98-
99-
# CONFIGURATION
100-
101-
**/etc/httpd/conf/httpd.conf**
102-
> Main configuration file on RHEL/CentOS/Fedora systems.
94+
**Apache HTTP Server** (httpd) is one of the most widely used web server software packages. It serves static and dynamic content over HTTP/HTTPS, supporting virtual hosting, URL rewriting, authentication, and extensive module-based extensibility.
10395

104-
**/etc/apache2/apache2.conf**
105-
> Main configuration file on Debian/Ubuntu systems.
96+
The **apachectl** script provides a convenient interface for controlling the Apache daemon. It can operate as a simple front-end to the **httpd** command, or act as a SysV init script translating one-word arguments like **start**, **restart**, and **stop** into appropriate signals.
10697

107-
**/etc/httpd/conf.d/**
108-
> Directory for additional configuration files on RHEL-based systems.
98+
Configuration is primarily done through **httpd.conf** and related files. The modular architecture allows enabling features like SSL/TLS (mod_ssl), URL rewriting (mod_rewrite), proxying (mod_proxy), and dynamic content via CGI, PHP, or mod_wsgi.
10999

110-
**/etc/apache2/sites-available/**
111-
> Virtual host configuration files on Debian-based systems.
100+
Apache supports multiple Multi-Processing Modules: **prefork** (process-based) for compatibility, **worker** (threaded), and **event** (threaded with improved keep-alive handling) for higher concurrency.
112101

113102
# CAVEATS
114103

115-
Configuration changes require a restart or reload. Syntax errors in configuration files prevent startup; always run **configtest** first. The **graceful** restart is preferred for production to avoid dropping active connections. Log files can grow large and require rotation.
104+
Configuration changes require a restart or reload. Syntax errors in configuration files prevent startup; always run **configtest** first. The **graceful** restart is preferred for production to avoid dropping active connections. Log files can grow large and require rotation. The **apachectl** script returns exit code 0 on success and >0 on error.
116105

117106
# HISTORY
118107

0 commit comments

Comments
 (0)