path: root/adelie-build-txz.8



.Dd September 10, 2018
.Dt ADELIE-BUILD-TXZ 8 SMM
.Os "Adélie Linux"
.Sh NAME
.Nm adelie-build-txz
.Nd create an Adélie Linux rootfs tarball suitable for extraction
.Sh SYNOPSIS
.Nm
.Op Fl a Ar ARCH
.Op Fl -mini
.Op Fl v Ar VERSION
.Op Fl -cache Ar CACHE
.Op Fl -no-cache
.Sh DESCRIPTION
.Nm
creates a rootfs tarball, similar to a Gentoo stage3 or Alpine miniroot, using
.Xr apk 8 ,
.Xr tar 1 ,
and
.Xr xz 1 .
.Bl -tag -width "-v VERSION" -offset indent -compact
.It Fl a Ar ARCH
You may specify any architecture available in the Adélie repository for
.Ar ARCH ;
however, some architectures may require you to have additional utilities
present on your system to be made bootable.  This defaults to the currently
running system's architecture as reported by
.Xr uname 1 .
.It Fl -mini
Specifies that a mini rootfs (no kernel or live media tools installed) is
desired.
.It Fl v Ar VERSION
Specifies the version of Adélie Linux to use for the created rootfs tarball.
.It Fl -cache Ar CACHE
Specifies the location of the cache directory to use, to speed up
.Xr apk 8
runs. Defaults to the system cache in
.Pa /etc/apk/cache
for the same architecture, or none. This directory must exist, or it is ignored.
.It Fl -no-cache
Do not use any cache directory for this
.Xr apk 8
run; pull all packages from the repository.
.El
.Sh ENVIRONMENT
.Bl -tag -width "EXTRA_MIRROR" -offset indent -compact
.It Ev Sy EXTRA_MIRROR
For architectures that have subarchitectures (such as x86 with i486 and i525),
you may specify the extra mirror directory to use as
.Ev EXTRA_MIRROR .
.It Ev Sy MY_URL
Use a custom URL for downloading.  This does not change the URLs written to
/etc/apk/repositories on the generated image.
.Pp
For instance, a speedy way to generate a testing ISO on a builder would be to
specify MY_URL=/srv/packages.
.El
.Sh FILES
.It Pa packages-$ARCH
A list of architecture-specific packages to install on the created media, in
addition to the default packages installed on every architecture.  This is
typically used for bootloaders and firmware manipulation packages.  It can also
be used to provide further debugging tools (such as
.Xr gdb 1
or
.Xr strace 1
and so on) on architectures that are still experimental.
.El
.Sh EXAMPLES
adelie-build-txz -a x86_64
.Sh SEE ALSO
.Xr apk 8 .
.Sh HISTORY
The
.Nm
command first appeared during the 1.0-BETA1 release.  It is written in portable
.St -p1003.2a-92
shell language.  Any deviation from the standard should be considered a bug.
.Sh AUTHOR
.An A. Wilcox
.Aq awilfox@adelielinux.org
.Sh BUGS
Hopefully few.
.Dd September 10, 2018
.Dt ADELIE-BUILD-TXZ 8 SMM
.Os "Adélie Linux"
.Sh NAME
.Nm adelie-build-txz
.Nd create an Adélie Linux rootfs tarball suitable for extraction
.Sh SYNOPSIS
.Nm
.Op Fl a Ar ARCH
.Op Fl -mini
.Op Fl v Ar VERSION
.Op Fl -cache Ar CACHE
.Op Fl -no-cache
.Sh DESCRIPTION
.Nm
creates a rootfs tarball, similar to a Gentoo stage3 or Alpine miniroot, using
.Xr apk 8 ,
.Xr tar 1 ,
and
.Xr xz 1 .
.Bl -tag -width "-v VERSION" -offset indent -compact
.It Fl a Ar ARCH
You may specify any architecture available in the Adélie repository for
.Ar ARCH ;
however, some architectures may require you to have additional utilities
present on your system to be made bootable.  This defaults to the currently
running system's architecture as reported by
.Xr uname 1 .
.It Fl -mini
Specifies that a mini rootfs (no kernel or live media tools installed) is
desired.
.It Fl v Ar VERSION
Specifies the version of Adélie Linux to use for the created rootfs tarball.
.It Fl -cache Ar CACHE
Specifies the location of the cache directory to use, to speed up
.Xr apk 8
runs. Defaults to the system cache in
.Pa /etc/apk/cache
for the same architecture, or none. This directory must exist, or it is ignored.
.It Fl -no-cache
Do not use any cache directory for this
.Xr apk 8
run; pull all packages from the repository.
.El
.Sh ENVIRONMENT
.Bl -tag -width "EXTRA_MIRROR" -offset indent -compact
.It Ev Sy EXTRA_MIRROR
For architectures that have subarchitectures (such as x86 with i486 and i525),
you may specify the extra mirror directory to use as
.Ev EXTRA_MIRROR .
.It Ev Sy MY_URL
Use a custom URL for downloading.  This does not change the URLs written to
/etc/apk/repositories on the generated image.
.Pp
For instance, a speedy way to generate a testing ISO on a builder would be to
specify MY_URL=/srv/packages.
.El
.Sh FILES
.It Pa packages-$ARCH
A list of architecture-specific packages to install on the created media, in
addition to the default packages installed on every architecture.  This is
typically used for bootloaders and firmware manipulation packages.  It can also
be used to provide further debugging tools (such as
.Xr gdb 1
or
.Xr strace 1
and so on) on architectures that are still experimental.
.El
.Sh EXAMPLES
adelie-build-txz -a x86_64
.Sh SEE ALSO
.Xr apk 8 .
.Sh HISTORY
The
.Nm
command first appeared during the 1.0-BETA1 release.  It is written in portable
.St -p1003.2a-92
shell language.  Any deviation from the standard should be considered a bug.
.Sh AUTHOR
.An A. Wilcox
.Aq awilfox@adelielinux.org
.Sh BUGS
Hopefully few.