.\" -*- mode: troff; coding: utf-8 -*-
.TH "nix3-store-ping" "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 store ping\fR - test whether a store can be accessed
.SH
Synopsis
.LP
\fCnix store ping\fR [\fIoption\fR\[u2026]] 
.SH
Examples
.IP "\(bu" 3
Test whether connecting to a remote Nix store via SSH works:
.LP
.EX
# nix store info --store ssh://mac1
.EE
.IP "\(bu" 3
Test whether a URL is a valid binary cache:
.LP
.EX
# nix store info --store https://cache.nixos.org
.EE
.IP "\(bu" 3
Test whether the Nix daemon is up and running:
.LP
.EX
# nix store info --store daemon
.EE
.SH
Description
.LP
This command tests whether a particular Nix store (specified by the
argument \fC--store\fR \fIurl\fR) can be accessed. What this means is
dependent on the type of the store. For instance, for an SSH store it
means that Nix can connect to the specified machine.
.PP
If the command succeeds, Nix returns a exit code of 0 and does not
print any output.
.SH
Options
.IP "\(bu" 3
\fB\fC--json\fR\fR
.IP
Produce output in JSON format, suitable for consumption by another program.
.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