Help:Reading: Difference between revisions

From Alpine Linux
m (reworded for clarity)
m (fixed wikilink)
 
(6 intermediate revisions by the same user not shown)
Line 3: Line 3:
== Root and normal user ==
== Root and normal user ==


The numeral or hash sign ({{ic|#}}) indicates that the command needs to be run as ''root'':  
When the hash sign ({{ic|#}}) is displayed before a command, it indicates that the command needs to be run with ''root'' privileges:  


  # apk add mandoc
  # apk add mandoc


The dollar sign ({{ic|$}}) shows that the command can be run as a ''regular user''.
When the dollar sign ({{ic|$}}) is displayed before a command, it indicates that the command should be run as a ''regular user''.


  $ apk info mandoc
  $ apk info mandoc


Refer [[Setting up a new user|User Accounts]] for more information on ''root'' and ''regular user''.
Refer [[Setting up a new user|User Accounts]] page for more information on ''root'' and ''regular user''.


== Packages and installation ==
== Placeholder ==  


Packages in the Alpine Linux [[Repositories]] are indicated as follows: {{pkg|libreoffice}}. If you click on the package name, details about the package can be found in the Alpine Linux [https://pkgs.alpinelinux.org package database]. Package filter available on the page can be used to search for further information.
Anything in ({{ic|< >}})  is likely just a placeholder that you need to replace. For example, {{ic|<editor> file.txt}} means use an '''editor''' of your choice like [[BusyBox#vi|vi]] or [[Emacs]] to open the file {{ic|file.txt}} for editing.


If you find an instruction to install the package {{pkg|less}}, then the following [[Alpine Package Keeper|apk]] command must be issued:
== Package installation ==


# apk add less
Packages in the Alpine Linux [[Repositories|official repositories ]] are indicated as follows: {{pkg|libreoffice}}. If you click on the package name in Wiki, Alpine Linux [https://pkgs.alpinelinux.org package database] page shows the details about the package and clicking on the package name lists additional information including the available [[Alpine_Package_Keeper#Subpackages|subpackages]]. Package filter available on the page can be used to search for further information .


Alpine Linux packages stay close to the upstream design and are thinned out and split into subpackages. So check and install necessary [[How_to_get_regular_stuff_working#Subpackages_and_missing_functionality|subpackages]].  
If you find an instruction to [[#Package installation|Install]] the package {{pkg|less}}, the following command must be issued:{{cmd|# apk add less}}
 
The [[Alpine Package Keeper#Add a Package|apk]] page provides additional information on package management in Alpine Linux.
 
== Manage services ==
 
Whenever an article instructs to '''start|stop|restart''' or '''enable|add|disable|remove''' some service <code>serviceName</code> without detailed instructions, refer [[OpenRC#Quickstart|OpenRC Quickstart]] for the actual command to run. For example, {{Codeline|Start <serviceName> now}} means issuing the command:{{Cmd|# rc-service <serviceName> start}}


[[Category:Wiki]]
[[Category:Wiki]]

Latest revision as of 04:39, 3 March 2025

Users of Alpine Linux wiki must understand the following conventions when reading the wiki pages.

Root and normal user

When the hash sign (#) is displayed before a command, it indicates that the command needs to be run with root privileges:

# apk add mandoc

When the dollar sign ($) is displayed before a command, it indicates that the command should be run as a regular user.

$ apk info mandoc

Refer User Accounts page for more information on root and regular user.

Placeholder

Anything in (< >) is likely just a placeholder that you need to replace. For example, <editor> file.txt means use an editor of your choice like vi or Emacs to open the file file.txt for editing.

Package installation

Packages in the Alpine Linux official repositories are indicated as follows: libreoffice. If you click on the package name in Wiki, Alpine Linux package database page shows the details about the package and clicking on the package name lists additional information including the available subpackages. Package filter available on the page can be used to search for further information .

If you find an instruction to Install the package less, the following command must be issued:

# apk add less

The apk page provides additional information on package management in Alpine Linux.

Manage services

Whenever an article instructs to start|stop|restart or enable|add|disable|remove some service serviceName without detailed instructions, refer OpenRC Quickstart for the actual command to run. For example, Start <serviceName> now means issuing the command:

# rc-service <serviceName> start