GITBOOK-1710: Page descriptions. Various page fixes while at it

Author: mariadb-stefan-hinz

server/SUMMARY.md

@@ -545,15 +545,15 @@
     * [Automated Deployment & Administration](server-management/automated-mariadb-deployment-and-administration/README.md)
   * [Starting & Stopping](server-management/starting-and-stopping-mariadb/README.md)
     * [Starting and Stopping Overview](server-management/starting-and-stopping-mariadb/starting-and-stopping-mariadb-automatically.md)
-    * [launchd](server-management/starting-and-stopping-mariadb/launchd.md)
-    * [systemd](server-management/starting-and-stopping-mariadb/systemd.md)
+    * [launchd (macOS)](server-management/starting-and-stopping-mariadb/launchd.md)
+    * [systemd (Linux)](server-management/starting-and-stopping-mariadb/systemd.md)
     * [sysVinit](server-management/starting-and-stopping-mariadb/sysvinit.md)
     * [mariadbd-safe](server-management/starting-and-stopping-mariadb/mariadbd-safe.md)
     * [mariadbd-multi](server-management/starting-and-stopping-mariadb/mariadbd-multi.md)
     * [mariadbd Options](server-management/starting-and-stopping-mariadb/mariadbd-options.md)
     * [mariadbd](server-management/starting-and-stopping-mariadb/mariadbd.md)
     * [mysql.server](server-management/starting-and-stopping-mariadb/mysql-server.md)
-    * [Running MariaDB from the Build Directory](server-management/starting-and-stopping-mariadb/running-mariadb-from-the-build-directory.md)
+    * [Running MariaDB From the Build Directory](server-management/starting-and-stopping-mariadb/running-mariadb-from-the-build-directory.md)
     * [Running Multiple MariaDB Server Processes](server-management/starting-and-stopping-mariadb/running-multiple-mariadb-server-processes.md)
     * [Specifying Permissions for Schema (Data) Directories and Tables](server-management/starting-and-stopping-mariadb/specifying-permissions-for-schema-data-directories-and-tables.md)
     * [Switching Between Different Installed MariaDB Versions](server-management/starting-and-stopping-mariadb/switching-between-different-installed-mariadb-versions.md)

server/server-management/starting-and-stopping-mariadb/launchd.md

@@ -1,8 +1,16 @@
+---
+description: >-
+  Instructions for configuring MariaDB to start automatically on macOS using a
+  launchd plist file in /Library/LaunchDaemons.
+---
 
-# launchd
+# launchd (macOS)
 
-In MacOS, create a file called /Library/LaunchDaemons/com.mariadb.server.plist with the following contents (edit to suit):
+If you install MariaDB on macOS using Homebrew – which is the only option – starting and stopping `mariadbd` (MariaDB server) is done as [described on this page](../install-and-upgrade-mariadb/installing-mariadb/binary-packages/installing-mariadb-on-macos-using-homebrew.md). The below instructions don't need to be performed.
 
