aboutsummaryrefslogtreecommitdiffstats
path: root/modules/Working
diff options
context:
space:
mode:
authorChloe Kudryavtsev <toast@toastin.space>2019-03-07 16:59:42 -0500
committerChloe Kudryavtsev <toast@toastin.space>2019-03-07 16:59:42 -0500
commit00b58146a2220265ab68f766d3efae885b3450f9 (patch)
tree6a26b01e31cb39746d475861cbbcc33db44f8eb6 /modules/Working
parentc952cef453d3756438c1eec423b7ee0670356821 (diff)
downloaduser-handbook-00b58146a2220265ab68f766d3efae885b3450f9.tar.bz2
user-handbook-00b58146a2220265ab68f766d3efae885b3450f9.tar.xz
[style] Use standard XXX
MAINT -> COMBAK
Diffstat (limited to 'modules/Working')
-rw-r--r--modules/Working/pages/apk.adoc26
-rw-r--r--modules/Working/pages/openrc.adoc10
-rw-r--r--modules/Working/pages/post-install.adoc4
3 files changed, 20 insertions, 20 deletions
diff --git a/modules/Working/pages/apk.adoc b/modules/Working/pages/apk.adoc
index f77c470..91ef5ff 100644
--- a/modules/Working/pages/apk.adoc
+++ b/modules/Working/pages/apk.adoc
@@ -1,4 +1,4 @@
-// MAINT: apk-tools - whole page
+// COMBAK: apk-tools - whole page
= Working with the Alpine Package Keeper (`apk`)
`apk` is the Alpine Package Keeper - the distribution's package manager.
@@ -6,7 +6,7 @@ It is used to manage the packages (software and otherwise) of the system.
It is the primary method for installing additional software, and is available in the `apk-tools` package.
== Normal Usage
-// MAINT: repositories and versions
+// COMBAK: repositories and versions
=== Repositories and Mirrors
`apk` fetches information about available packages, as well as the packages themselves from various mirrors, which contain various repositories.
Sometimes, those terms are used interchangeably.
@@ -23,7 +23,7 @@ main:: Officially supported packages that are reasonable to expect to be in a ba
community:: Packages from testing that have been tested. Support cycles are 6 months long.
testing:: New, broken, or outdated packages that need testing. No support for this repository is implied. It is not present in release snapshots.
-// MAINT: versioning scheme, edge
+// COMBAK: versioning scheme, edge
// TODO: verify
Releases are versioned using a versioning scheme somewhat reminiscent of semantic versioning.
However, one special release exists called "edge" - this is a "rolling" release.
@@ -34,7 +34,7 @@ Repositories are configurable in the `/etc/apk/repositories` file.
Each line corresponds to a repository.
The format is as follows:
-// MAINT: dl-cdn.alpinelinux.org
+// COMBAK: dl-cdn.alpinelinux.org
[source]
----
[@tag] [protocol][/path][/release]/repository
@@ -52,7 +52,7 @@ NOTE: This example uses the `http://` protocol. `ftp://` and `https://` protocol
// TODO: xref to installation part that's relevant
NOTE: This file should already have been been partially populated when you installed alpine.
-// MAINT: apk-search and pkgs.alpinelinux.org
+// COMBAK: apk-search and pkgs.alpinelinux.org
=== Searching for Packages
In order to know what package to install, one must be able to find packages.
Alpine has a specialized https://pkgs.alpinelinux.org[web interface] dedicated to looking through various available packages.
@@ -75,7 +75,7 @@ apk search -e so:libsqlite3.so.* <4>
<3> You can exclude partial matches using `-e`.
<4> You can specify that what you're searching for is a library using the `so:` prefix (or the `cmd:` prefix for commands, and `pc:` prefix for pkg-config files) - it will work with `-e` (in fact, the prefix is required for this use-case if `-e` is used).
-// MAINT: apk-add
+// COMBAK: apk-add
=== Installing Packages
Once you know what package you want to install, you must know how to do that.
Apk's `add` command is more strict than the `search` command - wildcards are not available, for instance.
@@ -113,14 +113,14 @@ apk add pc:msgpack <5>
NOTE: If `apk add` finds multiple matching packages (for example multiple `cmd:` matches), it will select the one with the highest version number.
-// MAINT: apk-update, apk-upgrade
+// COMBAK: apk-update, apk-upgrade
=== Upgrading Packages
Updating the system using apk is very simple.
One need only run `apk upgrade`.
Technically, this is two steps: `apk update`, followed by `apk upgrade` proper.
The first step will download an updated package index from the repositories, while the second step will update all packages in <<_world>>, as well as their dependencies.
-// MAINT: update-conf
+// COMBAK: update-conf
`apk` will avoid overwriting files you may have changed.
These will usually be in the `/etc` directory.
Whenever `apk` wants to install a file, but realizes a potentially edited one is already present, it will write its file to that filename with `.apk-new` appended.
@@ -129,7 +129,7 @@ Simply invoking it normally with present you with the difference between the two
NOTE: `apk update` is only ran once your cache is invalidated, which by default happens every 4 hours.
-// MAINT: apk-info
+// COMBAK: apk-info
=== Querying Package Information
In some cases, it may be useful to inspect packages or files to see various details.
For this use, the `info` subcommand exists.
@@ -137,10 +137,10 @@ It may be used on any package, installed or not, though the information on the l
It may also be used with specific flags on files.
By default, `info` will list the package description, webpage and installed size.
// TODO: link manual for apk(1)
-// MAINT: apk-info: `apk info -h` output
+// COMBAK: apk-info: `apk info -h` output
For more details (such as a list of flags the subcommand supports), you can use the `apk info -h` output's "Info options" section or see the manual page.
-// MAINT: apk-del
+// COMBAK: apk-del
=== Removing Packages
Often, it is desirable to remove a package.
This can be done using the `del` subcommand, with a base syntax that is identical to the `add` subcommand.
@@ -148,7 +148,7 @@ This can be done using the `del` subcommand, with a base syntax that is identica
NOTE: If you added a package using the `cmd:`, `so:` or `pc:` virtual, you must specify the same virtual to remove them.
NOTE: Removing a package will automatically remove all of its dependencies that are otherwise not used.
-// MAINT: apk-del: apk del -r
+// COMBAK: apk-del: apk del -r
The `del` subcommand also supports the `-r` flag, which will remove all packages that depend on the package being removed as well, rather than error out due to the package being needed.
=== Cleanup
@@ -167,7 +167,7 @@ If you've edited it by hand, you may run `apk add` with no arguments to bring th
NOTE: Virtuals like `cmd:`, `so:` and `pc:` will appear as such in your world file - this is why using `so:` is discouraged - the soname might get bumped!
-// MAINT: apk-add -t
+// COMBAK: apk-add -t
=== Virtuals
While `cmd:`, `so:` and `pc:` packages are automatically created virtuals, you can create your own as well.
These allow for quick removal of purpose-specific packages.
diff --git a/modules/Working/pages/openrc.adoc b/modules/Working/pages/openrc.adoc
index 3c617f9..7fdf56e 100644
--- a/modules/Working/pages/openrc.adoc
+++ b/modules/Working/pages/openrc.adoc
@@ -1,4 +1,4 @@
-// MAINT: openrc, whole page
+// COMBAK: openrc, whole page
= Working with OpenRC
OpenRC is the init system used in alpine.
@@ -14,7 +14,7 @@ If in doubt, use the canonical name, as is shown in this document.
== Normal Usage
=== Manipulating Services
-// MAINT: openrc, whole page
+// COMBAK: openrc, whole page
==== Runtime Service Manipulation
You manipulate services on a running system using the `rc-service` command.
This allows you to start, stop, and check the status of a given service, amongst other things.
@@ -44,7 +44,7 @@ Only run the specified command if the service is currently started.
NOTE: Services may define additional commands you can use. See more on this in <<_custom_service_commands>>.
-// MAINT: rc-update
+// COMBAK: rc-update
==== On-Boot Service Manipulation
OpenRC operates under a system called "runlevels".
More on that in <<_switching_runlevels>> and <<_custom_runlevels>>.
@@ -74,7 +74,7 @@ However, some services need configuration applied to them as part of the launch
This can be done in the `/etc/conf.d` directory, under the name of the service in question.
For example, for a service named "base", the configuration file would be `/etc/conf.d/base`.
-// MAINT: rc-status
+// COMBAK: rc-status
=== System Status
The `rc-status` utility is a fast way to view the current state of your system's services.
By default, it will list all the services in the current runlevel.
@@ -142,7 +142,7 @@ Their usage is identical to that of the built-in ones.
You can look inside the `init.d` script at various `extra*commands` variables which give a listing of the available ones.
// TODO: what's extra_started_commands etc?
-// MAINT: the insanity in sh/opnenrc-init.sh.in
+// COMBAK: the insanity in sh/opnenrc-init.sh.in
=== Extended `conf.d` Names
There are 4 total files that may play a role in the configuration of a service.
Assume that `base` stands for the name of the base server, `ext` is the extension (as per <<_multi_services>>) and `runlevel` is the runlevel it's in.
diff --git a/modules/Working/pages/post-install.adoc b/modules/Working/pages/post-install.adoc
index 2584e63..0cc7db0 100644
--- a/modules/Working/pages/post-install.adoc
+++ b/modules/Working/pages/post-install.adoc
@@ -56,7 +56,7 @@ sudo command with arguments <5>
<4> You may need to log out and log back in for the group listing to update. `sudo -i` is the equivalent of `su -` otherwise.
<5> This will run "command with arguments" as the default `sudo` user - root.
-// MAINT: alpine-desktop, alpine-conf (setup-xorg-base)
+// COMBAK: alpine-desktop, alpine-conf (setup-xorg-base)
== Getting a Graphical Environment
Most people will often want something more than just a raw tty.
This section describes how to get a supported graphical interface, as well as some additional notes (for example, how to use a different type of GUI).
@@ -70,7 +70,7 @@ This will automatically detect what kind of gpu is installed, and install the ap
NOTE: If this does not work for you, or you encounter other issues, as per usual, feel free to ask for help in the official support channels.
-// MAINT: alpine-desktop contents
+// COMBAK: alpine-desktop contents
Once that is done, you can install the recommended and supported graphical setup by installing (and thus running) `apk add alpine-desktop`.
This will install several system-related utilities, as well as the `lxdm` Desktop Manager and `xfce4` Desktop Environment.
In case you want a different DE or DM, you should install those now.