.\" -*- mode: troff; coding: utf-8 -*-
.TH "nix3-nar" "1" ""
.RS
.PP
\fBWarning\fR 
.br
This program is
\fB\fBexperimental\fR\fR
and its interface is subject to change.
.RE
.SH
Name
.LP
\fCnix nar\fR - create or inspect NAR files
.SH
Synopsis
.LP
\fCnix nar\fR [\fIoption\fR\[u2026]] \fIsubcommand\fR
.PP
where \fIsubcommand\fR is one of the following:
.IP "\(bu" 3
\fB\fCnix nar cat\fR\fR - print the contents of a file inside a NAR file on stdout
.if n \
.sp -1
.if t \
.sp -0.25v
.IP "\(bu" 3
\fB\fCnix nar dump-path\fR\fR - serialise a path to stdout in NAR format
.if n \
.sp -1
.if t \
.sp -0.25v
.IP "\(bu" 3
\fB\fCnix nar ls\fR\fR - show information about a path inside a NAR file
.if n \
.sp -1
.if t \
.sp -0.25v
.IP "\(bu" 3
\fB\fCnix nar pack\fR\fR - serialise a path to stdout in NAR format
.SH
Description
.LP
\fCnix nar\fR provides several subcommands for creating and inspecting
\fINix Archives\fR (NARs).
.SH
File format
.LP
For the definition of the NAR file format, see Figure 5.2 in
\fIhttps://edolstra.github.io/pubs/phd-thesis.pdf\fR.
.SH
Options
.SS
Logging-related options
.IP "\(bu" 3
\fB\fC--debug\fR\fR
.IP
Set the logging verbosity level to \(oqdebug\(cq.
.IP "\(bu" 3
\fB\fC--log-format\fR\fR \fIformat\fR
.IP
Set the format of log output; one of \fCraw\fR, \fCinternal-json\fR, \fCbar\fR or \fCbar-with-logs\fR.
.IP "\(bu" 3
\fB\fC--print-build-logs\fR\fR / \fC-L\fR
.IP
Print full build logs on standard error.
.IP "\(bu" 3
\fB\fC--quiet\fR\fR
.IP
Decrease the logging verbosity level.
.IP "\(bu" 3
\fB\fC--verbose\fR\fR / \fC-v\fR
.IP
Increase the logging verbosity level.
.SS
Miscellaneous global options
.IP "\(bu" 3
\fB\fC--help\fR\fR
.IP
Show usage information.
.IP "\(bu" 3
\fB\fC--offline\fR\fR
.IP
Disable substituters and consider all previously downloaded files up-to-date.
.IP "\(bu" 3
\fB\fC--option\fR\fR \fIname\fR \fIvalue\fR
.IP
Set the Nix configuration setting \fIname\fR to \fIvalue\fR (overriding \fCnix.conf\fR).
.IP "\(bu" 3
\fB\fC--refresh\fR\fR
.IP
Consider all previously downloaded files out-of-date.
.IP "\(bu" 3
\fB\fC--version\fR\fR
.IP
Show version information.
.RS
.LP
\fBNote\fR
.PP
See \fB\fCman nix.conf\fR\fR for overriding configuration settings with command line flags.
.RE