+***
+
+On macOS, create a file called `/Library/LaunchDaemons/com.mariadb.server.plist` with the following contents (edit to suit):
 
 ```
 <?xml version="1.0" encoding="UTF-8"?>
@@ -33,15 +41,11 @@ In MacOS, create a file called /Library/LaunchDaemons/com.mariadb.server.plist w
 
 Then from a shell, run `launchctl load /Library/LaunchDaemons/com.mariadb.server.plist` and MariaDB will run immediately, and also upon reboot.
 
-
 ## See Also
 
-
 * [Creating Launch Daemons and Agents](https://developer.apple.com/library/archive/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html)
 * [A launchd Tutorial](https://www.launchd.info/)
 
-
 <sub>_This page is licensed: CC BY-SA / Gnu FDL_</sub>
 
-
 {% @marketo/form formId="4316" %}

server/server-management/starting-and-stopping-mariadb/mariadbd-multi.md

@@ -1,10 +1,18 @@
+---
+description: >-
+  Explains how to use `mariadbd-multi` to manage multiple MariaDB server
+  processes on a single host using GNR groups in the configuration file.
+---
+
 # mariadbd-multi
 
 Before using mariadbd-multi be sure that you understand the meanings of the options that are passed to the mariadbd servers and why you would want to have separate mariadbd processes. Beware of the dangers of using multiple mariadbd servers with the same data directory. Use separate data directories, unless you know what you are doing. Starting multiple servers with the same data directory does not give you extra performance in a threaded system.
 
 The `mariadbd-multi` startup script is in MariaDB distributions on Linux and Unix. It is a wrapper that is designed to manage several `mariadbd` processes running on the same host.
 
-Prior to [MariaDB 10.5](https://app.gitbook.com/s/aEnK0ZXmUbJzqQrTjFyb/community-server/old-releases/mariadb-10-5-series/what-is-mariadb-105), the client was called `mysqld_multi`. It can still be accessed under this name, via a symlink in Linux, or an alternate binary in Windows.
+{% hint style="info" %}
+Previously, the client was called `mysqld_multi`. It can still be accessed under this name, via a symlink in Linux, or an alternate binary in Windows.
+{% endhint %}
 
 In order for multiple `mariadbd` processes to work on the same host, these processes must:
 
@@ -19,7 +27,7 @@ In order for multiple `mariadbd` processes to work on the same host, these proce
 
 The command to use `mariadbd-multi` and the general syntax is:
 
-```
+```bash
 mariadbd-multi [options] {start|stop|report} [GNR[,GNR] ...]
 ```
 

server/server-management/starting-and-stopping-mariadb/mariadbd-options.md

