.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "osinfo-query 1"
.TH osinfo-query 1 2024-03-10 libosinfo-1.11.0 Libosinfo
.\" 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
osinfo\-query \- Query information in the database
.SH SYNOPSIS
.IX Header "SYNOPSIS"
osinfo-query [OPTIONS...] TYPE [CONDITION\-1 [CONDITION\-2 ...]]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`osinfo\-query\*(C'\fR command allows extraction of information from the
database. \fBTYPE\fR can be one of \f(CW\*(C`os\*(C'\fR, \f(CW\*(C`platform\*(C'\fR, \f(CW\*(C`device\*(C'\fR, or
\&\f(CW\*(C`deployment\*(C'\fR. With no conditions specified, all entities of the given
type will be listed.
.PP
.Vb 7
\&  # List all operating systems
\&  $ osinfo\-query os
\&   Short ID             | Name       ...
\&  \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-
\&   centos\-6.0           | CentOS 6.0 ...
\&   centos\-6.1           | CentOS 6.1 ...
\&   ...
.Ve
.PP
Conditions allow filtering based on specific properties of an entity.
For example, to filter only distros from the Fedora Project, use
.PP
.Vb 7
\&  # List all operating systems
\&  $ osinfo\-query os vendor="Fedora Project"
\&   Short ID             | Name          ...
\&  \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\&   fedora1              | Fedora Core 1 ...
\&   fedora2              | Fedora Core 2 ...
\&   ...
.Ve
.PP
The set of fields which are printed can be controlled using the \fB\-\-fields\fR
command line argument:
.PP
.Vb 7
\&  # List all operating systems
\&  $ osinfo\-query \-\-fields=short\-id,version os vendor="Fedora Project"
\&   Short ID             | Version
\&  \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-
\&   fedora1              | 1
\&   fedora2              | 2
\&   ...
.Ve
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-s PROPERTY\fR, \fB\-\-sort\-key PROPERTY\fR" 8
.IX Item "-s PROPERTY, --sort-key PROPERTY"
Set the data sorting key. Defaults sorting the first column
.IP "\fB\-f PROPERTY1,PROPERTY2,...\fR, \fB\-\-fields PROPERTY1,PROPERTY2,...\fR" 8
.IX Item "-f PROPERTY1,PROPERTY2,..., --fields PROPERTY1,PROPERTY2,..."
Set the visibility of properties in output
.SH "PROPERTY NAMES"
.IX Header "PROPERTY NAMES"
.SS OS
.IX Subsection "OS"
Valid property names for the \f(CW\*(C`os\*(C'\fR type are:
.IP \fBshort-id\fR 4
.IX Item "short-id"
The short OS identifier
.IP \fBname\fR 4
.IX Item "name"
The long OS name
.IP \fBversion\fR 4
.IX Item "version"
The OS version string
.IP \fBfamily\fR 4
.IX Item "family"
The OS kernel family
.IP \fBvendor\fR 4
.IX Item "vendor"
The OS vendor
.IP \fBrelease-date\fR 4
.IX Item "release-date"
The OS release date
.IP \fBeol-date\fR 4
.IX Item "eol-date"
The OS end-of-life date
.IP \fBcodename\fR 4
.IX Item "codename"
The OS code name
.IP \fBid\fR 4
.IX Item "id"
The OS identifier
.SS PLATFORM
.IX Subsection "PLATFORM"
Valid property names for the \f(CW\*(C`platform\*(C'\fR type are:
.IP \fBshort-id\fR 4
.IX Item "short-id"
The short platform identifier
.IP \fBname\fR 4
.IX Item "name"
The long platform name
.IP \fBversion\fR 4
.IX Item "version"
The platform version string
.IP \fBvendor\fR 4
.IX Item "vendor"
The platform vendor
.IP \fBrelease-date\fR 4
.IX Item "release-date"
The platform release date
.IP \fBeol-date\fR 4
.IX Item "eol-date"
The platform end-of-life date
.IP \fBcodename\fR 4
.IX Item "codename"
The platform code name
.IP \fBid\fR 4
.IX Item "id"
The platform identifier
.SS DEVICE
.IX Subsection "DEVICE"
Valid property names for the \f(CW\*(C`device\*(C'\fR type are:
.IP \fBname\fR 4
.IX Item "name"
The device name
.IP \fBproduct\fR 4
.IX Item "product"
The device product name
.IP \fBproduct-id\fR 4
.IX Item "product-id"
The device product ID string
.IP \fBvendor\fR 4
.IX Item "vendor"
The device vendor name
.IP \fBvendor-id\fR 4
.IX Item "vendor-id"
The device vendor ID string
.IP \fBclass\fR 4
.IX Item "class"
The device type class
.IP \fBbus\fR 4
.IX Item "bus"
The device bus type
.IP \fBid\fR 4
.IX Item "id"
The device identifier
.SS DEPLOYMENT
.IX Subsection "DEPLOYMENT"
Valid property names for the \f(CW\*(C`deployment\*(C'\fR type are:
.IP \fBid\fR 4
.IX Item "id"
The deployment identifier
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
The exit status will be 0 if matching entries were found,
or 1 if not matches were found
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBosinfo\-db\-validate\fR\|(1), \fBosinfo\-detect\fR\|(1)
.SH AUTHORS
.IX Header "AUTHORS"
Daniel P. Berrange <berrange@redhat.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2012, 2014 Red Hat, Inc.
.SH LICENSE
.IX Header "LICENSE"
\&\f(CW\*(C`osinfo\-query\*(C'\fR is distributed under the termsof the GNU LGPL v2+
license. This is free software; see the source for copying conditions.
There is NO warranty; not even for MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE