Commit graph

332 commits

Author SHA1 Message Date
Liav A
a91da67216 Utilities/lspci: Iterate over /sys/bus/pci instead of reading /proc/pci
This opens many opportunities to add more data printed in lspci in a
flexible manner - so instead of reading an ever-expanding JSON encoded
file, we can add more features and let the utility read the directory
entries from sysfs.

This also allows not only filtering data on devices but to easily filter
non-wanted devices when printing the output.
2022-03-08 21:52:10 +01:00
electrikmilk
58a865f349 Base+Manpages: Add basic GML documentation
First draft of GML documentation, just to get things started.
2022-03-03 14:59:00 -08:00
Kasper Karlsson
0b91a46a0c Base: Fix typo in FlappyBug documentation 2022-03-02 22:21:25 -08:00
Liav A
f6e635938f Kernel: Change PCI access commandline option to also represent no access
This change allow the user to request the kernel to not use any PCI
resources/devices at all.

Also, don't try to initialize devices that rely on PCI if disabled.
2022-03-02 18:41:54 +01:00
Kyle Anthony Williams
3b61fbf15f Base: Clarify that TelnetServer must be run as root 2022-02-28 14:01:41 +01:00
Kyle Anthony Williams
a732d26a7b Base: Add gist to and modify description of usermod man page
This patch brings the man page usermod into line with its
siblings useradd and usermod.
2022-02-28 14:01:41 +01:00
Kyle Anthony Williams
0abdecf2b6 Base: Move EchoServer man page to section 8 2022-02-28 14:01:41 +01:00
Kyle Anthony Williams
0c33b494b8 Base: Combine TelnetServer man pages :^)
Two different man pages for TelnetServer could be found in sections
1 and 8 of Serenity's manual. This patch combines both and places
the page in section 8.
2022-02-28 14:01:41 +01:00
Kyle Anthony Williams
f5c517015d Base: Change gist of Shell man page
Pre-patch, the man page encased the name of the program in quotes,
which is inconsistent with other man pages, unnecessarily
repeated "Shell" in the gist, and included "the" in the gist,
which is also inconsistent with other man pages.
2022-02-28 14:01:41 +01:00
Kyle Anthony Williams
2266020bc0 Base: Add gists to man pages that lack one
Sources:
Eyes: https://www.x.org/releases/X11R7.6/doc/man/man1/xeyes.1.xhtml
wc: FreeBSD manual.
2022-02-28 14:01:41 +01:00
Kyle Anthony Williams
aae047e347 Base: Move WebServer man page to section 8 2022-02-28 14:01:41 +01:00
Kyle Anthony Williams
aedf6042a9 Base: Add "Open" link to Eyes, Help man pages 2022-02-28 14:01:41 +01:00
Arne Elster
835ffbb365 Base: Update audio subsystem documentation 2022-02-26 16:01:26 +01:00
networkException
692757c489 Base: Use "Library Functions" instead of "Libraries" for man section 3 2022-02-25 12:06:31 -05:00
networkException
9279dd783b Everywhere: Use title case for man section titles
In addition to the section headings on man.serenityos.org,
all occurances of man section titles are now formatted in title case.
2022-02-25 12:06:31 -05:00
Anton Kling
1ad7aa7136 ls: Add option -1 which lists one file per line 2022-02-19 18:18:13 -08:00
dayarthvader
5a94402b60 Utilities/nc: Add support to -I/--length option like SO_RCVBUF 2022-02-18 10:43:10 +01:00
Tim Schumacher
b689e8b7f4 tar: Automatically recognize gzip archives 2022-02-18 10:41:44 +01:00
Tim Schumacher
4487e515f7 Base: Update the tar manpage 2022-02-18 10:41:44 +01:00
kleines Filmröllchen
beb29c48cb Base: Link aplay in Audio-subsystem 2022-02-17 14:45:39 +03:30
kleines Filmröllchen
01d056f794 Base: Document /dev/audio devices
This properly documents the fact that /dev/audio contains a bunch of
device's channels now, instead of being a single file.
2022-02-17 14:45:39 +03:30
serenitydev
083b58fd89 Utilities: Add the 'files' argument to the unzip utility 2022-02-16 10:57:14 +03:30
Jakub Berkop
6218ec8afa profile: Document "read" profiling event 2022-02-14 11:38:13 +01:00
Timothy Flynn
19d4f52a9e js: Add a command line argument to evaluate a string as a script
For example:

    $ js -c "console.log(42)"
    42
2022-02-10 10:26:12 +00:00
Miika Hämynen
46ed6303a2 less: Add hotkeys f and b to scroll screen up/down 2022-02-06 13:44:53 +01:00
Timur Sultanov
6edb34aa56 Base: Update keymap man page to include new functionality
Adding examples on how to use keymap tool to set a list of keymaps
2022-02-03 00:47:22 +01:00
Pankaj Raghav
e5a6d12ff8 Kernel: Add nvme_poll command line parameters
As we don't currently support MSI(X) interrupts, it could be an issue
to boot on some newer hardware. NVMe devices support polling mode
where the driver actively polls for completion instead of waiting for
an interrupt.
2022-02-02 18:26:59 +01:00
Brian Gianforcaro
13f92627b2 Base: Add open links to all of the game man pages 2022-02-01 10:07:10 +01:00
Timothy Flynn
93e90e16c3 Base: Add a man page for the timezone utility 2022-01-28 23:18:17 +00:00
Linus Groh
8aa723d159 Base: Update possible values for ahci_reset_mode kernel boot option
- `controller` is now called `controllers`
- `complete` is now called `aggressive`
- `none` is no longer a recognized value
2022-01-26 21:34:26 +00:00
Daniel Bertalan
b509d8a2f7 Utilities/readelf: Add support for printing the content of sections 2022-01-24 10:41:47 +00:00
Liav A
b0790260f8 Base: Add a note on the possibility of failure with the beep utility 2022-01-23 00:40:54 +00:00
Liav A
69f054616d Kernel: Add CommandLine option to disable or enable the PC speaker
By default, we disable the PC speaker as it's quite annoying when using
the text mode console.
2022-01-23 00:40:54 +00:00
Brian Gianforcaro
64dfb3a28f Base: Add icons to man pages for GUI applications
Differentiate GUI applications in man pages with icons.

This is the revert of the revert commit, now that the icon processing
was fixed in 89c0f84a28.
Revert: dae298e9df
Original: 74238d0aba

Co-authored-by: electrikmilk <brandonjordan124@gmail.com>
2022-01-17 03:38:54 -08:00
Tobias Christiansen
76563c56dd Base: Remove file:// prefix from image 2022-01-17 02:22:33 -08:00
Brian Gianforcaro
dae298e9df Revert "Base: Add icons to man pages for GUI applications"
This reverts commit 74238d0aba.
2022-01-17 00:47:01 -08:00
electrikmilk
74238d0aba Base: Add icons to man pages for GUI applications
Differentiate GUI applications in man pages with icons.
2022-01-16 22:41:31 -08:00
Sam Atkins
83a9661c04 CharacterMap+Base: Add man page for Character Map :^) 2022-01-16 11:17:03 +01:00
kleines Filmröllchen
0424a4aa71 Base: Modernize aplay documentation
Aplay's documentation is updated to reflect the new -s flag.
Additionally, "sound" has been replaced by "audio", reflecting the
application name. (It's also a more general term in my opinion, but
that's debatable.)
2022-01-14 21:37:23 +01:00
David Lindbom
fff9547d9b Base: Add manual page for Snake 2022-01-13 03:45:17 -08:00
David Lindbom
aa231a1580 Base: Add manual page for Pong 2022-01-13 03:45:17 -08:00
David Lindbom
535b0be7fe Base: Add manual page for Minesweeper 2022-01-13 03:45:17 -08:00
David Lindbom
d4aad127ed Base: Add manual page for Hearts 2022-01-13 03:45:17 -08:00
David Lindbom
ecdcf4f293 Base: Add manual page for GameOfLife 2022-01-13 03:45:17 -08:00
David Lindbom
ef30e5832a Base: Add manual page for FlappyBug 2022-01-13 03:45:17 -08:00
David Lindbom
b15b87486d Base: Add manual page for Chess game 2022-01-13 03:45:17 -08:00
David Lindbom
d0d3c0c615 Base: Add manual page for Breakout 2022-01-13 03:45:17 -08:00
David Lindbom
e59556d531 Base: Add manual page for 2048 2022-01-13 03:45:17 -08:00
kleines Filmröllchen
98c0c5e9e6 Help+Base: Add help://man URLs for links between man pages
The URLs of the form `help://man/<section>/<page>` link to another help
page inside the help application. All previous relative page links are
replaced by this new form. This doesn't change any behavior but it looks
much nicer :^)

Note that man doesn't handle these new links, but the previous relative
links didn't work either.
2022-01-11 00:24:57 +01:00
kleines Filmröllchen
becf74097e Help: Directly launch an app from its help page
Through links in the help page, the user can directly launch the app
whose help page is currently viewed. The idea for this feature came up
in the discussion of #11557
(https://github.com/SerenityOS/serenity/pull/11557#issuecomment-1004830728
). The intention is that the user can simply open the app they are
currently trying to understand, and play around with it, learn by doing,
or follow along with any guide that may be present in the help page. It
feels very great :^)
2022-01-11 00:24:57 +01:00