@@ -1,3 +1,9 @@
+---
+description: >-
+  A reference list of command-line options available for the `mariadbd` server
+  binary, covering configuration, replication, and service installation.
+---
+
 # mariadbd Options
 
 This page lists all of the options for `mariadbd` (called mysqld before [MariaDB 10.5](https://app.gitbook.com/s/aEnK0ZXmUbJzqQrTjFyb/community-server/old-releases/mariadb-10-5-series/what-is-mariadb-105)), ordered by topic. For a full alphabetical list of all mariadbd options, as well as server and status variables, see [Full list of MariaDB options, system and status variables](../../reference/full-list-of-mariadb-options-system-and-status-variables.md).
@@ -8,7 +14,9 @@ By convention, [server variables](../../ha-and-performance/optimization-and-tuni
 
 See [Configuring MariaDB with Option Files](../install-and-upgrade-mariadb/configuring-mariadb/configuring-mariadb-with-option-files.md) for which files and groups mariadbd reads for it's default options.
 
-Prior to [MariaDB 10.5](https://app.gitbook.com/s/aEnK0ZXmUbJzqQrTjFyb/community-server/old-releases/mariadb-10-5-series/what-is-mariadb-105), the client used to be called `mysqld`, and can still be accessed under this name, via a symlink in Linux, or an alternate binary in Windows.
+{% hint style="info" %}
+Previously, the client used to be called `mysqld`, and can still be accessed under this name, via a symlink in Linux, or an alternate binary in Windows.
+{% endhint %}
 
 ## Option Prefixes
 

server/server-management/starting-and-stopping-mariadb/mariadbd-safe.md

@@ -1,18 +1,28 @@
+---
+description: >-
+  Details the `mariadbd-safe` wrapper script, which adds safety features like
+  auto-restart upon crash and error logging to syslog.
+---
+
 # mariadbd-safe
 
-The `mariadbd-safe` startup script is in MariaDB distributions on Linux and Unix. It is a wrapper that starts `mariadbd` with some extra safety features. For example, if `mariadbd-safe` notices that `mariadbd` has crashed, then `mariadbd-safe` will automatically restart `mariadbd`.
+The `mariadbd-safe` startup script is in MariaDB distributions on Linux and Unix. It is a wrapper that starts `mariadbd` with some extra safety features. For example, if `mariadbd-safe` notices that `mariadbd` has crashed, then `mariadbd-safe` automatically restarts `mariadbd`.
 
 `mariadbd-safe` is the recommended way to start `mariadbd` on Linux and Unix distributions that do not support [systemd](systemd.md). Additionally, the [mysql.server](mysql-server.md) init script used by [sysVinit](sysvinit.md) starts `mariadbd` with `mariadbd-safe` by default.
 
-Prior to [MariaDB 10.5](https://app.gitbook.com/s/aEnK0ZXmUbJzqQrTjFyb/community-server/old-releases/mariadb-10-5-series/what-is-mariadb-105), the client used to be called `mysqld_safe`, and can still be accessed under this name, via a symlink in Linux, or an alternate binary in Windows.
+{% hint style="info" %}
+Previously, the client used to be called `mysqld_safe`, and can still be accessed under this name, via a symlink in Linux, or an alternate binary in Windows.
+{% endhint %}
 
 ## Using mariadbd-safe
 
 The command to use `mariadbd-safe` and the general syntax is:
 
+{% code overflow="wrap" %}
 ```
 mariadbd-safe [ --no-defaults | --defaults-file | --defaults-extra-file | --defaults-group-suffix | --print-defaults ] <options> <mariadbd_options>
 ```
+{% endcode %}
 
 ### Options
 
@@ -95,18 +105,18 @@ The `[safe_mariadbd]` option group is primarily supported for backward compatibi
 
 For example, if you specify the [log\_error](../../ha-and-performance/optimization-and-tuning/system-variables/server-system-variables.md#log_error) option in a server option group in an option file, like this:
 
-```toml
+```ini
 [mariadb]
 log_error=error.log
 ```
 
-Then `mariadbd-safe` will also use this value for its own `--log-error` option:
+Then `mariadbd-safe` also uses this value for its own `--log-error` option:
 
 ### Configuring the Open Files Limit
 
 When using `mariadbd-safe`, the system's open files limit can be changed by providing the `--open-files-limit` option either on the command-line or in an option file. For example:
 
-```
+```ini
 [mariadbd-safe]
 open_files_limit=4294967295
 ```
@@ -119,7 +129,7 @@ When `mariadbd-safe` starts `mariadbd`, it also uses this option to set the valu
 
 When using `mariadbd-safe`, if you would like to [enable core dumps](https://app.gitbook.com/s/WCInJQ9cmGjq1lsTG91E/development-articles/debugging-mariadb/enabling-core-dumps), the system's core file size limit can be changed by providing the `--core-file-size` option either on the command-line or in an option file. For example:
 
-```
+```ini
 [mariadbd-safe]
 core_file_size=unlimited
 ```

server/server-management/starting-and-stopping-mariadb/mariadbd.md

@@ -1,6 +1,14 @@
+---
+description: >-
+  Describes the `mariadbd` binary (formerly `mysqld`), which is the core
+  database server executable.
+---
+
 # mariadbd
 
-Prior to [MariaDB 10.5](https://app.gitbook.com/s/aEnK0ZXmUbJzqQrTjFyb/community-server/old-releases/mariadb-10-5-series/what-is-mariadb-105), the client was called `mysqld`. It can still be accessed under this name, via a symlink in Linux, or an alternate binary in Windows.
+{% hint style="info" %}
+Previously, the client was called `mysqld`. It can still be accessed under this name, via a symlink in Linux, or an alternate binary in Windows.
+{% endhint %}
 
 See [mariadbd-options](mariadbd-options.md) for details.
 

server/server-management/starting-and-stopping-mariadb/mysql-server.md

@@ -1,8 +1,14 @@
+---
+description: >-
+  Documentation for the `mysql.server` script, a SysVinit-style wrapper used to
+  start and stop `mariadbd-safe`.
+---
+
 # mysql.server
 
 The [mysql.server](mysql-server.md) startup script is in MariaDB distributions on Linux and Unix. It is a wrapper that works as a standard [sysVinit](sysvinit.md) script. However, it can be used independently of [sysVinit](sysvinit.md) as a regular `sh` script. The script starts the [mariadbd](mariadbd-options.md) server process by first changing its current working directory to the MariaDB install directory and then starting [mariadbd-safe](mariadbd-safe.md). The script requires the standard [sysVinit](sysvinit.md) arguments, such as `start`, `stop`, `restart`, and `status`. For example:
 
-```
+```bash
 mysql.server start
 mysql.server restart
 mysql.server stop
@@ -17,13 +23,15 @@ The `mysql.server` script starts [mariadbd](mariadbd-options.md) by first changi
 
 The command to use `mysql.server` and the general syntax is:
 
-```
+{% code overflow="wrap" %}
+```bash
 mysql.server [ start | stop | restart | status ] <options> <mariadbd_options>
 ```
+{% endcode %}
 
 ### Options
 
-If an unknown option is provided to `mariadbd-safe` on the command-line, then it is passed to `mariadbd-safe`.
+If an unknown option is provided to `mariadbd-safe` on the command-line, it is passed to `mariadbd-safe`.
 
 `mysql.server` supports the following options:
 
@@ -76,9 +84,9 @@ If you have installed MariaDB to a non-standard location, then you may need to e
 
 If you do not want to edit the `mysql.server` script itself, then `mysql.server` also sources a few other `sh` scripts. These files can be used to set any variables that might be needed to make the script work in your specific environment. The files are:
 
-* /etc/default/mysql
-* /etc/sysconfig/mysql
-* /etc/conf.d/mysql
+* `/etc/default/mysql`
+* `/etc/sysconfig/mysql`
+* `/etc/conf.d/mysql`
 
 ## Installed Locations
 
@@ -88,18 +96,17 @@ If you do not want to edit the `mysql.server` script itself, then `mysql.server`
 
 On systems that use [sysVinit](sysvinit.md), `mysql.server` may also be installed in other locations and with other names.
 
-If you installed MariaDB on Linux using [RPMs](../install-and-upgrade-mariadb/installing-mariadb/binary-packages/rpm/), then the `mysql.server` script will be installed into the `/etc/init.d` directory with the name `mysql`. You need not install it manually.
+If you installed MariaDB on Linux using [RPMs](../install-and-upgrade-mariadb/installing-mariadb/binary-packages/rpm/), the `mysql.server` script is installed in the `/etc/init.d` directory with the name `mysql`. You need not install it manually.
 
 #### Manually Installing with SysVinit
 
-If you install MariaDB from [source](../install-and-upgrade-mariadb/installing-mariadb/compiling-mariadb-from-source/) or from a [binary tarball](../install-and-upgrade-mariadb/installing-mariadb/binary-packages/installing-mariadb-binary-tarballs.md) that does not install [mysql.server](mysql-server.md)\
-automatically, and if you are on a system that uses [sysVinit](sysvinit.md), then you can manually install `mysql.server` with [sysVinit](sysvinit.md). This is usually done by copying it to `/etc/init.d/` and then creating specially named symlinks in the appropriate `/etc/rcX.d/` directories (where 'X' is a number between 0 and 6).
+If you install MariaDB from [source](../install-and-upgrade-mariadb/installing-mariadb/compiling-mariadb-from-source/) or from a [binary tarball](../install-and-upgrade-mariadb/installing-mariadb/binary-packages/installing-mariadb-binary-tarballs.md) that does not install [mysql.server](mysql-server.md) automatically, and if you are on a system that uses [sysVinit](sysvinit.md), then you can manually install `mysql.server` with [sysVinit](sysvinit.md). This is usually done by copying it to `/etc/init.d/` and then creating specially named symlinks in the appropriate `/etc/rcX.d/` directories (where 'X' is a number between 0 and 6).
 
-In the examples below we will follow the historical convention of renaming the`mysql.server` script to '`mysql`' when we copy it to `/etc/init.d/`.
+In the examples below we will follow the historical convention of renaming the `mysql.server` script to '`mysql`' when we copy it to `/etc/init.d/`.
 
 The first step for most Linux distributions is to copy the `mysql.server` script to `/etc/init.d/` and make it executable:
 
-```
+```bash
 cd /path/to/your/mariadb-version/support-files/
 cp mysql.server /etc/init.d/mysql
 chmod +x /etc/init.d/mysql
@@ -109,20 +116,20 @@ Now all that is needed is to create the specially-named symlinks. On both RPM an
 
 On RPM-based distributions (like Fedora and CentOS), you use `chkconfig`:
 
-```
+```bash
 chkconfig --add mysql
 chkconfig --level 345 mysql on
 ```
 
 On Debian-based distributions you use `update-rc.d`:
 
-```
+```bash
 update-rc.d mysql defaults
 ```
 
 On FreeBSD, the location for startup scripts is`/usr/local/etc/rc.d/` and when you copy the`mysql.server` script there you should rename it so that it matches the `*.sh` pattern, like so:
 
-```
+```bash
 cd /path/to/your/mariadb/support-files/
 cp mysql.server /usr/local/etc/rc.d/mysql.server.sh
 ```

server/server-management/starting-and-stopping-mariadb/running-mariadb-from-the-build-directory.md

@@ -1,33 +1,33 @@
-# Running MariaDB from the Build Directory
+---
+description: >-
+  Instructions for developers on how to run MariaDB directly from the source
+  build directory without installing it to system paths.
+---
 
-You can run mariadbd directly from the build directory (without doing`make install`).
+# Running MariaDB From the Build Directory
+
+You can run mariadbd directly from the build directory (without doing `make install`).
 
 ## Starting mariadbd After Build on Windows
 
 On Windows, the data directory is produced during the build.
 
 The simplest way to start database from the command line is:
 
-1. Go to the directory where mariadbd.exe is located (subdirectory sql\Debug or sql\Relwithdebinfo of the build directory)
-2. From here, execute, if you are using [MariaDB 10.5](https://app.gitbook.com/s/aEnK0ZXmUbJzqQrTjFyb/community-server/old-releases/mariadb-10-5-series/what-is-mariadb-105) or newer,
-
-```
-mariadbd.exe --console
-```
-
-else
+1. Go to the directory where mariadbd.exe is located (subdirectory `sql\Debug` or `sql\Relwithdebinfo` of the build directory)
+2. From here, execute:
 
 ```
 mariadbd.exe --console
 ```
 
-As usual, you can pass other server parameters on the command line, or store them in a my.ini configuraton file and pass `--defaults-file=path\to\my.ini`
+Pass other server parameters on the command line, or store them in a `my.ini` configuraton file and pass `--defaults-file=path\to\my.ini` .
 
-The default search path on Windows for the my.ini file is:
+The default search path on Windows for the `my.ini` file is:
 
-* GetSystemWindowsDirectory()
-* GetWindowsDirectory()
-* C:\\
+* `GetSystemWindowsDirectory()`
+* `GetWindowsDirectory()`
+* `C:\`
 * Directory where the executable is located
 
 ## Starting mariadbd After Build on Unix
@@ -36,7 +36,7 @@ Copy the following to your '`~/.my.cnf`' file.
 
 There are two lines you have to edit: '`datadir=`' and '`language=`'. Be sure to change them to match your environment.
 
-```
+```ini
 # Example MariadB config file.
 # You can copy this to one of:
 # /etc/my.cnf to set global options,
@@ -97,31 +97,31 @@ set-variable= key_buffer=128M
 
 With the above file in place, go to your MariaDB source directory and execute:
 
+{% code overflow="wrap" %}
+```bash
+./scripts/mariadb-install-db --srcdir=$PWD --datadir=/path/to/data/dir
 ```
-./scripts/mariadb-install-db --srcdir=$PWD --datadir=/path/to/data/dir --user=$LOGNAME
-```
+{% endcode %}
 
-Above '$PWD' is the environment variable that points to your current directory.\
-If you added `datadir` to your `my.cnf`, you don't have to give this option above.\
-Also above, --user=$LOGNAME is necessary when using msqyld 10.0.1-MariaDB (and possibly other versions)
+* `$PWD` is the environment variable that points to your current directory. If you added `datadir` to your `my.cnf`, you don't have to specify this option.
 
-Now you can start `mariadbd` (or `mysqld` if you are using a version older than [MariaDB 10.5](https://app.gitbook.com/s/aEnK0ZXmUbJzqQrTjFyb/community-server/old-releases/mariadb-10-5-series/what-is-mariadb-105)) in the debugger:
+Now you can start `mariadbd` in the debugger:
 
-```
+```bash
 cd sql
 ddd ./mariadbd &
 ```
 
-Or start mariadbd on its own:
+Or start `mariadbd` on its own:
 
-```
+```bash
 cd sql
 ./mariadbd &
 ```
 
 After starting up `mariadbd` using one of the above methods (with the debugger or without), launch the client (as root if you don't have any users setup yet).
 
-```
+```bash
 ../client/mariadb
 ```