From a0f079fba415ecd748632d41908dc5bc0c7e0b88 Mon Sep 17 00:00:00 2001 From: "A. Wilcox" Date: Fri, 14 Dec 2018 14:49:52 -0600 Subject: Admin: implement ch07 mostly --- src/admin/3_packages.xml | 6 + src/admin/7_config.xml | 369 ++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 372 insertions(+), 3 deletions(-) (limited to 'src/admin') diff --git a/src/admin/3_packages.xml b/src/admin/3_packages.xml index 6d7109b..e7e70bb 100644 --- a/src/admin/3_packages.xml +++ b/src/admin/3_packages.xml @@ -56,4 +56,10 @@ U etc/passwd --directory-permissions, which will repair all directory permissions. +
+ Package repositories + A package repository is a collection of packages that you may install on your computer. The Adélie Linux project runs two official package repositories: system, which contains essential packages that are necessary for the operation of computers running the Adélie Linux system, and user, which contains packages that can be installed and uninstalled by users and administrators. + You may run your own package repository using the information contained in our Developer's Handbook. There are also external package repositories on the Internet. Some of these may contain experimental software ports or software that could not be included in the Adélie Linux system. They may also contain malware, software that can harm your computer or cause security issues. Please always ensure that repositories that you add to your system are authored by people or organisations you trust. + Management of package repositories is accomplished via the /etc/apk/repositories configuration file. Refer to for more information on the /etc/apk/repositories configuration file. +
diff --git a/src/admin/7_config.xml b/src/admin/7_config.xml index c855b69..5a7b704 100644 --- a/src/admin/7_config.xml +++ b/src/admin/7_config.xml @@ -1,9 +1,372 @@ System Configuration - + In this chapter, we will overview the main configuration files present in the Adélie Linux system.
- - + Introduction + This chapter will cover the main configuration files that are commonly referenced in the daily administration of Adélie Linux systems. This list is not exhaustive, and is not a list of every configuration file in the Adélie Linux system. Some configuration files are only present when a specific system option (such as audio, graphics, or networking) is installed. + Each section in this chapter has the following subsections: + + Purpose, which describes for what the configuration file is responsible; + Syntax, which describes the high-level syntax type used by the configuration file; and finally, + either Detailed Information for information on configuration files specific to the Adélie Linux system, or External References for either manual pages or online links to more information about configuration files from packages. + +
+
+ <filename>/etc/abuild.conf</filename>: Package build configuration +
+ Purpose + The /etc/abuild.conf file determines how packages are built on the system. This file sets global parameters; $HOME/.abuild.conf can override any setting from the /etc/abuild.conf on a per-user basis. +
+
+ Syntax + Shell script. Comments may appear anywhere, and start with '#'. Variables are in uppercase and follow shell quote syntax. +
+
+ External References + Please reference the Adélie Linux Developer's Handbook for more information about how to configure /etc/abuild.conf. If you are reading this documentation on your local computer, the Developer's Handbook may be found in the devel/ directory at the same level as this handbook's admin/ directory. If you are reading this documentation online via the Internet, you may find the newest version of the Developer's Handbook at the Adélie Linux Help Centre. +
+
+
+ <filename>/etc/apk/repositories</filename>: Package repository configuration +
+ Purpose + The /etc/apk/repositories file determines the repositories used by the APK package manager for obtaining packages. As noted in , package repositories contain packages that you may install and uninstall on an Adélie Linux system. +
+
+ Syntax + A single URL or file location per line. Comments are not allowed. +
+
+ Detailed Information + A repository must be either a URL (beginning with https://) or an absolute path (such as /srv/packages). The computer's architecture (as specified in /etc/apk/arch) will be appened to the path – for example, specifying the path /srv/packages/repository on a ppc64 computer will result in the packages and APKINDEX being retrieved from /srv/packages/repository/ppc64. + If a repository is invalid, does not have a recognised signing key, or does not exist, it will not be considered by APK. Depending on the parameters passed to APK and the operation being performed, this may be a warning or a fatal error. +
+
+
+ <filename>/etc/asound.conf</filename>: System audio configuration +
+ Purpose + The /etc/asound.conf file determines the behaviour audio hardware present on the system. It can be used to select default bitrates, configure hardware options, and determine which sound card is the default/primary in a system with multiple sound cards present. This file is only significant on systems that have audio options installed. +
+
+ Syntax + Sections are blocks, with the name followed by curly braces ({ and }) where the options are specified for that section. See the external reference for more information. +
+
+ External References + For more information on configuring system audio hardware, refer to the official documentation at the ALSA Project Web site on the Internet. +
+
+
+ <filename>/etc/bash/bashrc</filename>: Bash shell startup configuration +
+ Purpose + The /etc/bash/bashrc file is sourced by the Bash shell when it starts up. This can set shell options and configure the shell environment for you. It is highly recommended to create your own scripts inside /etc/profile.d instead of modifying /etc/bash/bashrc, since it may change during upgrades to the Bash package. This file is only present on systems that have the Bash shell installed. +
+
+ Syntax + Shell script. +
+
+ External References + For more information, refer to the bash(1) manpage. If this manpage is not present on your system, it may be installed via the bash-doc package. +
+
+
+ <filename>/etc/conf.d/alsa</filename>: Mixer level configuration +
+ Purpose + The /etc/conf.d/alsa file determines if volume levels are preserved across system restarts when the alsasound service is enabled. This file is only significant on systems that have audio options installed. +
+
+ Syntax + Shell script. Variables are in uppercase. +
+
+ External References + For more information, refer to the comments in the /etc/conf.d/alsa file. +
+
+
+ <filename>/etc/conf.d/bootmisc</filename>: Boot behaviour configuration +
+ Purpose + The /etc/conf.d/bootmisc file determines certain characteristics about boot behaviour. It controls whether the /tmp directory is cleaned, and whether dmesg is written to /var/log/dmesg on boot. It also controls if the previous /var/log/dmesg is renamed to /var/log/dmesg.old for later comparison. +
+
+ Syntax + Shell script. Variables are in lowercase. Booleans may be set as YES or NO. +
+
+ Detailed Information + The following variables are configurable in the /etc/conf.d/bootmisc file: + + Configurable variables in <filename>/etc/conf.d/bootmisc</filename> + + + + Variable + Meaning + Default + + + + + clean_tmp_dirs + Directories to be treated as temporary, to be cleaned when wipe_tmp is YES. + /tmp + + + wipe_tmp + Determines if the directories listed in clean_tmp_dirs are completely erased on system boot. + YES + + + log_dmesg + Determines if the contents of the dmesg kernel message buffer are written to /var/log/dmesg on system boot. + YES + + + previous_dmesg + When log_dmesg is YES, determines if /var/log/dmesg is moved to /var/log/dmesg.old on system boot instead of being overwritten. + NO + + + +
+
+
+
+ <filename>/etc/conf.d/devfs</filename>: <filename class="directory">/dev</filename> configuration +
+ Purpose + The /etc/conf.d/devfs file determines if the system attempts to mount /dev during system initialisation. Most systems will not need this configuration modified. +
+
+ Syntax + Shell script. Variables are in lowercase. Booleans may be set as YES or NO. +
+
+ Detailed Information + The skip_mount_dev variable may be set to YES to prevent the system from automatically attempting to mount /dev during system initialisation. The default setting of the skip_mount_dev variable is NO. +
+
+
+ <filename>/etc/conf.d/dmesg</filename>: <literal>dmesg</literal> configuration +
+ Purpose + The /etc/conf.d/dmesg file determines the behaviour of the dmesg kernel log buffer. +
+
+ Syntax + Shell script. Variables are in lowercase. +
+
+ Detailed Information + The dmesg_level controls the "console level", or the severity required for a message to be printed to the system console. The default value is 1, which corresponds to the emerg log level. This prevents all messages from being written to the console except kernel panics. +
+
+
+ <filename>/etc/conf.d/fsck</filename>: Startup file system check configuration +
+ Purpose + The /etc/conf.d/fsck file determines the behaviour of the fsck (file system check) command during system initialisation. It is important to note that the configuration in the /etc/conf.d/fsck does not control manual invocations of the fsck command. +
+
+ Syntax + Shell script. Variables are in lowercase. Booleans may be set as YES or NO. +
+
+ Detailed Information + The following variables are configurable in the /etc/conf.d/fsck file: + + Configurable variables in <filename>/etc/conf.d/fsck</filename> + + + + Variable + Meaning + Default + + + + + fsck_args + Determines the command line arguments passed for routine fsck. + -p -C0 -T -A + + + fsck_passno + Determines which file systems will be checked by routine fsck during system initialisation by their "pass number" in /etc/fstab. + + + + fsck_on_battery + Determines if fsck will be run on startup if the computer is running on battery power. + YES + + + fsck_shutdown + Determines if routine fsck should be performed during system shutdown, instead of during system initialisation. + NO + + + fsck_abort_on_errors + Determines if system initialisation should be halted if fsck finds errors. + YES + + + +
+
+
+
+ <filename>/etc/conf.d/gettys</filename>: System console configuration +
+ Purpose + The /etc/conf.d/gettys file determines the parameters and behaviour of virtual terminals (VTs) and serial consoles on the system. +
+
+ Syntax + Shell script. Variables are mixed-case. +
+
+ Detailed Information + The /etc/conf.d/gettys file defines the variable GETTYS. The GETTYS variable controls the devices that the system will search for, on which to run VTs. Each device is separated by a space (" "). The default is "tty1 tty2 tty3 tty4 tty5 tty6 hvc0", which will start a VT on each virtual TTY 1-6, and also start a VT on hvc0 if it exists. The hvc0 device is present on most IBM servers, and also most Xen guests. + For every device specified in GETTYS, the following two variables can be used for further device configuration: + + Configuration variables in <filename>/etc/conf.d/gettys</filename> + + GETTYS_term_OPTIONS + Determines the options passed to agetty for this VT. For more information, refer to the agetty manual, found in the util-linux-doc package. + + + GETTYS_term_BAUDRATE + Determines the baud rate of the specified serial line. This option is only effective on devices that act as serial lines. + + + ImportantChanges to this file will not take effect until the system is restarted. +
+
+
+ <filename>/etc/conf.d/hwclock</filename>: System time configuration +
+ Purpose + The /etc/conf.d/hwclock file determines how the system will use the hardware real time clock (RTC), if present. +
+
+ Syntax + Shell script. Variables are in lowercase. Booleans may be set as YES or NO. +
+
+ Detailed Information + +
+
+
+ <filename>/etc/conf.d/keymaps</filename>: Keyboard layout configuration +
+ Purpose + The /etc/conf.d/keymaps file determines certain behaviours of the keyboard connected to the system console. +
+
+ Syntax + Shell script. Variables are in lowercase. Booleans may be set as YES or NO. +
+
+ Detailed Information + The /etc/conf.d/keymaps file +
+
+
+ <filename>/etc/conf.d/modules</filename>: Kernel module configuration +
+ Purpose + The /etc/conf.d/ file +
+
+ Syntax + Shell script. Variables are in +
+
+ Detailed Information + +
+
+
+ <filename>/etc/conf.d/net</filename>: Network configuration +
+ Purpose + The /etc/conf.d/net file determines the configuration of the network adaptor(s) installed in the system. +
+
+ Syntax + Shell script style. +
+
+ Detailed Information + Refer to for information on configuring networks using the Adélie Linux system. +
+
+
+ <filename>/etc/conf.d/netmount</filename>: Network file system configuration +
+ Purpose + The /etc/conf.d/ file +
+
+ Syntax + Shell script. Variables are in +
+
+ Detailed Information + +
+
+
+ <filename>/etc/conf.d/swap</filename>: Network swap file configuration +
+ Purpose + The /etc/conf.d/ file +
+
+ Syntax + Shell script. Variables are in +
+
+ Detailed Information + +
+
+
+ <filename>/etc/conf.d/udev-trigger</filename>: Hardware hot-plug configuration +
+ Purpose + The /etc/conf.d/ file +
+
+ Syntax + Shell script. Variables are in +
+
+ Detailed Information + +
+
+
+ <filename>/etc/conf.d/urandom</filename>: Random number configuration +
+ Purpose + The /etc/conf.d/ file +
+
+ Syntax + Shell script. Variables are in +
+
+ Detailed Information + +
-- cgit v1.2.3-70-g09d2