summaryrefslogtreecommitdiff
path: root/Base
diff options
context:
space:
mode:
authorCubic Love <7754483+cubiclove@users.noreply.github.com>2023-05-07 23:15:08 +0100
committerAndreas Kling <kling@serenityos.org>2023-05-09 06:18:30 +0200
commitf5caf363e72fd30a633ef00e6df1de88c3283b73 (patch)
tree86218564afa43328bd6e5e59cb5e90a6629e69c1 /Base
parent09773048b6a15d19bb9843a018ce33b832525837 (diff)
downloadserenity-f5caf363e72fd30a633ef00e6df1de88c3283b73.zip
Base: Improve some application man pages
- FontEditor.md - Magnifier.md - Presenter.md - Terminal.md Where an arrow is indicated by -> turn it into an actual arrow → (U+2192 Rightwards Arrow). This looks much neater. Inspired by Notion doing this automatically when you type "->". I've made various corrections: fixing grammatical errors, removing unnecessary or adding-in missing spaces. Made the style of references to menu items more consistent. Generally I've tried to make the pages read better. Terminal has had more adjustment than the others as its Settings were recently changed and the man page now reflects this.
Diffstat (limited to 'Base')
-rw-r--r--Base/usr/share/man/man1/Applications/FontEditor.md30
-rw-r--r--Base/usr/share/man/man1/Applications/Magnifier.md14
-rw-r--r--Base/usr/share/man/man1/Applications/Presenter.md20
-rw-r--r--Base/usr/share/man/man1/Applications/Terminal.md24
-rw-r--r--Base/usr/share/man/man7/Audio-subsystem.md2
5 files changed, 47 insertions, 43 deletions
diff --git a/Base/usr/share/man/man1/Applications/FontEditor.md b/Base/usr/share/man/man1/Applications/FontEditor.md
index 4682f59769..2350d2c8ac 100644
--- a/Base/usr/share/man/man1/Applications/FontEditor.md
+++ b/Base/usr/share/man/man1/Applications/FontEditor.md
@@ -12,7 +12,7 @@ $ FontEditor [file]
## Description
-FontEditor is the font editing application to create and edit bitmap font files in SerenityOS.
+FontEditor is the font editing application for creating and editing bitmap font files in SerenityOS.
![](FontEditor.png)
@@ -23,30 +23,29 @@ FontEditor has the following basic parts:
3. The main workspace
4. The status bar at the bottom
-Presently, you can resize the entire FontEditor form to your liking. You can turn the visibility of Font Metadata and Unicode Blocks on or off. You can change the glyph editor window zoom factor. All of these things are currently available in FontEditor automatically.
+Presently, you can resize the entire FontEditor form to your liking. You can turn the visibility of Font Metadata and Unicode Blocks on or off. You can change the glyph editor window zoom factor. All of these things are currently available in FontEditor automatically.
### The Toolbar
-The Toolbar contains the same functional entries as that of the Menubar and is represented as clickable icons. Hovering on each icon will display additional information listed at the status bar which further states what each icon does.
+The Toolbar contains the same functional entries as that of the Menubar and is represented as clickable icons. Hovering on each icon will display additional information listed in the status bar which further states what each icon does.
### The Main Workspace
The main workspace has three partitions:
-- The ***left section*** contains the glyph editor window. This window has three different zoom factors for ease of use and for your viewing comfort. They are 500%, 1000% and 1500%. You can freely switch to any zoom level at anytime while creating your font. Don't let the size of the glyph editor window fool you. This is where you will spend about 95% of the time. And the task is that of shaping each glyph by left+clicking on the mouse. You can form a dot, a line, or a complete glyph just by connecting the dots. If you need to undo a certain location with a black dot, you can right+click on top of the target area and it will revert back to empty. Each grid area can hold any of the three states: 1) on or black 2) off or white 3) empty or gray. On state is displayed as black by default. Off state is displayed as white by default. Empty state is displayed as gray by default. Off state or white is relevant most specially if the font is fixed-width as it dictates the distance a glyph will have from left, center or right. Empty state or gray is important for variable-width font as it affects the overall width of the glyph. For variable width fonts, you move the glyph flushed left on the glyph editor window and remove any extra empty grids by decrementing the present column counter located right under the glyph editor window and thereby leaving only the entire glyph all by itself. Below the glyph editor is the glyph tool which contains the following: pen icon for creating glyph itself, move icon to enable the entire glyph move to top, down, left or right from within the glyph editor window. Below the glyph tool are the transform icons which are flip horizontal, flip vertical, rotate counter-clockwise 90°and rotate clockwise 90°. Transform tools are most helpful when copying over existing glyphs and transforming them to form a new glyph. A becomes V, M becomes W, c becomes e, n becomes u, etcetera.
+- The ***left section*** contains the glyph editor window. This window has three different zoom factors for ease of use and for your viewing comfort. They are 500%, 1000% and 1500%. You can freely switch to any zoom level at anytime while creating your font. Don't let the size of the glyph editor window fool you. This is where you will spend about 95% of the time. And the task is that of shaping each glyph by left-clicking on the mouse. You can form a dot, a line, or a complete glyph just by connecting the dots. If you need to undo a certain location with a black dot, you can right-click on top of the target area and it will revert back to empty. Each grid area can hold any of the three states: 1) on or black 2) off or white 3) empty or gray. On state is displayed as black by default. Off state is displayed as white by default. Empty state is displayed as gray by default. Off state or white is relevant most specially if the font is fixed-width as it dictates the distance a glyph will have from left, center or right. Empty state or gray is important for variable-width font as it affects the overall width of the glyph. For variable width fonts, you move the glyph flushed left on the glyph editor window and remove any extra empty grids by decrementing the present column counter located right under the glyph editor window and thereby leaving only the entire glyph all by itself. Below the glyph editor is the glyph tool which contains the following: the pen icon for creating the glyph itself, the move icon to enable the entire glyph move to top, down, left or right from within the glyph editor window. Below the glyph tool are the transform icons which are flip horizontal, flip vertical, rotate counter-clockwise 90°and rotate clockwise 90°. Transform tools are most helpful when copying over existing glyphs and transforming them to form a new glyph. A becomes V, M becomes W, c becomes e, n becomes u, etc.
-- The ***middle section*** contains two parts: the upper part which holds the entire glyph content of the font, or lack thereof if you are making a new one. And the lower part which contains ***Metadata*** information such as name, family, weight, slope, presentation size, mean line, baseline, glyph spacing and if the font is either fixed-width or variable-width. You can still further tweak your font parameters via the Metadata section. The ` Fixed width ` toggle located at the right side next to Glyph spacing is of special note. It applies to the entire font file. It does not only apply to a single glyph or group of glyphs. It is the differentiating factor that informs the system if the font is or is not fixed-width. Fixed-width fonts are mostly used for Terminals and for displaying program source codes.
+- The ***middle section*** contains two parts: the upper part which holds the entire glyph content of the font, or lack thereof if you are making a new one. And the lower part which contains ***Metadata*** information such as name, family, weight, slope, presentation size, mean line, baseline, glyph spacing and if the font is either fixed-width or variable-width. You can still further tweak your font parameters via the Metadata section. The `Fixed width` toggle located at the right side next to Glyph spacing is of special note. It applies to the entire font file. It does not only apply to a single glyph or group of glyphs. It is the differentiating factor that informs the system if the font is or is not fixed-width. Fixed-width fonts are mostly used for Terminals and for displaying source code.
-- The ***right section*** which displays both search input for unicode blocks and the unicode block selection list.
-Metadata and unicode blocks can be turned on or off via ` Menu -> View ` option. Unicode block filters only what to display contained within the range of the block. Basic Latin covers 000-007F, Latin-1 Supplement covers 0080-00FF, Latin Extended-A covers 0100-017F and so on and so forth. Global search for a glyph is affected when a certain block is currently selected. Only by selecting ` Show All ` will the global glyph search work as expected. So make it a habit of confirming that Show All is active before searching for a glyph.
+- The ***right section*** displays a searchable list of Unicode Blocks.
+Metadata and Unicode Blocks can be turned on or off in `Menu → View`. Selecting a Unicode Block will show only the glyphs contained within the range of that block. Basic Latin covers 000-007F, Latin-1 Supplement covers 0080-00FF, Latin Extended-A covers 0100-017F and so on and so forth. Global search for a glyph is affected when a certain block is currently selected. Only by selecting `Show All` will the global glyph search work as expected. So make it a habit of confirming that Show All is active before searching for a glyph.
### The status bar
The status bar displays additional information describing what each menu entry and toolbar icon does. It identifies the unicode value of the glyph currently under the cursor. It shows the glyph's visual representation (if available), description and dimensions. The right-most segment displays the code point range of the currently selected Unicode Block. Clicking this segment will toggle the display of the Unicode Block list. Second only to the glyph editor window, the status bar is your next best friend on your path to becoming a font master.
-
-### Create New Font
+## Tutorial: Create a new font
![](FontEditor_New_Font.png)
-To create a new font, you can either click on New Font icon on the Toolbar or go to ` File -> New Font ` on the Menubar.
-A wizard will walk you through preparing the needed parameters for your new font.
+To create a new font, you can either click on New Font icon on the Toolbar or go to `File → New Font` in the Menubar.
+A wizard will walk you through setting the needed parameters for your new font.
### Typeface Properties
![](FontEditor_Typeface_properties.png)
@@ -71,23 +70,22 @@ Congratulations on your successful initial font setup. Now you are ready to begi
### Launch another instance
![](FontEditor_Launching_second_instance.png)
-Figure above shows where you can find FontEditor from inside the SerenityOS desktop.
-
+The figure above shows where you can find FontEditor from inside the SerenityOS desktop.
### Side by side
![](FontEditor_Twins_sidebyside.png)
-Having another instance of FontEditor can help boost productivity. This is most noticeable when one is just starting out on using FontEditor and is trying out how to best make use of the application. Don't be afraid to experiment, let your inner font master slowly shine through. It is best to maintain the feeling of having fun while silently grinning from ear to ear as you steadily create form and personality into your font. Don't be afraid to start again, if you must. As with the entire workflow, being aware when to start, when to stop and when to reset is crucial. With FontEditor to assist you, starting from scratch is no longer an arduous process.
+Having another instance of FontEditor can help boost productivity. This is most noticeable when one is just starting out in using FontEditor and trying out how to best make use of the application. Don't be afraid to experiment, let your inner font master slowly shine through. It is best to maintain the feeling of having fun while silently grinning from ear to ear as you steadily create form and personality in your font. Don't be afraid to start again, if you must. As with the entire workflow, being aware when to start, when to stop and when to reset is crucial. With FontEditor to assist you, starting from scratch is no longer an arduous process.
### Save font
![](FontEditor_Save_font_as.png)
-Save your font by following the recommended ` FontName + FontStyle + FontPresentationSize + .font ` naming convention.
+Save your font by following the recommended `FontName + FontStyle + FontPresentationSize + .font` naming convention.
### Continue Editing
![](FontEditor_Continue_editing_current_font.png)
-The figure above shows some glyphs already created. Those with sharp eyes can immediately see that the glyphs for M and W, O and Q came from the same base. W was copied over from M and was flipped horizontally. Q was copied over from O and a descender was added to achieve the final glyph. Continue editing your font by adding more glyphs into it. Take your time in creating the font, only you know the reason why the glyph is formed the way it is. You know why the height and the width is so, why the curvature is just so. Aside from achieving balance, maintain the spirit of fun in making your font. The more glyphs are added, the easier it is to get the general feel and character of the font. Remember to always save and to save often.
+The figure above shows some previously made glyphs. Those with sharp eyes can immediately see that the glyphs for M and W, O and Q came from the same base. W was copied over from M and was flipped horizontally. Q was copied over from O and a descender was added to achieve the final glyph. Continue editing your font by adding more glyphs into it. Take your time in creating the font, only you know the reason why the glyph is formed the way it is. You know why the height and the width is so, why the curvature is just so. Aside from achieving balance, maintain the spirit of fun in making your font. The more glyphs are added, the easier it is to get the general feel and character of the font. Remember to always save and to save often.
### fonts.serenityos.net
![](Fonts_SerenityOS_dot_Net.png)
diff --git a/Base/usr/share/man/man1/Applications/Magnifier.md b/Base/usr/share/man/man1/Applications/Magnifier.md
index 3aea50de62..14b6fb26e5 100644
--- a/Base/usr/share/man/man1/Applications/Magnifier.md
+++ b/Base/usr/share/man/man1/Applications/Magnifier.md
@@ -12,10 +12,16 @@ $ Magnifier
## Description
-`Magnifier` is an application that magnifies or zooms-in an area of the desktop where the mouse cursor hovers.
+Magnifier is an application that magnifies or zooms-in on the area surrounding your mouse cursor.
-You can launch _Magnifier_ by selecting Serenity menu -> Utilities -> Magnifier.
+You can launch Magnifier by navigating to `System Menu → Utilities → Magnifier`.
-Magnifier can do 2x, 4x, or 8x zoom in realtime. Once you feel that the area being captured is just right, you can pause capture by pressing the shortcut key Spacebar.
+Magnifier can do 2x, 4x, or 8x zoom in realtime. Quickly switch zoom level by pressing `2`, `4`, or `8`.
-For users with slight visual impairment, Magnifier can apply several filters to the captured image. Click on the _Accessibility_ menu and select one of the impairment categories available on the drop-down list.
+Once you feel that the area being captured is just right, you can pause capture by pressing `Spacebar`.
+
+To lock the location, making Magnifier stop following your mouse and stay in place, press `L`.
+
+To view a pixel grid overlay, press `G`.
+
+For users with slight visual impairment, Magnifier can apply several filters to the captured image. Click on the *Accessibility* menu and select one of the impairment categories available in the drop-down list.
diff --git a/Base/usr/share/man/man1/Applications/Presenter.md b/Base/usr/share/man/man1/Applications/Presenter.md
index 023e212da2..064a380678 100644
--- a/Base/usr/share/man/man1/Applications/Presenter.md
+++ b/Base/usr/share/man/man1/Applications/Presenter.md
@@ -12,11 +12,11 @@ $ Presenter [file]
## Description
-Presenter is a simple slide presentation software, capable of displaying presentations stored in a simple format. It provides a simple user interface and experience that is specifically aimed at "getting out of the way" while you are giving the presentation to a live audience.
+Presenter is a simple slide presentation application, capable of displaying presentations stored in a simple format. It provides a simple user interface that is specifically aimed at "getting out of the way" while you are giving a presentation to a live audience.
### Opening Files
-Use **File -> Open...** to open a presentation in Presenter, or specify it on the command line (see [Synopsis](#synopsis)). The file format currently understood by Presenter is based on JSON and explained in [presenter(5)](help://man/5/presenter).
+Use `File → Open…` to open a presentation in Presenter, or specify it in the command line (see [Synopsis](#synopsis)). The file format currently understood by Presenter is based on JSON and explained in [presenter(5)](help://man/5/presenter).
### Terminology
@@ -26,15 +26,15 @@ Use **File -> Open...** to open a presentation in Presenter, or specify it on th
### Controlling the Presentation
-During the presentation, the following keybindings are always available, though there are also corresponding menu options. Some of these keybindings mirror functionality of other common presentation software, though they don't usually behave exactly the same.
+During the presentation, the following keybindings are always available, though there are also corresponding menu options. Some of these keybindings mirror the functionality of other presentation software, though they don't usually behave exactly the same.
-- Right, Down, Space, Enter: Next slide or frame
-- Left, Up, Backspace: Previous slide or frame
-- B: Black-out display. Going forward or back a slide or frame or pressing Escape will disable the black-out and resume the presentation.
-- W: White-out display. The behavior is identical to black-out.
-- Escape: Exit full-screen mode.
-- F11, Shift + F5: Enter full-screen mode.
-- F5: Return to first slide and enter full-screen mode.
+- `Right`, `Down`, `Space`, `Enter`: Next slide or frame
+- `Left`, `Up`, `Backspace`: Previous slide or frame
+- `B`: Black-out display. Going forward or back a slide or frame or pressing Escape will disable the black-out and resume the presentation.
+- `W`: White-out display. The behavior is identical to black-out.
+- `F11`, `Shift + F5`: Toggle full-screen mode.
+- `Escape`: Exit full-screen mode.
+- `F5`: Return to first slide and enter full-screen mode.
- Typing a number followed by Enter will go to the first frame of that slide.
## See Also
diff --git a/Base/usr/share/man/man1/Applications/Terminal.md b/Base/usr/share/man/man1/Applications/Terminal.md
index 0de47ad88a..81335ce943 100644
--- a/Base/usr/share/man/man1/Applications/Terminal.md
+++ b/Base/usr/share/man/man1/Applications/Terminal.md
@@ -14,23 +14,23 @@ $ Terminal [options]
Terminal is a terminal emulator application for Serenity.
-It will generally be launched from Serenity menu, an on-screen menu, or the `Open in Terminal` action in File Manager and on the Desktop. You can also launch the current help item from within the help document, click on the `Open` link above to launch Terminal.
+It can be launched from the System Menu or the quick access icon to its right, via the `Open in Terminal` action in File Manager and on the Desktop. You can also click on the `Open` link above to launch Terminal.
-Selecting `File->Terminal Settings` will launch Terminal Settings dialog and display user configurable application properties. This dialog box contains two tabs namely Terminal tab and View tab.
+Select `File → Terminal Settings` to launch the Terminal Settings dialog and display user configurable application properties. This dialog box contains two tabs: View and Terminal.
-The _Settings Terminal_ tab shows the option to either enable System beep, or use Visual bell or disable bell altogether. It can also enable or disable the display of terminal scrollbar and to change its exit behavior.
+The *View* tab provides the most frequently sought options:
+* Adjust the Terminal font (turn off `Use system default` to select a custom font.
+* Specify background opacity, i.e. the amount to which the Terminal's background is transparent, displaying what's underneath.
+* Change the shape of the cursor from Block, to Underscore or to Vertical bar. You can also opt to enable or disable cursor's blink property.
+* To enable or disable the display of terminal scrollbar.
-The _Settings View_ tab shows the option of specifying background opacity. Opacity is the amount in which the Terminal's background is transparent, displaying what's underneath. Set the opacity level to your taste while maintaining readability balance.
+The *Terminal* tab gives less frequently used options:
+* To either enable System beep, or use Visual bell or disable bell mode altogether.
+* To change Terminal's exit behavior
-You also have the option of using Terminal's system default font or to select a new one by clicking on the ellipsis. Remember to uncheck `Use system default` checkbox before doing so.
+Clicking on the *Apply* button will cause the currently selected options to take effect immediately.
-You can change the shape of the cursor from block type, to underline or to bar type. You can also opt to enable or disable cursor's blink property.
-
-You can select to change the Terminal's color scheme. Just click on the drop-down list and pick a color scheme. Examples of color schemes are Dracula, Monokai, Solarized and Zenburn.
-
-Clicking on the _Apply_ button will cause the currently selected options to take effect immediately.
-
-You can press the shortcut key F11 to display Terminal in fullscreen mode. Press F11 again to revert back to normal window display mode.
+You can toggle Fullscreen mode by pressing F11.
## Options
diff --git a/Base/usr/share/man/man7/Audio-subsystem.md b/Base/usr/share/man/man7/Audio-subsystem.md
index ff7aa46588..e2984947b6 100644
--- a/Base/usr/share/man/man7/Audio-subsystem.md
+++ b/Base/usr/share/man/man7/Audio-subsystem.md
@@ -30,7 +30,7 @@ that can then be provided to the queue. The application might need to wait aroun
write to it. For these reasons, there's a utility API in LibAudio's audio server IPC connection which allows audio
applications to send off a large chunk of samples which get progressively sent in the background.
-On the server -> client side, AudioServer has "event" calls that the client receives. These are various mixer state changes (main volume, main mute, client volume).
+On the server → client side, AudioServer has "event" calls that the client receives. These are various mixer state changes (main volume, main mute, client volume).
### Libraries