Commit graph

320 commits

Author SHA1 Message Date
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
anarchyrucks
75e31a4749 Base: Add uniq(1) manpage 2022-01-09 04:27:26 -08:00
Liav A
ff25958b51 Userland: Introduce the pmemdump utility
This utility helps to dump the physical memory space from /dev/mem.
It supports both read(2) and mmap(2) on it so we could use mmap(2) for
fast dumping of the memory, or read(2) when we need to read unaligned
physical regions.
2022-01-08 13:21:16 +02:00
mjz19910
10ec98dd38 Everywhere: Fix spelling mistakes 2022-01-07 15:44:42 +01:00
Tom
785c10fda9 Kernel: Add option to force using only the bootloader framebuffer
This allows forcing the use of only the framebuffer set up by the
bootloader and skips instantiating devices for any other graphics
cards that may be present.
2022-01-06 22:34:11 +01:00
Mathieu PATUREL
571d090609 profile: Specify the /proc/profile path in the help message 2022-01-04 07:56:54 +00:00
Xavier Defrang
b17fef5133 mkdir: Use FilePermissionsMask to handle mode option 2022-01-01 17:33:43 +00:00
salaaad2
d364c8e352 Base: Add manpages for cut, diff, head & rmdir command line utilities 2021-12-29 20:42:18 -08:00
Daniel Bertalan
77f9272aaf Kernel+UE: Add MAP_FIXED_NOREPLACE mmap() flag
This feature was introduced in version 4.17 of the Linux kernel, and
while it's not specified by POSIX, I think it will be a nice addition to
our system.

MAP_FIXED_NOREPLACE provides a less error-prone alternative to
MAP_FIXED: while regular fixed mappings would cause any intersecting
ranges to be unmapped, MAP_FIXED_NOREPLACE returns EEXIST instead. This
ensures that we don't corrupt our process's address space if something
is already at the requested address.

Note that the more portable way to do this is to use regular
MAP_ANONYMOUS, and check afterwards whether the returned address matches
what we wanted. This, however, has a large performance impact on
programs like Wine which try to reserve large portions of the address
space at once, as the non-matching addresses have to be unmapped
separately.
2021-12-23 23:08:10 +01:00
Xavier Defrang
6ca34f5647 mkdir: Implement --mode option
Only supports permissions given in octal format
at the moment.
2021-12-21 13:13:04 -08:00
kleines Filmröllchen
102e0af867 Base: Add documentation for abench
See #11311 :^)
2021-12-20 23:15:22 -08:00
Liav A
8877dd0eea Base: Update boot_parameters(7) to describe the enable_ioapic option
The document describes the implications of enabling and disabling that
option on the ability to enable SMP mode, and describes the requirements
for enabling IOAPIC mode even without enabling SMP mode.
2021-12-20 11:00:31 -08:00
Sam Atkins
f11fbb6415 Base: Add a man page for Help
This is largely copied from the `man` man page, since the same
information applies.
2021-12-20 10:58:41 -08:00