xut.1

.\" Generated by scdoc  1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "XUT" "1" "2025-12-10"
.PP
.SH NAME
.PP
\fBxut\fR - install software for void-linux using unofficial \fBx\fRtra \fBu\fRser \fBt\fRemplates.\&
.PP
.SH SYNOPSIS
.PP
\fBxut\fR [-lsd] [-h] [-u ]  [-b \fIpackages1,package2,.\&.\&.\&\fR | -i \fIpackages1,package2,.\&.\&.\&\fR] [-x <xbps-src command>] [-q <query>]
.PP
.SH DESCRIPTION
.PP
The xut utility used unofficial user-provided templates for xbps-src in git repos to provide
additional software for a void-linux installation.\&
.PP
.SH OPTIONS
.PP
\fB-s\fR
.RS 4
Sync the configured repositories.\&
.PP
.RE
\fB-l\fR
.RS 4
Enable logging to a file.\&
.PP
.RE
\fB-h\fR
.RS 4
Display usage information.\&
.PP
.RE
\fB-d\fR
.RS 4
Enable debugging and logging output.\&
.PP
.RE
\fB-b <package1,package2>\fR
.RS 4
Build a list of (comma-seperated) packages.\&
.PP
.RE
\fB-i <package1,package2>\fR
.RS 4
Build and install a list of (comma-seperated) packages.\&
.PP
.RE
\fB-x\fR
.RS 4
Executed xbps-src commands.\&
.PP
.RE
\fB-q\fR <query>
.RS 4
Search for <query> in available templates.\&
.PP
.RE
\fB-u\fR
.RS 4
Update packages.\&
.PP
.PP
.RE
.SS Notes for cli arguments
.RS 4
.PD 0
.IP \(bu 4
If \fB-x\fR is used, \fB-b\fR, \fB-i\fR and \fB-q\fR will be ignored.\&
.IP \(bu 4
\fB-b\fR and \fB-i\fR cannot be used in the same command.\&
.IP \(bu 4
\fB-l\fR and \fB-s\fR are meant to be used with some arguments (\fB-x\fR, \fB-b\fR, \fB-i\fR and \fB-u\fR).\&
.IP \(bu 4
\fB-l\fR enables "debug" messages in the output, which becomes more verbose.\&
.PD
.PP
.RE
.SH ENVIRONMENT
.PP
.RS 4
\fBNO_COLOR\fR is respected, as defined in https://no-color.\&org/
.PP
\fBCONF_WORKDIR\fR accepts a path to a directory and xut uses it as 
a working directory, overriding the configuration.\&
.PP
\fBXUT_TMPDIR\fR accepts a path to a directory that xut uses for temporary
files, overriding the default (/tmp).\&
.PP
.RE
.SH CONFIGURATION
.PP
.RS 4
\fBxut\fR has very limited configuration.\&
By default it clones and syncs the abyss-packages from codeberg and the void-packages repository
and uses the templates of the second one to build and install additional packages.\&
It can be used without any additional configuration, but it can be configured by a \fI$HOME/xutconf\fR or
\fI$XDG_CONFIG_HOME/xutconf\fR file.\& There could be also added another extra repository.\&
Please see the sample configuration in \fI/usr/share/doc/xutconf.\&sample\fR for more.\&
By default, \fBxut\fR uses the \fI$HOME/.\&xut\fR directory as a working directory.\&
It clones and sync repos there, keeps logs if the user enables that with the \fB-l\fR argument in the log/ subdirectory.\&
.PP
.PP
.RE
.SH EXAMPLES
.PP
.RS 4
.PD 0
.IP \(bu 4
Build packages (without installing them):
.RS 4
.PD
.RE
.RE
\fB'\&xut -b package1,package2'\&\fR
.RS 4
.PD 0
.IP \(bu 4
Sync repos and install packages:
.RS 4
.PD
.RE
.RE
\fB'\&xut -si package1,package2'\&\fR
.RS 4
.PD 0
.IP \(bu 4
Use the above command with logging enabled:
.RS 4
.PD
.RE
.RE
\fB'\&xut -sli package1,package2'\&\fR
.RS 4
.PD 0
.IP \(bu 4
Execute an xbps-command in the merged repo:
.RS 4
.PD
.RE
.RE
\fB'\&xut -x <command>'\&\fR
.RS 4
.PD 0
.IP \(bu 4
Update packages after syncing repos:
.RS 4
.PD
.RE
.RE
\fB'\&xut -su'\&\fR
.PP
.PP
.SH AUTHORS
.PP
Maintained by mobinmob <mobinmob@disroot.\&org>.\& Up-to-date sources can be found at
https://codeberg.\&org/mobinmob/xut and bugs/patches can be submitted there.\&