.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "BOXER 1p" .TH BOXER 1p "2019-04-29" "perl v5.28.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" boxer \- boxer command line utils .SH "VERSION" .IX Header "VERSION" Version v1.4.0 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& $ boxer compose parl\-greens \& Done: composed preseed.cfg and script.sh for a DebianParl system \& \& $ boxer bootstrap lxp5 \& Done: created rootfs for lxp5 node \& \& # TODO: below command are not yet implemented \& \& $ boxer install \& [...] \& Done: Installed "Debian GNU/Linux 10 (buster)" to /media/boxer \& \& $ boxer install \-\-arch armhf \-\-classes swedish kde webdesign \& [...] \& Done: Installed "Debian GNU/Linux 10 (buster)" to /media/boxer \& \& $ boxer detect \& Analyzing current system... \& Report and custom class saved below directory /tmp/boxer.wcJxHnql6f \& \& $ boxer refresh \-\-script ~/refresh.sh \& Shell script (to be executed by root) saved as ~/refresh.sh .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" boxer is a single front-end to various \*(L"boxing\*(R" tasks \- i.e. structured system-wide tasks commonly applied in batch to larger deployments. .PP Unlike tools like Puppet, CFEngine and Chef which operates on top of an installed system, boxer preferrably interacts with the packaging system of the system. Boxer is inspired by Fully Automated Installer (\s-1FAI\s0) and the classes are modelled after that tool, but goal of boxer is to become obsolete: boxer can include custom tweaks but encourages avoiding them and instead pass upstream to distro designers the needed customizations. .PP The core distribution includes commands to analyze, initialize and refresh a Debian(\-based) operating system. .PP However, boxer is pluggable and it is anticipated that plugins on \s-1CPAN\s0 will cover other related tasks. .SH "COMMANDS" .IX Header "COMMANDS" This section describes the commands included with the core Boxer::CLI distribution. Others are available as plugins. Run \f(CW\*(C`boxer commands\*(C'\fR to see a list of locally installed commands. .SS "Meta Commands" .IX Subsection "Meta Commands" \fI\f(CI\*(C`boxer about\*(C'\fI\fR .IX Subsection "boxer about" .PP Shows the version numbers of all installed boxer commands, plus the \s-1CPAN ID\s0 of each command's author. .PP \fI\f(CI\*(C`boxer aliases\*(C'\fI\fR .IX Subsection "boxer aliases" .PP Many commands have aliases or shortcuts. For example, the following two are equivalent: .PP .Vb 2 \& $ boxer install \-\-arch armhf \-\-classes swedish \& $ boxer deploy \-\-arch armhf \-\-classes swedish .Ve .PP \&\f(CW\*(C`boxer aliases\*(C'\fR shows a list of available aliases. .PP \fI\f(CI\*(C`boxer commands\*(C'\fI\fR .IX Subsection "boxer commands" .PP Shows a list of installed boxer commands, along with a brief extract. .PP \fI\f(CI\*(C`boxer help\*(C'\fI\fR .IX Subsection "boxer help" .PP Running the \f(CW\*(C`boxer help\*(C'\fR command on its own shows a list of commands with their abstracts. Detailed help for a particular command can be shown by providing that as an argument. For example, for help on the \&\f(CW\*(C`boxer detect\*(C'\fR command, run: .PP .Vb 1 \& $ boxer help detect .Ve .SS "System creation/manipulation" .IX Subsection "System creation/manipulation" \fI\f(CI\*(C`boxer install\*(C'\fI\fR .IX Subsection "boxer install" .PP \fI\f(CI\*(C`boxer update\*(C'\fI\fR .IX Subsection "boxer update" .SS "Class handling" .IX Subsection "Class handling" \fI\f(CI\*(C`boxer enable\*(C'\fI\fR .IX Subsection "boxer enable" .PP \fI\f(CI\*(C`boxer disable\*(C'\fI\fR .IX Subsection "boxer disable" .PP \fI\f(CI\*(C`boxer analyze\*(C'\fI\fR .IX Subsection "boxer analyze" .SS "Class exchange" .IX Subsection "Class exchange" \fI\f(CI\*(C`boxer pull\*(C'\fI\fR .IX Subsection "boxer pull" .PP \fI\f(CI\*(C`boxer push\*(C'\fI\fR .IX Subsection "boxer push" .PP \fI\f(CI\*(C`boxer publish\*(C'\fI\fR .IX Subsection "boxer publish" .SH "SEE ALSO" .IX Header "SEE ALSO" Find Boxer::CLI plugins on MetaCPAN: . .SH "AUTHOR" .IX Header "AUTHOR" Jonas Smedegaard \f(CW\*(C`\*(C'\fR. .SH "COPYRIGHT AND LICENCE" .IX Header "COPYRIGHT AND LICENCE" Copyright © 2013\-2016 Jonas Smedegaard .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. .SH "DISCLAIMER OF WARRANTIES" .IX Header "DISCLAIMER OF WARRANTIES" \&\s-1THIS PACKAGE IS PROVIDED \*(L"AS IS\*(R" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.\s0