summaryrefslogtreecommitdiff
path: root/manpages
diff options
context:
space:
mode:
authorLyndon Brown <jnqnfe@gmail.com>2020-03-30 07:57:33 +0100
committerLyndon Brown <jnqnfe@gmail.com>2020-04-23 11:52:13 +0100
commit4dc91c4007b29ee5f9859ae7468b8fff98251aaf (patch)
treec510e9a15cb354ddf360000385ab19a2b4fcc7af /manpages
parent6b734df9f32914049b9a6e2291bda5c5b133b4bb (diff)
downloadvyos-live-build-4dc91c4007b29ee5f9859ae7468b8fff98251aaf.tar.gz
vyos-live-build-4dc91c4007b29ee5f9859ae7468b8fff98251aaf.zip
manpages: remove unhelpful and largely obsolete fixme notices
Diffstat (limited to 'manpages')
-rw-r--r--manpages/en/lb.12
-rw-r--r--manpages/en/lb_build.12
-rw-r--r--manpages/en/lb_clean.16
-rw-r--r--manpages/en/lb_config.16
-rw-r--r--manpages/en/live-build.716
5 files changed, 0 insertions, 32 deletions
diff --git a/manpages/en/lb.1 b/manpages/en/lb.1
index 900efc92a..c407cd17b 100644
--- a/manpages/en/lb.1
+++ b/manpages/en/lb.1
@@ -10,8 +10,6 @@
.SH DESCRIPTION
\fBlb\fR is a high\-level command (porcelain) of \fIlive\-build\fR(7), the Debian Live tool suite.
-.PP
-.\" FIXME
.SH OPTIONS
\fBlb\fR has no specific options but understands all generic live\-build options. See \fIlive\-build\fR(7) for a complete list of all generic live\-build options.
diff --git a/manpages/en/lb_build.1 b/manpages/en/lb_build.1
index ee806495f..ceb8c138e 100644
--- a/manpages/en/lb_build.1
+++ b/manpages/en/lb_build.1
@@ -15,9 +15,7 @@
\fBlb build\fR has no specific options but understands all generic live\-build options. See \fIlive\-build\fR(7) for a complete list of all generic live\-build options.
.SH FILES
-.\" FIXME
.IP "\fBauto/build\fR" 4
-.\" FIXME
.SH SEE ALSO
\fIlive\-build\fR(7)
diff --git a/manpages/en/lb_clean.1 b/manpages/en/lb_clean.1
index 73839f782..9bf1bc511 100644
--- a/manpages/en/lb_clean.1
+++ b/manpages/en/lb_clean.1
@@ -9,14 +9,11 @@
.SH DESCRIPTION
\fBlb clean\fR is a high\-level command (porcelain) of \fIlive\-build\fR(7), the Debian Live tool suite.
.PP
-.\" FIXME
\fBlb clean\fR is responsible for cleaning up after a system is built. It removes the build directories, and removes some other files including stage files, and any detritus left behind by other live\-build commands.
-.\" FIXME
.SH OPTIONS
In addition to its specific options \fBlb clean\fR understands all generic live\-build options. See \fIlive\-build\fR(7) for a complete list of all generic live\-build options.
.PP
-.\" FIXME
.IP "\fB\-\-all\fR" 4
removes chroot, binary, stage, and source. The cache directory is kept. This is the default operation and will be performed if no argument is given.
.IP "\fB\-\-cache\fR" 4
@@ -33,12 +30,9 @@ removes everything, including package cache but not stage cache. The config dire
removes all stage files.
.IP "\fB\-\-source\fR" 4
removes all source related caches, files, directories, and stage files.
-.\" FIXME
.SH FILES
-.\" FIXME
.IP "\fBauto/clean\fR" 4
-.\" FIXME
.SH SEE ALSO
\fIlive\-build\fR(7)
diff --git a/manpages/en/lb_config.1 b/manpages/en/lb_config.1
index 63e51fd7c..bb0174423 100644
--- a/manpages/en/lb_config.1
+++ b/manpages/en/lb_config.1
@@ -248,7 +248,6 @@ Note: \fBlb config\fR tries to be smart and sets defaults for some options depen
.SH OPTIONS
In addition to its specific options \fBlb config\fR understands all generic live\-build options. See \fIlive\-build\fR(7) for a complete list of all generic live\-build options.
.PP
-.\" FIXME
.IP "\fB\-\-apt\fR apt|aptitude" 4
defines if apt\-get or aptitude is used to install packages when building the image. The default is apt.
.IP "\fB\-\-apt\-ftp\-proxy\fR \fIURL\fR" 4
@@ -486,19 +485,14 @@ increases the verbosity of messages output by \fBlb build\fR.
defines if win32\-loader should be included in the binary image or not.
.IP "\fB\-\-zsync\fR true|false" 4
defines whether a file for distributing the image in \fIzsync\fR(1) format will be generated. Defaults to true.
-.\" FIXME
.SH ENVIRONMENT
-.\" FIXME
Currently, command line switches can also be specified through the corresponding environment variable. However, this generally should not be relied upon, as it is an implementation detail that is subject to change in future releases. For options applying directly to live\-build, environment variables are named LB_FOO, meaning, e.g. \fB\-\-apt\-ftp\-proxy\fR becomes LB_APT_FTP_PROXY (the exception being internal options such as \fB\-\-debug\fR). For options passed to another program, as in APT_OPTIONS or GZIP_OPTIONS, no LB_ prefix is used.
-\" FIXME
.SH FILES
-.\" FIXME
.IP "\fBauto/config\fR" 4
.IP "\fB/etc/live/build.conf, /etc/live/build/*\fR" 4
An optional, global configuration file for \fBlb config\fR variables. It is useful to specify a few system wide defaults, like LB_PARENT_MIRROR_BOOTSTRAP. This feature can be false by specifying the \fB\-\-ignore\-system\-defaults\fR option.
-.\" FIXME
.SH SEE ALSO
\fIlive\-build\fR(7)
diff --git a/manpages/en/live-build.7 b/manpages/en/live-build.7
index 236aeef84..87d149c89 100644
--- a/manpages/en/live-build.7
+++ b/manpages/en/live-build.7
@@ -9,16 +9,13 @@
\fBlb\fR \fICOMMAND\fR [\fIOPTIONS\fR]
.SH DESCRIPTION
-.\" FIXME
live\-build is a set of scripts to build live system images. The idea behind live\-build is a tool suite that uses a configuration directory to completely automate and customize all aspects of building a Live image.
.PP
The \fICOMMAND\fR is a name of a live\-build command (see below).
.PP
More documentation about how to use live\-build is available in the individual manpages for each helper and in the manual at <\fIhttps://live-team.pages.debian.net/live-manual/\fR>.
-.\" FIXME
.SH OPTIONS
-.\" FIXME
.SS Shared live\-build options
The following command line options are supported by all live\-build programs.
.IP "\fB-h, \-\-help\fR" 4
@@ -43,18 +40,14 @@ disable color use in messages.
be quiet.
.IP "\fB\-\-verbose\fR" 4
be verbose.
-.\" FIXME
.SH LIVE\-BUILD COMMANDS
-.\" FIXME
We divide live\-build into high level ("porcelain") commands, secondary major build stage ("porcelain") commands, and low level ("plumbing") commands.
.PP
Here is the complete list of all available live\-build commands. See their man
pages for additional documentation.
-.\" FIXME
.SH HIGH\-LEVEL COMMANDS (PORCELAIN)
-.\" FIXME
We separate the porcelain commands into the main commands and some ancillary user utilities.
.SS Main porcelain commands
.IP "\fBlb config\fR(1)" 4
@@ -66,10 +59,8 @@ cleans up system build directories
.SS Ancillary Commands
.IP "\fBlb\fR(1)" 4
generic live\-build script execution wrapper
-.\" FIXME
.SH SECONDARY\-LEVEL BUILD COMMANDS (PORCELAIN)
-.\" FIXME
The following are the commands that execute each major stage of the build process, in their necessary order of execution. Normally a user might just execute the higher level \fBlb build\fR(1) command rather than use these individually.
.IP "\fBlb bootstrap\fR(1)" 4
executes the first build stage, creating (bootstraping) a basic Debian root filesystem
@@ -81,10 +72,8 @@ executes the third build stage, obtaining installer components (optional)
executes the fourth build stage, generating the binary (live) image
.IP "\fBlb source\fR(1)" 4
executes the fifth build stage, generating a corresponding source image (optional)
-.\" FIXME
.SH LOW\-LEVEL COMMANDS (PLUMBING) - BUILD STAGE COMPONENTS
-.\" FIXME
The actual work of live\-build is implemented in the low-level commands, called plumbing. They are not supposed to be used by end users, who should stick with porcelains as they ensure that all the different plumbing commands are executed in the right order. However, if you intend to reuse live\-build commands in your own scripts, then the plumbings might be of interest for you.
.PP
Note that the interface (set of options and the semantics) to these low\-level commands are meant to be a lot more stable than Porcelain level commands. The interface to Porcelain commands on the other hand are subject to change in order to improve the end user experience.
@@ -187,10 +176,8 @@ compiles the final source image into an ISO file
copies live-build config into source
.IP "\fBlb source_tar\fR(1)" 4
compiles the final source image into a tar archive
-.\" FIXME
.SH LOW\-LEVEL COMMANDS (PLUMBING) - CHROOT PREP COMPONENTS
-.\" FIXME
The notes above under the section regarding build-stage specific low-level plumbing commands also apply here.
.PP
The following chroot_ prefixed commands are used throughout the various primary stages of the build process to apply and remove modifications to a chroot root filesystem. Generally these are used to apply modification that setup the chroot for use (execution of programs within it) during the build process, and later to remove those modification, unmounting things that were mounted, and making the chroot suitable for use as the root filesystem of the live OS to be bundled into the live image.
@@ -224,10 +211,8 @@ manages mounting of /sys
manages the /usr/sbin/policy\-rc.d file
.IP "\fBlb chroot_tmpfs\fR(1)" 4
manages configuration of dpkg to use a tmpfs filesystem
-.\" FIXME
.SH CONFIG FILES
-.\" FIXME
Many live\-build commands make use of files in the \fIconfig/\fR directory to control what they do. Besides the common \fIconfig/common\fR, which is used by all live\-build commands, some additional files can be used to configure the behavior of specific live\-build commands. These files are typically named config/stage or config/stage_helper (where "stage" of course, is replaced with the name of the stage that they belong to, and "helper" with the name of the helper).
.PP
For example, lb bootstrap_debootstrap uses files named config/bootstrap and config/bootstrap_debootstrap to read the options it will use. See the man pages of individual commands for details about the names and formats of the files they use. Generally, these files contain variables with values assigned, one variable per line. Some programs in live\-build use pairs of values or slightly more complicated variable assignments.
@@ -237,7 +222,6 @@ Note that live\-build will respect environment variables which are present in th
In some rare cases, you may want to have different versions of these files for different architectures or distributions. If files named config/stage.arch or config/stage_helper.arch, and config/stage.dist or config/stage_helper.dist exist, where "arch" is the same as the output of "dpkg \-\-print\-architecture" and "dist" is the same as the codename of the target distribution, then they will be used in preference to other, more general files.
.PP
All config files are shell scripts which are sourced by a live\-build program. That means they have to follow the normal shell syntax. You can also put comments in these files; lines beginning with "#" are ignored.
-.\" FIXME
.SH FILES
.IP "\fB/etc/live/build.conf\fR" 4