Alpine Linux:FAQ - Revision history

Apropos: /* Why don't I have man pages or where is the 'man' command? */ Note interaction of MANPATH environment variable with man page lookup

2026-03-22T03:18:05Z

Why don't I have man pages or where is the 'man' command?: Note interaction of MANPATH environment variable with man page lookup

← Older revision		Revision as of 03:18, 22 March 2026
Line 54:		Line 54:
	The core utilities provided by [[BusyBox]] – e.g. {{ic\|ls}}, {{ic\|traceroute}} and {{ic\|poweroff}} – do not have individual man pages in keeping with BusyBox's minimalist design. Instead, the man page package for BusyBox, {{pkg\|busybox-doc}}, supplies a single '''busybox''' man page that lists all the available switches for those utility applets; once '''busybox-doc''' is installed, the switches for each utility can be listed using the {{ic\|--help}} option – e.g. {{ic\|ls --help}} – or by scrolling through {{ic\|$ man busybox}}.		The core utilities provided by [[BusyBox]] – e.g. {{ic\|ls}}, {{ic\|traceroute}} and {{ic\|poweroff}} – do not have individual man pages in keeping with BusyBox's minimalist design. Instead, the man page package for BusyBox, {{pkg\|busybox-doc}}, supplies a single '''busybox''' man page that lists all the available switches for those utility applets; once '''busybox-doc''' is installed, the switches for each utility can be listed using the {{ic\|--help}} option – e.g. {{ic\|ls --help}} – or by scrolling through {{ic\|$ man busybox}}.

	Install the ''man pages reader'' called {{pkg\|mandoc}}. It is the default reader since Alpine Linux v3.12, preferred over {{pkg\|man-db}} or {{pkg\|man-pages}}, as it supplies a smaller, faster and more secure <code>man</code> command:		Install the ''man pages reader'' called {{pkg\|mandoc}}. It is the default reader since Alpine Linux v3.12, preferred over {{pkg\|man-db}} or {{pkg\|man-pages}}, as it supplies a smaller, faster, and more secure <code>man</code> command:
	{{cmd\|# apk add {{pkg\|mandoc}}}}		{{cmd\|# apk add {{pkg\|mandoc}}}}

Line 60:		Line 60:
	{{cmd\|# apk add {{pkg\|nftables-doc}}}}		{{cmd\|# apk add {{pkg\|nftables-doc}}}}

	~~The~~ {{pkg\|docs}} meta package will immediately install the documentation sub-package for all of the currently installed packages, plus the {{pkg\|mandoc}} reader, if not installed. {{pkg\|docs}} additionally ensures that documentation sub-packages are installed/removed automatically for any packages that one may add/remove in the future.		Alternatively, the {{pkg\|docs}} meta package will immediately install the documentation sub-package for all of the currently installed packages (plus the {{pkg\|mandoc}} reader, if not installed). {{pkg\|docs}} additionally ensures that documentation sub-packages are installed/removed automatically for any packages that one may add/remove in the future.

	{{cmd\|# apk add docs}}		{{cmd\|# apk add docs}}
Line 77:		Line 77:
	[...]		[...]

	Keep in mind that not all packages have a corresponding documentation package, and even when it has one, it may not be in the form of ~~'''~~man pages~~'''~~.		Keep in mind that not all packages have a corresponding documentation package, and even when it has one, it may not be in the form of man pages. Also ensure that the <code>MANPATH</code> environment variable, if set, includes <code>/usr/share/man</code> and <code>/usr/local/share/man</code>. If not set, <code>man</code> will fall back on default man page paths, so there is no need to set it explicitly, unless other <code>man</code> page locations are added.

	==Setup==		==Setup==

John3-16: /* Why don't I have man pages or where is the 'man' command? */ Two syntax amendments.

2026-02-19T20:45:52Z

Why don't I have man pages or where is the 'man' command?: Two syntax amendments.

← Older revision		Revision as of 20:45, 19 February 2026
Line 52:		Line 52:

	The <code>man</code> command, the {{pkg\|man-pages}} and the system's ''core'' manual pages are not installed by default. Since binary packages are thinned out and split, documentation sub-packages in the format '''packagename-doc''' are not installed by default.		The <code>man</code> command, the {{pkg\|man-pages}} and the system's ''core'' manual pages are not installed by default. Since binary packages are thinned out and split, documentation sub-packages in the format '''packagename-doc''' are not installed by default.
	The core utilities provided by [[BusyBox]] e.g. {{ic\|ls}}, {{ic\|traceroute}} and {{ic\|poweroff}}) do not have individual man pages in keeping with BusyBox's minimalist design. Instead, the man page package for BusyBox, {{pkg\|busybox-doc}}, supplies a single '''busybox''' man page that lists all the available switches for those utility applets; once '''busybox-doc''' is installed, the switches for each utility can be listed using the {{ic\|--help}} option – e.g. {{ic\|ls --help}} – or by scrolling through {{ic\|$ man busybox}}.		The core utilities provided by [[BusyBox]] – e.g. {{ic\|ls}}, {{ic\|traceroute}} and {{ic\|poweroff}} – do not have individual man pages in keeping with BusyBox's minimalist design. Instead, the man page package for BusyBox, {{pkg\|busybox-doc}}, supplies a single '''busybox''' man page that lists all the available switches for those utility applets; once '''busybox-doc''' is installed, the switches for each utility can be listed using the {{ic\|--help}} option – e.g. {{ic\|ls --help}} – or by scrolling through {{ic\|$ man busybox}}.

	Install the ''man pages reader'' called {{pkg\|mandoc}}. It is the default reader since Alpine Linux v3.12, preferred over {{pkg\|man-db}} or {{pkg\|man-pages}}, as it supplies a smaller, faster and more secure <code>man</code> command:		Install the ''man pages reader'' called {{pkg\|mandoc}}. It is the default reader since Alpine Linux v3.12, preferred over {{pkg\|man-db}} or {{pkg\|man-pages}}, as it supplies a smaller, faster and more secure <code>man</code> command:
Line 69:		Line 69:

	Then, search installed man pages for the command:		Then, search installed man pages for the command:
	~~<pre>~~
	$ apropos <var>password</var>		$ apropos <var>password</var>
	chage(1) - change user password expiry information		chage(1) - change user password expiry information
	expiry(1) - check and enforce password expiration policy		expiry(1) - check and enforce password expiration policy
	git-credential-cache(1) - Helper to temporarily store passwords in memory		git-credential-cache(1) - Helper to temporarily store passwords in memory
	keepassxc(1) - a modern open-source password manager		keepassxc(1) - a modern open-source password manager
	[...]		[...]
	~~</pre>~~

	Keep in mind that not all packages have a corresponding documentation package, and even when it has one, it may not be in the form of '''man pages'''.		Keep in mind that not all packages have a corresponding documentation package, and even when it has one, it may not be in the form of '''man pages'''.

John3-16: /* Why don't I have man pages or where is the 'man' command? */ 1. Enhanced guidance re any man page availability for core utils, mandoc, mandoc-apropos; 2. Reordered information according to usage i.e. docs package promoted; 3. Style/grammar amendments.

2026-02-19T20:31:46Z

Why don't I have man pages or where is the 'man' command?: 1. Enhanced guidance re any man page availability for core utils, mandoc, mandoc-apropos; 2. Reordered information according to usage i.e. docs package promoted; 3. Style/grammar amendments.

← Older revision		Revision as of 20:31, 19 February 2026
Line 51:		Line 51:
	=== Why don't I have man pages or where is the 'man' command? ===		=== Why don't I have man pages or where is the 'man' command? ===

	The <code>man</code> command ~~and~~ {{pkg\|man-pages}}, the system's ''core'' manual pages are not installed by default. Since binary packages are thinned out and split, documentation sub-packages in the format '''packagename-doc''' are not installed by default.		The <code>man</code> command, the {{pkg\|man-pages}} and the system's ''core'' manual pages are not installed by default. Since binary packages are thinned out and split, documentation sub-packages in the format '''packagename-doc''' are not installed by default.
			The core utilities provided by [[BusyBox]] e.g. {{ic\|ls}}, {{ic\|traceroute}} and {{ic\|poweroff}}) do not have individual man pages in keeping with BusyBox's minimalist design. Instead, the man page package for BusyBox, {{pkg\|busybox-doc}}, supplies a single '''busybox''' man page that lists all the available switches for those utility applets; once '''busybox-doc''' is installed, the switches for each utility can be listed using the {{ic\|--help}} option – e.g. {{ic\|ls --help}} – or by scrolling through {{ic\|$ man busybox}}.

	Install the <code>man</code> command:		Install the ''man pages reader'' called {{pkg\|mandoc}}. It is the default reader since Alpine Linux v3.12, preferred over {{pkg\|man-db}} or {{pkg\|man-pages}}, as it supplies a smaller, faster and more secure <code>man</code> command:
	{{cmd\|# apk add {{pkg\|mandoc}}}}		{{cmd\|# apk add {{pkg\|mandoc}}}}

	~~Optionally, install the <code>apropos</code> command to search in '''man pages''':~~		Once {{pkg\|mandoc}} is installed, add documentation for the package where you need it. For example, say you installed '''nftables''', and you now require its man page:
	~~{{cmd\|# apk add {{pkg\|mandoc-apropos}}}}~~

	Once {{pkg\|mandoc}} is installed,add documentation for the package where you need it. For example, say you installed nftables and you now require its man ~~pages~~:
	{{cmd\|# apk add {{pkg\|nftables-doc}}}}		{{cmd\|# apk add {{pkg\|nftables-doc}}}}

	The {{pkg\|docs}} meta package ~~installs~~ the documentation sub-package for all the currently installed packages ~~and~~ {{pkg\|mandoc}}, if ~~unavailable~~. {{pkg\|docs}} ~~meta package~~ ensures that documentation sub-packages are installed or removed automatically for any packages that ~~you~~ may add/remove in future.		The {{pkg\|docs}} meta package will immediately install the documentation sub-package for all of the currently installed packages, plus the {{pkg\|mandoc}} reader, if not installed. {{pkg\|docs}} additionally ensures that documentation sub-packages are installed/removed automatically for any packages that one may add/remove in the future.

	{{cmd\|# apk add docs}}		{{cmd\|# apk add docs}}

	Keep in mind not all packages have a corresponding documentation package and even when it has one it may not be in the form '''man pages'''.		Optionally, to be able to search all ''installed'' man pages for a given command, say, {{ic\|<var>password</var>}}, install {{pkg\|mandoc-apropos}}, which supplies the <code>apropos</code> instruction.

			{{cmd\|# apk add {{pkg\|mandoc-apropos}}}}

			Then, search installed man pages for the command:
			<pre>
			$ apropos <var>password</var>
			chage(1) - change user password expiry information
			expiry(1) - check and enforce password expiration policy
			git-credential-cache(1) - Helper to temporarily store passwords in memory
			keepassxc(1) - a modern open-source password manager
			[...]
			</pre>

			Keep in mind that not all packages have a corresponding documentation package, and even when it has one, it may not be in the form of '''man pages'''.

	==Setup==		==Setup==

Prabuanand: updated wikilnk

2025-10-31T15:52:02Z

updated wikilnk

← Older revision		Revision as of 15:52, 31 October 2025
Line 72:		Line 72:
	=== What is the difference between ''sys'', ''data'', and ''diskless'' when running <code>setup-alpine</code> or <code>setup-disk</code>? ===		=== What is the difference between ''sys'', ''data'', and ''diskless'' when running <code>setup-alpine</code> or <code>setup-disk</code>? ===

	[[~~Setting up disks manually~~\|'''sys''' or '''system''' disk]] mode is the traditional disk ~~install~~. The following partitions will be created on the disk: ''/boot/'', ''/'' (filesystem root) and ''swap''. This mode may be used for development boxes, desktops, virtual servers, etc.		[[System Disk Mode\|'''sys''' or '''system''' disk]] mode is the traditional hard disk installation. The following partitions will be created on the disk: ''/boot/'', ''/'' (filesystem root) and ''swap'', if <code>setup-alpine</code> is used, or use <code>setup-disk</code> script for custom partitioning. This mode may be used for development boxes, desktops, virtual servers, etc.

	In [[Data Disk Mode\|'''data''' disk]] mode, disk(s) are used for data storage, not for the operating system. Runs from the media and only a ''/var/'' is created on disk. The system itself will run from a ''tmpfs'' (RAM). Use this mode if you only want to use the disk(s) for data, like ''mailspool'', ''databases'', ''logs'', etc.		In [[Data Disk Mode\|'''data''' disk]] mode, disk(s) are used for data storage, not for the operating system. Runs from the media and only a ''/var/'' is created on disk. The system itself will run from a ''tmpfs'' (RAM). Use this mode if you only want to use the disk(s) for data, like ''mailspool'', ''databases'', ''logs'', etc.

Prabuanand: added wikilink

2025-05-09T08:46:23Z

added wikilink

← Older revision		Revision as of 08:46, 9 May 2025
Line 170:		Line 170:

	=== Fix lacking lsusb / lspci output ===		=== Fix lacking lsusb / lspci output ===
			{{Main\|How to get regular stuff working}}
	If you launch {{ic\|lsusb}} or {{ic\|lspci}} on a ~~minimal~~ installation, there's no device descriptions, and the latter doesn't exist.		If you launch {{ic\|lsusb}} or {{ic\|lspci}} on a default installation, there's no device descriptions, and the latter doesn't exist.

	This can be fixed by installing the '''{{pkg\|usbutils}}''' and '''{{pkg\|hwdata}}''' tables.		This can be fixed by installing the '''{{pkg\|usbutils}}''' and '''{{pkg\|hwdata}}''' tables.

Prabuanand: added wikilinks and minor additions

2025-05-09T08:35:44Z

added wikilinks and minor additions

← Older revision		Revision as of 08:35, 9 May 2025
Line 72:		Line 72:
	=== What is the difference between ''sys'', ''data'', and ''diskless'' when running <code>setup-alpine</code> or <code>setup-disk</code>? ===		=== What is the difference between ''sys'', ''data'', and ''diskless'' when running <code>setup-alpine</code> or <code>setup-disk</code>? ===

	'''sys:''' ~~This~~ mode is a traditional disk install. The following partitions will be created on the disk: ''/boot/'', ''/'' (filesystem root) and ''swap''.		[[Setting up disks manually\|'''sys''' or '''system''' disk]] mode is the traditional disk install. The following partitions will be created on the disk: ''/boot/'', ''/'' (filesystem root) and ''swap''. This mode may be used for development boxes, desktops, virtual servers, etc.
	This mode may be used for development boxes, desktops, virtual servers, etc.

	'''data:''' ~~This~~ mode ~~uses your~~ disk(s) for data storage, not for the operating system. Runs from the media and only a ''/var/'' is created on disk. The system itself will run from a ''tmpfs'' (RAM). Use this mode if you only want to use the disk(s) for data, like ''mailspool'', ''databases'', ''logs'', etc.		In [[Data Disk Mode\|'''data''' disk]] mode, disk(s) are used for data storage, not for the operating system. Runs from the media and only a ''/var/'' is created on disk. The system itself will run from a ''tmpfs'' (RAM). Use this mode if you only want to use the disk(s) for data, like ''mailspool'', ''databases'', ''logs'', etc.

	'''diskless:''' No disks are to be used. [[Alpine local backup]] may still be used in this mode.		In [[Diskless Mode\|'''diskless''']] mode, no disks are to be used. Here the entire system run from a ''tmpfs'' (RAM). [[Alpine local backup]] may still be used in this mode.

	~~These modes are explained further on the [[Installation#Installation_Overview\|'''Installation''']] page~~.

	=== How do I upgrade Alpine? ===		=== How do I upgrade Alpine? ===

	To upgrade to a new stable release or edge:		To upgrade to a new stable release or edge refer to [[Upgrading Alpine Linux to a new release branch]].
	~~{{ic\|apk upgrade --available}}~~

	=== Why don't my cron jobs run? ===		=== Why don't my cron jobs run? ===
			{{Main\|Cron}}
	Start service ''crond'' and add it to the default runlevel:		Start service ''crond'' and add it to the default runlevel:{{cmd\|rc-service crond start && rc-update add crond}}

	: {{cmd\|rc-service crond start && rc-update add crond}}

	After that the cron daemon is started automatically on system boot and executes the scripts placed in the folders under ''/etc/periodic/'' - there are folders for ''15min'', ''hourly'', ''daily'', ''weekly'' and ''monthly'' scripts.		After that the cron daemon is started automatically on system boot and executes the scripts placed in the folders under ''/etc/periodic/'' - there are folders for ''15min'', ''hourly'', ''daily'', ''weekly'' and ''monthly'' scripts.

	To check whether your scripts are likely to run, use the ''run-parts'' command, for example:		To check whether your scripts are likely to run, use the ''run-parts'' command, for example:{{cmd\|run-parts --test /etc/periodic/15min}}

	: {{cmd\|run-parts --test /etc/periodic/15min}}

	This command will tell you what should run but will not actually execute the scripts.		This command will tell you what should run but will not actually execute the scripts.

Prabuanand: reworded to match the Repositories page

2025-05-09T08:23:52Z

reworded to match the Repositories page

← Older revision		Revision as of 08:23, 9 May 2025
Line 20:		Line 20:
	Please check the [https://alpinelinux.org/releases/ Release Branches] page for more information.		Please check the [https://alpinelinux.org/releases/ Release Branches] page for more information.

	=== What is the difference between edge and stable ~~releases~~? ===		=== What is the difference between edge and stable release branch? ===
	~~Stable releases are just what they sound like: initially a point-in-time snapshot of the package archives, but then maintained with bugfixes only in order to keep a stable environment.~~

	[[Repositories#Edge\|Edge]] is ~~more~~ of a rolling-release~~, with~~ the latest ~~and greatest~~ packages ~~available~~ in the ~~online repositories~~.~~<br />~~		[[Repositories#Edge\|'''Edge''']] is the name given to the current [[Aports tree\|development tree]] of Alpine Linux. ''edge'' can be considered as '''rolling release version''' of Alpine Linux. This version contains the latest build of all available Alpine Linux packages. Those packages are updated on a regular basis.
	Occasionally, snapshot ISO images of the then-current state of edge are made and are available for download.~~<br />~~
	Typically these are made when there are major kernel upgrades or package upgrades that require initramfs rebuilds.		[[Repositories#Release Branches\|Stable release branches]] are just what they sound like: initially a point-in-time snapshot of the package archives, but then maintained with bugfixes only in order to keep a stable environment. Occasionally, snapshot ISO images of the then-current state of edge are made and are available for download. Typically these are made when there are major kernel upgrades or package upgrades that require initramfs rebuilds.

	=== What architectures does Alpine Linux support? ===		=== What architectures does Alpine Linux support? ===

Prabuanand: reworded sentence

2025-05-09T08:12:30Z

reworded sentence

← Older revision		Revision as of 08:12, 9 May 2025
Line 123:		Line 123:
	=== What does "required by: world[$pkgname]" mean? ===		=== What does "required by: world[$pkgname]" mean? ===

	It means that the package you tried to install does not exist in the repositories you have configured.		It means that the package you tried to install does not exist in the [[Alpine Package Keeper#Packages and Repositories\|repositories]] you have configured.

	~~Maybe you forgot to add~~ community ~~or testing to~~ {{path\|/etc/apk/repositories}}?		Ensure that the [[Repositories#Managing_repositories\|community repository is enabled]] in the {{path\|/etc/apk/repositories}} file.

	Or is the package in a [[~~Alpine Package Keeper~~#~~Repository pinning~~\|~~pinned~~ repository]] and you forgot to suffix the package with the repo tag? Example:		Or is the package in a [[Repositories#Tagged_repository\|tagged repository]] and you forgot to suffix the package with the repo tag? Example:{{cmd\|# apk add experimental-package@testing}}

	{{cmd\|apk add experimental-package@testing}}

	=== How can I find out if a certain package exists in Alpine? ===		=== How can I find out if a certain package exists in Alpine? ===

Prabuanand: removed the content and added back as link

2025-03-22T09:04:00Z

removed the content and added back as link

← Older revision		Revision as of 09:04, 22 March 2025
Line 219:		Line 219:

	=== Using a cron job to keep the time in sync ===		=== Using a cron job to keep the time in sync ===
	~~Add the following to {{path~~\|~~/etc/periodic/daily}} (or use another folder under the {{path\|/etc/periodic}} hierarchy if you want~~ to run the ~~script more/less frequently)~~		The [[Cron#Basic_example\|cron]] page explains how to run the command {{ic\|ntpd -d -q -n -p uk.pool.ntp.orgA}} as a cron job.

	~~Example: file called~~ {{~~path~~\|~~do-ntp}}~~
	~~<pre>~~
	~~#!/bin/sh~~
	ntpd -d -q -n -p uk.pool.ntp.~~org</pre>~~

	~~This queries the uk time server pool - you can modify this to suit your localisation, or just use ''pool.ntp.org''. More info here: [https://www.pool.ntp~~.~~org/zone/@ https://www.pool.ntp.org/zone/@]~~

	=== Windows clients reports an error when trying to sync ===		=== Windows clients reports an error when trying to sync ===

Prabuanand: Removed the link and transcluded :Include:Architecture support matrix

2024-12-20T14:00:16Z

Removed the link and transcluded Include:Architecture support matrix

← Older revision		Revision as of 14:00, 20 December 2024
Line 28:		Line 28:

	=== What architectures does Alpine Linux support? ===		=== What architectures does Alpine Linux support? ===
	~~[[Architecture#Architectures_supported\|Architecture]] page~~ lists the architectures that are officially supported. Please check [https://alpinelinux.org/downloads ~~Download~~] page for media availability on each one.		The table below lists the architectures that are officially supported.
			{{:Include:Architecture support matrix}}
			Please check [https://alpinelinux.org/downloads Downloads] page for media availability on each one.
	<!--		<!--
	Note: Please update the above link for Architecture information . The below content to be removed later, if this redirection is acceptable to all		Note: Please update the above link for Architecture information . The below content to be removed later, if this redirection is acceptable to all