napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Changes: update Calamares manpage

Browse Source 
- fix broken URL
 - add a little description
 - add newer command-line flags

FIXES #1516
This commit is contained in:
Adriaan de Groot 2020-09-29 16:41:57 +02:00
parent 584dec23d4
commit 9104853ed9
1 changed files with 57 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
man/calamares.8
View File

@ -1,18 +1,19 @@
.TH CALAMARES "8"
.SH NAME
calamares \- distribution-independent system installer
calamares \- distribution-independent system installer
.SH SYNOPSIS
.B calamares
[\fI\,options\/\fR]
.SH DESCRIPTION
.B calamares
is a distribution-independent system installer, with an advanced partitioning
feature for both manual and automated partitioning operations. It is the
first installer with an automated “Replace Partition” option, which makes it
easy to reuse a partition over and over for distribution testing. Calamares is
designed to be customizable by distribution maintainers without need for
cumbersome patching, thanks to third party branding and external modules
is a distribution-independent system installer, with an advanced partitioning
feature for both manual and automated partitioning operations. It is the
first installer with an automated “Replace Partition” option, which makes it
easy to reuse a partition over and over for distribution testing. Calamares is
designed to be customizable by distribution maintainers without need for
cumbersome patching, thanks to third party branding and external modules
support.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
@ -22,16 +23,63 @@ Displays this help.
Displays version information.
.TP
\fB\-d\fR, \fB\-\-debug\fR
Verbose output for debugging purposes.
Debugging mode for testing purposes. Implies \fB\-D8\fR and \fB\-c.\fR.
.TP
\fB\-D\fR <level>
Sets logging-level. Higher numbers are more verbose.
.TP
\fB\-c\fR, \fB\-\-config\fR <config>
Configuration directory to use, for testing purposes.
.TP
\fB\-X\fR, \fB\-\-xdg-config\fR
Use XDG environment variables for file lookup.
.TP
\fB\-T\fR, \fB\-\-debug-translation\fR
Use translations from current directory.
.SH "FILES"
.B calamares
reads its configuration from many files.
The first configuration file is
.BI settings.conf
which is located in one of the configuration locations.
When started with \fB\-d\fR
.B calamares
looks in the current directory for a settings file.
When started with \fB\-X\fR
.B calamares
looks in the directories specified by
.BI XDG_CONFIG_DIRS
for a settings file.
If no settings file is found elsewhere,
.B calamares
looks in pre-configured directories like
.BI /etc
\fB\fR.
The contents of the
.BI settings.conf
file dictate where other configuration files are located, and
which configuration files are used.
.SH "SEE ALSO"
The
.B calamares
website: https://calamares.io
\fB\fR.
The command-line arguments for
.B calamares
are primarily for developers convenience and should not be needed
in nearly any situation in which
.B calamares
is deployed. Most live CD environments and OEM installations should
have installed configuration files in their correct system-wide locations.
.SH "BUGS"
Please report any bugs to https://calamares.io/issues
Please report any bugs to https://github.com/calamares/calamares/issues
.SH AUTHORS
.B calamares
is written by Teo Mrnjavac <teo@kde.org>,