neulab/tldr huggingface dataset:
--sql-style=STYLE Write SQL statements in the given style instead of the default SQLite format.  Styles include Oracle and Named_Columns.
--sum-one For plain text reports, show the SUM: output line even if only one input file is processed.
--xml Write the results in XML.
--xsl[=FILE] Reference FILE as an XSL stylesheet within the XML output. If FILE is not given, writes a default stylesheet, cloc.xsl. This switch forces --xml to be on.
--yaml Write the results in YAML.
Count the lines of code in the Perl 5.10.0 compressed tar file on a UNIX- like operating system:
cloc perl-5.10.0.tar.gz
Count the changes in files, code, and comments between Python releases 2.6.6 and 2.7:
cloc --diff Python-2.6.6.tar.bz  Python-2.7.tar.bz2
To see how cloc aligns files for comparison between two code bases, use the --diff-alignment=FILE option.  Here the alignment information is written to "align.txt":
cloc --diff-aligment=align.txt gcc-4.4.0.tar.bz2  gcc-4.5.0.tar.bz2
Count file, code, and comment changes between two git commits:
cloc --git --diff b409850824 HEAD
Print the recognized languages:
cloc --show-lang
Remove comments from "foo.c" and save the result in "foo.c.nc" ("nc" is an arbitrary extension; used here to denote "no comments"):
cloc --strip-comments=nc foo.c
Additional examples can be found at <https://github.com/AlDanial/cloc>.
sloccount(1)
The cloc program was written by Al Danial <al.danial@gmail.com> and is Copyright (C) 2006-2019 <al.danial@gmail.com>.
The manual page was originally written by Jari Aalto <jari.aalto@cante.net>.
Both the code and documentation is released under the GNU GPL version 2 or (at your option) any later version. For more information about license, visit <http://www.gnu.org/copyleft/gpl.html>.
pdftocairo(1)                General Commands Manual               pdftocairo(1)
pdftocairo - Portable Document Format (PDF) to PNG/JPEG/TIFF/PDF/PS/EPS/SVG using cairo
pdftocairo [options] PDF-file [output-file]
pdftocairo converts Portable Document Format (PDF) files, using the cairo output device of the poppler PDF library, to any of the following output formats:
•      Portable Network Graphics (PNG)
•      JPEG Interchange Format (JPEG)
•      Tagged Image File Format (TIFF)
•      Portable Document Format (PDF)
•      PostScript (PS)
•      Encapsulated PostScript (EPS)
•      Scalable Vector Graphics (SVG)
•      Windows Printer
pdftocairo reads the PDF file, PDF-file, and writes to output-file.  The image formats (PNG, JPEG, and TIFF) generate one file per page with the page number and file type appended to output-file.  When -singlefile is used with the image formats, the file type is appended to output-file. When the output format is a vector format (PDF, PS, EPS, and SVG), output-file is the full filename.
If the PDF-file is “-” , the PDF is read from stdin.  If the output-file is “-” , the output file will be written to stdout. Using stdout is not valid with image formats unless -singlefile is used.  If output-file is not used, the output filename will be derived from the PDF-file filename.
Not all options are valid with all output formats. One (and only one) of the output format options (-png, -jpeg, -tiff, -pdf, -print, -ps, -eps, or -svg) must be used.
The resolution options (-r, -rx, -ry) set the resolution of the image output formats. The image dimensions will depend on the PDF page size and the resolution. For the vector outputs, regions of the page that can not be represented natively in the output format (eg translucency in PS) will be rasterized at the resolution specified by the resolution options.
The -scale-to options may be used to set a fixed image size. The image resolution will vary with the page size.
The cropping options (-x, -y, -W, and -H) use units of pixels with the image formats and PostScript points (1/72 inch) with the vector formats. When cropping is used with vector output the cropped region is centered unless -nocenter is used in which case the cropped region is at the top left (SVG) or bottom left (PDF, PS, EPS).
-png   Generates a PNG file(s)
-jpeg  Generates a JPEG file(s). See also -jpegopt.
-tiff  Generates a TIFF file(s)
-pdf   Generates a PDF file
-ps    Generate a PS file
-eps   Generate an EPS file. An EPS file contains a single image, so if you use this option with a multi-page PDF file, you must use -f and -l to specify a single page.  The page size options (-origpagesizes, -paper, -paperw, -paperh) can not be used with this option.
-svg   Generate a SVG (Scalable Vector Graphics) file
-print (Windows only) Prints to a system printer. See also -printer and -printeropt. If an output file is not specified, the output will be sent to the printer. The output file '-' can not be used with this option.
-printdlg (Windows only) Prints to a system printer. Displays the print dialog to allow the print options to be modified before printing.
-f number Specifies the first page to convert.
-l number Specifies the last page to convert.
-o     Generates only the odd numbered pages.
-e     Generates only the even numbered pages.
-singlefile Writes only the first page and does not add digits.
-r number Specifies the X and Y resolution, in pixels per inch of image files (or rasterized regions in vector output). The default is 150 PPI.
-rx number Specifies the X resolution, in pixels per inch of image files (or rasterized regions in vector output). The default is 150 PPI.
-ry number Specifies the Y resolution, in pixels per inch of image files (or rasterized regions in vector output). The default is 150 PPI.
-scale-to number Scales the long side of each page (width for landscape pages, height for portrait pages) to fit in scale-to pixels. The size of the short side will be determined by the aspect ratio of the page (PNG/JPEG/TIFF only).
-scale-to-x number Scales each page horizontally to fit in scale-to-x pixels. If scale-to-y is set to -1, the vertical size will determined by the aspect ratio of the page (PNG/JPEG/TIFF only).
-scale-to-y number Scales each page vertically to fit in scale-to-y pixels. If scale- to-x is set to -1, the horizontal size will determined by the aspect ratio of the page (PNG/JPEG/TIFF only).
-x number Specifies the x-coordinate of the crop area top left corner in pixels (image output) or points (vector output)
-y number Specifies the y-coordinate of the crop area top left corner in pixels (image output) or points (vector output)
-W number Specifies the width of crop area in pixels (image output) or points (vector output)  (default is 0)
-H number Specifies the height of crop area in pixels (image output) or points (vector output)  (default is 0)
-sz number Specifies the size of crop square in pixels (image output) or points (vector output)  (sets -W and -H)
-cropbox Uses the crop box rather than media box when generating the files (PNG/JPEG/TIFF only)
-mono  Generate a monochrome file (PNG and TIFF only).
-gray  Generate a grayscale file (PNG, JPEG, and TIFF only).
-antialias Set the cairo antialias option used for text and drawing in image files (or rasterized regions in vector output). The options are:
default Use the default antialiasing for the target device. This is the default setting if -antialias is not used.
none   Antialiasing is disabled.
gray   Perform single-color antialiasing using shades of gray.
subpixel Perform antialiasing by taking advantage of the order of subpixel elements on devices such as LCD.
fast   Hint that the backend should perform some antialiasing but prefer speed over quality.
good   The backend should balance quality against performance.
best   Hint that the backend should render at the highest quality, sacrificing speed if necessary.
-transp Use a transparent page color instead of white (PNG and TIFF only).
-icc icc-file Use the specified ICC file as the output profile (PNG only). The profile will be embedded in the PNG file.
-jpegopt jpeg-options When used with -jpeg, takes a list of options to control the jpeg compression. See JPEG OPTIONS for the available options.
-level2 Generate Level 2 PostScript (PS only).
-level3 Generate Level 3 PostScript (PS only). This enables all Level 2 features plus shading patterns and masked images. This is the default setting.
-origpagesizes This option is the same as "-paper match".
-paper size Set the paper size to one of "letter", "legal", "A4", or "A3" (PS,PDF,SVG only).  This can also be set to "match", which will set the paper size of each page to match the size specified in the PDF file. If none the -paper, -paperw, or -paperh options are specified the default is to match the paper size.
-paperw size Set the paper width, in points (PS,PDF,SVG only).
-paperh size Set the paper height, in points (PS,PDF,SVG only).
-nocrop By default, printing output is cropped to the CropBox specified in the PDF file.  This option disables cropping (PS,PDF,SVG only).
-expand Expand PDF pages smaller than the paper to fill the paper (PS,PDF,SVG only).  By default, these pages are not scaled.
-noshrink Don't scale PDF pages which are larger than the paper (PS,PDF,SVG only).  By default, pages larger than the paper are shrunk to fit.
-nocenter By default, PDF pages smaller than the paper (after any scaling) are centered on the paper.  This option causes them to be aligned to the lower-left corner of the paper instead (PS,PDF,SVG only).
-duplex Adds the %%IncludeFeature: *Duplex DuplexNoTumble DSC comment to the PostScript file (PS only).  This tells the print manager to enable duplexing.
-printer printer-name (Windows only). When used with -print, specifies the name of the printer to be used, instead of the system default.
-printopt printer-options (Windows only). When used with -print, takes a list of options to be used to configure the printer. See WINDOWS PRINTER OPTIONS for the available options.
-setupdlg (Windows only). When used with -print, the printer properties dialog is displayed allowing the print settings to be modified before printing. The paper size selected in the print properties dialog will be used except when -origpagesizes is specified.
-opw password Specify the owner password for the PDF file.  Providing this will bypass all security restrictions.
-upw password Specify the user password for the PDF file.
-q     Don't print any messages or errors.
The poppler tools use the following exit codes:
0      No error.
1      Error opening a PDF file.
2      Error opening an output file.
3      Error related to PDF permissions.
4      Error related to ICC profile.
99     Other error.
When JPEG output is specified, the -jpegopt option can be used to control the JPEG compression parameters.  It takes a string of the form "<opt>=<val>[,<opt>=<val>]". Currently the available options are:
quality Selects the JPEG quality value. The value must be an integer between 0 and 100.
progressive Select progressive JPEG output. The possible values are "y", "n", indicating progressive (yes) or non-progressive (no), respectively.
optimize Sets whether to compute optimal Huffman coding tables for the JPEG output, which will create smaller files but make an extra pass over the data. The value must be "y" or "n", with "y" performing optimization, otherwise the default Huffman tables are used.
In Windows, you can use the -print option to print directly to a system printer. Additionally, you can use the -printopt option to configure the printer. It takes a string of the form "<opt>=<val>[,<opt>=<val>]". Currently the available options are:
source Selects the source paper tray to be used (bin). The possible values are "upper", "onlyone", "lower", "middle", "manual", "envelope", "envmanual", "auto", "tractor", "smallfmt", "largefmt", "largecapacity", "formsource", or a numeric value to choose a driver specific source.
duplex Sets the duplex mode of the printer. The possible values are "off", "short" or "long", indicating no duplexing, short-edge binding, or long-edge binding, respectively.  General option -duplex is a synonym of "duplex=long". If both options are specified, -printopt has priority.
The pdftocairo software and documentation are copyright 1996-2004 Glyph & Cog, LLC and copyright 2005-2011 The Poppler Developers.
pdfdetach(1), pdffonts(1), pdfimages(1), pdfinfo(1), pdftohtml(1), pdftoppm(1), pdftops(1), pdftotext(1) pdfseparate(1), pdfsig(1), pdfunite(1)
VIRT-INSTALL(1)              Virtualization Support              VIRT-INSTALL(1)
virt-install - provision new virtual machines
virt-install [OPTION]...
virt-install is a command line tool for creating new KVM, Xen, or Linux container guests using the libvirt hypervisor management library.  See the EXAMPLES section at the end of this document to quickly get started.
virt-install tool supports graphical installations using (for example) VNC or SPICE, as well as text mode installs over serial console. The guest can be configured to use one or more virtual disks, network interfaces, audio devices, physical USB or PCI devices, among others.
The installation media can be local ISO or CDROM media, or a distro install tree hosted remotely over HTTP, FTP, or in a local directory. In the install tree case virt-install will fetch the minimal files necessary to kick off the installation process, allowing the guest to fetch the rest of the OS distribution as needed. PXE booting, and importing an existing disk image (thus skipping the install phase) are also supported.
Given suitable command line arguments, virt-install is capable of running completely unattended, with the guest 'kickstarting' itself too. This allows for easy automation of guest installs. This can be done manually, or more simply with the --unattended option.
Many arguments have sub options, specified like opt1=foo,opt2=bar, etc. Try --option=? to see a complete list of sub options associated with that argument, example: virt-install --disk=?
Most options are not required. If a suitable --os-variant value is specified or detected, all defaults will be filled in and reported in the terminal output. If an --os-variant is not specified. minimum required options, --memory, guest storage (--disk or --filesystem), and an install method choice.
--connect Syntax: --connect URI
Connect to a non-default hypervisor. If this isn't specified, libvirt will try and choose the most suitable default.
Some valid options here are:
qemu:///system For creating KVM and QEMU guests to be run by the system libvirtd instance.  This is the default mode that virt-manager uses, and what most KVM users want.
qemu:///session For creating KVM and QEMU guests for libvirtd running as the regular user.
xen:/// For connecting to Xen.
lxc:/// For creating linux containers
General configuration parameters that apply to all types of guest installs.
-n, --name Syntax: -n, --name NAME
Name of the new guest virtual machine instance. This must be unique amongst all guests known to the hypervisor on the connection, including those not currently active. To re-define an existing guest, use the virsh(1) tool to shut it down ('virsh shutdown') & delete ('virsh undefine') it prior to running virt-install.
--memory Syntax: --memory OPTIONS
Memory to allocate for the guest, in MiB. This deprecates the -r/--ram option.  Sub options are available, like 'memory', 'currentMemory', 'maxMemory' and 'maxMemory.slots', which all map to the identically named XML values.
Back compat values 'memory' maps to the <currentMemory> element, and maxmemory maps to the <memory> element.
To configure memory modules which can be hotunplugged see --memdev description.
Use --memory=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsMemoryAllocation
--memorybacking Syntax: --memorybacking OPTIONS
This option will influence how virtual memory pages are backed by host pages.
Use --memorybacking=? to see a list of all available sub options. Complete details at https://libvirt.org/formatdomain.html#elementsMemoryBacking
--arch Syntax: --arch ARCH
Request a non-native CPU architecture for the guest virtual machine.  If omitted, the host CPU architecture will be used in the guest.
--machine Syntax: --machine MACHINE
The machine type to emulate. This will typically not need to be specified for Xen or KVM, but is useful for choosing machine types of more exotic architectures.
--metadata Syntax: --metadata OPT=VAL,[...]
Specify metadata values for the guest. Possible options include name, uuid, title, and description. This option deprecates -u/--uuid and --description.
Use --metadata=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsMetadata
--events Syntax: --events OPT=VAL,[...]
Specify events values for the guest. Possible options include on_poweroff, on_reboot, and on_crash.
Use --events=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsEvents
--resource Syntax: --resource OPT=VAL,[...]
Specify resource partitioning for the guest.
Use --resource=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#resPartition
--sysinfo Syntax: --sysinfo OPT=VAL,[...]
Configure sysinfo/SMBIOS values exposed to the VM OS. Examples:
--sysinfo host Special type that exposes the host's SMBIOS info into the VM.
--sysinfo emulate Special type where hypervisor will generate SMBIOS info into the VM.
--sysinfo bios.vendor=custom or --sysinfo smbios,bios.vendor=custom The default type is smbios and allows users to specify SMBIOS info manually.
Use --sysinfo=? to see a list of all available sub options.
Complete details at https://libvirt.org/formatdomain.html#elementsSysinfo and https://libvirt.org/formatdomain.html#elementsOSBIOS for smbios XML element.
--xml Syntax: --xml ARGS
Make direct edits to the generated XML using XPath syntax. Take an example like
virt-install --xml ./@foo=bar --xml ./newelement/subelement=1
This will alter the generated XML to contain:
<domain foo='bar' ...> ... <newelement> <subelement>1</subelement> </newelement> </domain>
The --xml option has 4 sub options:
--xml xpath.set=XPATH[=VALUE] The default behavior if no explicit suboption is set. Takes the form XPATH=VALUE unless paired with xpath.value . See below for how value is interpreted.
--xml xpath.value=VALUE xpath.set will be interpreted only as the XPath string, and xpath.value will be used as the value to set. May help sidestep problems if the string you need to set contains a '=' equals sign.
If value is empty, it's treated as unsetting that particular node.
--xml xpath.create=XPATH Create the node as an empty element. Needed for boolean elements like <readonly/>
--xml xpath.delete=XPATH Delete the entire node specified by the xpath, and all its children
--qemu-commandline Syntax: --qemu-commandline ARGS
Pass options directly to the qemu emulator. Only works for the libvirt qemu driver. The option can take a string of arguments, for example:
--qemu-commandline="-display gtk,gl=on"
Environment variables are specified with 'env', for example:
--qemu-commandline=env=DISPLAY=:0.1
Complete details about the libvirt feature: https://libvirt.org/drvqemu.html#qemucommand
--vcpus Syntax: --vcpus OPTIONS
Number of virtual cpus to configure for the guest. If 'maxvcpus' is specified, the guest will be able to hotplug up to MAX vcpus while the guest is running, but will startup with VCPUS.
CPU topology can additionally be specified with sockets, cores, and threads.  If values are omitted, the rest will be autofilled preferring sockets over cores over threads.
'cpuset' sets which physical cpus the guest can use. CPUSET is a comma separated list of numbers, which can also be specified in ranges or cpus to exclude. Example:
0,2,3,5     : Use processors 0,2,3 and 5 1-5,^3,8    : Use processors 1,2,4,5 and 8
If the value 'auto' is passed, virt-install attempts to automatically determine an optimal cpu pinning using NUMA data, if available.
Use --vcpus=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsCPUAllocation
--numatune Syntax: --numatune OPTIONS
Tune NUMA policy for the domain process. Example invocations
--numatune 1,2,3,4-7 --numatune 1-3,5,memory.mode=preferred
Specifies the numa nodes to allocate memory from. This has the same syntax as --vcpus cpuset= option. mode can be one of 'interleave', 'preferred', or 'strict' (the default). See 'man 8 numactl' for information about each mode.
Use --numatune=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsNUMATuning
--memtune Syntax: --memtune OPTIONS
Tune memory policy for the domain process. Example invocations
--memtune 1000 --memtune hard_limit=100,soft_limit=60,swap_hard_limit=150,min_guarantee=80
Use --memtune=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsMemoryTuning
--blkiotune Syntax: --blkiotune OPTIONS
Tune blkio policy for the domain process. Example invocations
--blkiotune 100 --blkiotune weight=100,device.path=/dev/sdc,device.weight=200
Use --blkiotune=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsBlockTuning
--cpu Syntax: --cpu MODEL[,+feature][,-feature][,match=MATCH][,vendor=VENDOR],...
Configure the CPU model and CPU features exposed to the guest. The only required value is MODEL, which is a valid CPU model as known to libvirt.
Libvirt's feature policy values force, require, optional, disable, or forbid, or with the shorthand '+feature' and '-feature', which equal 'force=feature' and 'disable=feature' respectively.
If exact CPU model is specified virt-install will automatically copy CPU features available on the host to mitigate recent CPU speculative execution side channel and Microarchitectural Store Buffer Data security vulnerabilities.  This however will have some impact on performance and will break migration to hosts without security patches. In order to control this behavior there is a secure parameter. Possible values are on and off, with on as the default. It is highly recommended to leave this enabled and ensure all virtualization hosts have fully up to date microcode, kernel & virtualization software installed.
--cpu core2duo,+x2apic,disable=vmx Expose the core2duo CPU model, force enable x2apic, but do not expose vmx
--cpu host Expose the host CPUs configuration to the guest. This enables the guest to take advantage of many of the host CPUs features (better performance), but may cause issues if migrating the guest to a host without an identical CPU.
--cpu numa.cell0.memory=1234,numa.cell0.cpus=0-3,numa.cell1.memory=5678,numa.cell1.cpus=4-7 Example of specifying two NUMA cells. This will generate XML like:
<cpu> <numa> <cell cpus="0-3" memory="1234"/> <cell cpus="4-7" memory="5678"/> </numa> </cpu>
--cpu host-passthrough,cache.mode=passthrough Example of passing through the host cpu's cache information.
Use --cpu=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsCPU
--cputune Syntax: --cputune OPTIONS
Tune CPU parameters for the guest.
Configure which of the host's physical CPUs the domain VCPU will be pinned to.  Example invocation
--cputune vcpupin0.vcpu=0,vcpupin0.cpuset=0-3,vcpupin1.vcpu=1,vcpupin1.cpuset=4-7
Use --cputune=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsCPUTuning
--security, --seclabel Syntax: --security, --seclabel type=TYPE[,label=LABEL][,relabel=yes|no],...
Configure domain seclabel domain settings. Type can be either 'static' or 'dynamic'. 'static' configuration requires a security LABEL. Specifying LABEL without TYPE implies static configuration.
Use --security=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#seclabel
--keywrap Syntax: --keywrap OPTIONS
Specify domain <keywrap> XML, used for S390 cryptographic key management operations.
Use --keywrap=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#keywrap
--iothreads Syntax: --iothreads OPTIONS
Specify domain <iothreads> and/or <iothreadids> XML.  For example, to configure <iothreads>4</iothreads>, use --iothreads 4
Use --iothreads=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsIOThreadsAllocation
--features Syntax: --features FEAT=on|off,...
Set elements in the guests <features> XML on or off. Examples include acpi, apic, eoi, privnet, and hyperv features. Some examples:
--features apic.eoi=on Enable APIC PV EOI
--features hyperv.vapic.state=on,hyperv.spinlocks.state=off Enable hypver VAPIC, but disable spinlocks
--features kvm.hidden.state=on Allow the KVM hypervisor signature to be hidden from the guest
--features pvspinlock=on Notify the guest that the host supports paravirtual spinlocks for example by exposing the pvticketlocks mechanism.
--features gic.version=2 This is relevant only for ARM architectures. Possible values are "host" or version number.
--features smm.state=on This enables System Management Mode of hypervisor. Some UEFI firmwares may require this feature to be present. (QEMU supports SMM only with q35 machine type.)
Use --features=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsFeatures
--clock Syntax: --clock offset=OFFSET,TIMER_OPT=VAL,...
Configure the guest's <clock> XML. Some supported options:
--clock offset=OFFSET Set the clock offset, ex. 'utc' or 'localtime'
--clock TIMER_present=no Disable a boolean timer. TIMER here might be hpet, kvmclock, etc.
--clock TIMER_tickpolicy=VAL Set a timer's tickpolicy value. TIMER here might be rtc, pit, etc. VAL might be catchup, delay, etc. Refer to the libvirt docs for all values.
Use --clock=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsTime
--pm Syntax: --pm OPTIONS
Configure guest power management features. Example:
--pm suspend_to_memi.enabled=on,suspend_to_disk.enabled=off
Use --pm=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsPowerManagement
--launchSecurity Syntax: --launchSecurity TYPE[,OPTS]
Enable launch security for the guest, e.g. AMD SEV. Example invocations:
# This will use a default policy 0x03 # No dhCert provided, so no data can be exchanged with the SEV firmware --launchSecurity sev
# Explicit policy 0x01 - disables debugging, allows guest key sharing --launchSecurity sev,policy=0x01
# Provide the session blob obtained from the SEV firmware # Provide dhCert to open a secure communication channel with SEV firmware --launchSecurity sev,session=BASE64SESSIONSTRING,dhCert=BASE64DHCERTSTRING
SEV has further implications on usage of virtio devices, so refer to EXAMPLES section to see a full invocation of virt-install with --launchSecurity.
Use --launchSecurity=? to see a list of all available sub options. Complete details at https://libvirt.org/formatdomain.html#launchSecurity
-c, --cdrom Syntax: --cdrom PATH
ISO file or CDROM device to use for VM install media. After install, the the virtual CDROM device will remain attached to the VM, but with the ISO or host path media ejected.
-l, --location Syntax: -l, --location OPTIONS
Distribution tree installation source. virt-install can recognize certain distribution trees and fetches a bootable kernel/initrd pair to launch the install.
--location allows things like --extra-args for kernel arguments, and using --initrd-inject. If you want to use those options with CDROM media, you can pass the ISO to --location as well which works for some, but not all, CDROM media.
The LOCATION can take one of the following forms:
https://host/path An HTTP server location containing an installable distribution image.
ftp://host/path An FTP server location containing an installable distribution image.
ISO    Probe the ISO and extract files using 'isoinfo'
DIRECTORY Path to a local directory containing an installable distribution image.  Note that the directory will not be accessible by the guest after initial boot, so the OS installer will need another way to access the rest of the install media.
Some distro specific url samples:
Fedora/Red Hat Based https://download.fedoraproject.org/pub/fedora/linux/releases/29/Server/x86_64/os
Debian https://ftp.us.debian.org/debian/dists/stable/main/installer-amd64/
Ubuntu https://us.archive.ubuntu.com/ubuntu/dists/wily/main/installer-amd64/
Suse   https://download.opensuse.org/pub/opensuse/distribution/leap/42.3/repo/oss/
Additionally, --location can take 'kernel' and 'initrd' sub options. These paths relative to the specified location URL/ISO that allow selecting specific files for kernel/initrd within the install tree. This can be useful if virt-install/ libosinfo doesn't know where to find the kernel in the specified --location.
For example, if you have an ISO that libosinfo doesn't know about called my-unknown.iso, with a kernel at 'kernel/fookernel' and initrd at 'kernel/fooinitrd', you can make this work with:
--location my-unknown.iso,kernel=kernel/fookernel,initrd=kernel/fooinitrd
--pxe Install from PXE. This just tells the VM to boot off the network for the first boot.
--import Skip the OS installation process, and build a guest around an existing disk image. The device used for booting is the first device specified via --disk or --filesystem.
-x, --extra-args Syntax: -x, --extra-args KERNELARGS
Additional kernel command line arguments to pass to the installer when performing a guest install from --location. One common usage is specifying an anaconda kickstart file for automated installs, such as --extra-args "ks=https://myserver/my.ks"
--initrd-inject Syntax: --initrd-inject PATH
Add PATH to the root of the initrd fetched with --location. This can be used to run an automated install without requiring a network hosted kickstart file: --initrd-inject=/path/to/my.ks --extra-args "ks=file:/my.ks"
--install This is a larger entry point for various types of install operations. The command has multiple subarguments, similar to --disk and friends. This option is strictly for VM install operations, essentially configuring the first boot.
The simplest usage to ex: install fedora29 is:
--install fedora29
And virt-install will fetch a --location URL from libosinfo, and populate defaults from there.
Available suboptions:
os=    This is os install option described above. The explicit way to specify that would be --install os=fedora29 . os= is the default option if none is specified
kernel=, initrd= Specify a kernel and initrd pair to use as install media. They are copied into a temporary location before booting the VM, so they can be combined with --initrd-inject and your source media will not be altered. Media will be uploaded to a remote connection if required.
Example case using local filesystem paths: --install kernel=/path/to/kernel,initrd=/path/to/initrd
Example using network paths. Kernel/initrd will be downloaded locally first, then passed to the VM as local filesystem paths: --install kernel=https://127.0.0.1/tree/kernel,initrd=https://127.0.0.1/tree/initrd
Note, these are just for install time booting. If you want to set the kernel used for permanent VM booting, use the --boot option.
kernel_args=, kernel_args_overwrite=yes|no Specify install time kernel arguments (libvirt <cmdline> XML). These can be combine with ex: kernel/initrd options, or --location media. By default, kernel_args is just like --extra-args, and will _append_ to the arguments that virt-install will try to set by default for most --location installs. If you want to override the virt-install default, additionally specify kernel_args_overwrite=yes
bootdev= Specify the install bootdev (hd, cdrom, floppy, network) to boot off of for the install phase. This maps to libvirt <os><boot dev=X> XML.
If you want to install off a cdrom or network, it's probably simpler and more backwards compatible to just use --cdrom or --pxe , but this options gives fine grained control over the install process if needed.
no_install=yes|no Tell virt-install that there isn't actually any install happening, and you just want to create the VM. --import is just an alias for this, as is specifying --boot without any other install options. The deprecated --live option is the same as '--cdrom $ISO --install no_install=yes'
--reinstall DOMAIN Reinstall an existing VM. DOMAIN can be a VM name, UUID, or ID number. virt-install will fetch the domain XML from libvirt, apply the specified install config changes, boot the VM for the install process, and then revert to roughly the same starting XML.
Only install related options are processed, all other VM configuration options like --name, --disk, etc. are completely ignored.
If --reinstall is used with --cdrom, an existing CDROM attached to the VM will be used if one is available, otherwise a permanent CDROM device will be added.
--unattended Syntax: --unattended [OPTIONS]
Perform an unattended install using libosinfo's install script support. This is essentially a database of auto install scripts for various distros: Red Hat kickstarts, Debian installer scripting, Windows unattended installs, and potentially others. The simplest invocation is to combine it with --install like:
--install fedora29 --unattended
A Windows install will look like
--cdrom /path/to/my/windows.iso --unattended
Sub options are:
profile= Choose which libosinfo unattended profile to use. Most distros have a 'desktop' and a 'jeos' profile. virt-install will default to 'desktop' if this is unspecified.
admin-password-file= A file used to set the VM OS admin/root password from. This option can be used either as "admin-password-file=/path/to/password-file" or as "admin-password-file=/dev/fd/n", being n the file descriptor of the password-file.  Note that only the first line of the file will be considered, including any whitespace characters and excluding new-line.
user-login= The user login name to be used in th VM. virt-install will default to your current host username if this is unspecified.  Note that when running virt-install as "root", this option must be specified.
user-password-file= A file used to set the VM user password. This option can be used either as "user-password-file=/path/to/password-file" or as "user-password-file=/dev/fd/n", being n the file descriptor of the password-file. The username is either the user-login specified or your current host username.  Note that only the first line of the file will be considered, including any whitespace characters and excluding new-line.
product-key= Set a Windows product key
--cloud-init Pass cloud-init metadata to the VM. A cloud-init NoCloud ISO file is generated, and attached to the VM as a CDROM device. The device is only attached for the first boot. This option is particularly useful for distro cloud images, which have locked login accounts by default; --cloud-init provides the means to initialize those login accounts, like setting a root password.
The simplest invocation is just plain --cloud-init with no suboptions; this maps to --cloud-init root-password-generate=on,disable=on. See those suboptions for explanation of how they work.
Use --cloud-init=? to see a list of all available sub options.
root-password-generate=on Generate a new root password for the VM. When used, virt-install will print the generated password to the console, and pause for 10 seconds to give the user a chance to notice it and copy it.
disable=on Disable cloud-init in the VM for subsequent boots. Without this, cloud-init may reset auth on each boot.
root-password-file= A file used to set the VM root password from. This option can be used either as "root-password-file=/path/to/password-file" or as "root-password-file=/dev/fd/n", being n the file descriptor of the password-file.  Note that only the first line of the file will be considered, including any whitespace characters and excluding new-line.
meta-data= Specify a cloud-init meta-data file to add directly to the iso. All other meta-data configuration options on the --cloud-init command line are ignored.
user-data= Specify a cloud-init user-data file to add directly to the iso. All other user-data configuration options on the --cloud-init command line are ignored.
ssh-key= Specify a public key to inject into the guest, providing ssh access to the unprivileged account. Example: ssh-key=/home/user/.ssh/id_rsa.pub
--boot Syntax: --boot BOOTOPTS
Optionally specify the post-install VM boot configuration. This option allows specifying a boot device order, permanently booting off kernel/initrd with option kernel arguments, and enabling a BIOS boot menu (requires libvirt 0.8.3 or later)
--boot can be specified in addition to other install options (such as --location, --cdrom, etc.) or can be specified on its own. In the latter case, behavior is similar to the --import install option: there is no 'install' phase, the guest is just created and launched as specified.
--boot cdrom,fd,hd,network Set the boot device priority as first cdrom, first floppy, first harddisk, network PXE boot.
--boot kernel=KERNEL,initrd=INITRD,kernel_args="console=/dev/ttyS0" Have guest permanently boot off a local kernel/initrd pair, with the specified kernel options.
--boot kernel=KERNEL,initrd=INITRD,dtb=DTB Have guest permanently boot off a local kernel/initrd pair with an external device tree binary. DTB can be required for some non-x86 configurations like ARM or PPC
--boot loader=BIOSPATH Use BIOSPATH as the virtual machine BIOS.
--boot bootmenu.enable=on,bios.useserial=on Enable the bios boot menu, and enable sending bios text output over serial console.
--boot init=INITPATH Path to a binary that the container guest will init. If a root --filesystem has been specified, virt-install will default to /sbin/init, otherwise will default to /bin/sh.
--boot uefi Configure the VM to boot from UEFI. In order for virt-install to know the correct UEFI parameters, libvirt needs to be advertising known UEFI binaries via domcapabilities XML, so this will likely only work if using properly configured distro packages.
--boot loader=/.../OVMF_CODE.fd,loader.readonly=yes,loader.type=pflash,nvram.template=/.../OVMF_VARS.fd,loader_secure=no Specify that the virtual machine use the custom OVMF binary as boot firmware, mapped as a virtual flash chip. In addition, request that libvirt instantiate the VM-specific UEFI varstore from the custom "/.../OVMF_VARS.fd" varstore template. This is the recommended UEFI setup, and should be used if --boot uefi doesn't know about your UEFI binaries. If your UEFI firmware supports Secure boot feature you can enable it via loader_secure.
Use --boot=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsOS
--idmap Syntax: --idmap OPTIONS
If the guest configuration declares a UID or GID mapping, the 'user' namespace will be enabled to apply these.  A suitably configured UID/GID mapping is a pre-requisite to make containers secure, in the absence of sVirt confinement.
--idmap can be specified to enable user namespace for LXC containers. Example:
--idmap uid.start=0,uid.target=1000,uid.count=10,gid.start=0,gid.target=1000,gid.count=10
Use --idmap=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsOSContainer
--os-variant, --osinfo Syntax: --os-variant [OS_VARIANT|OPT1=VAL1,...]
Optimize the guest configuration for a specific operating system (ex. 'fedora29', 'rhel7', 'win10'). While not required, specifying this options is HIGHLY RECOMMENDED, as it can greatly increase performance by specifying virtio among other guest tweaks.
The simplest usage is --os-variant OS-NAME, for example --os-variant fedora32. --os-variant supports explicit suboption syntax as well:
name=, short-id= The OS name/short-id from libosinfo. Examples: fedora32, win10
id=    The full URL style libosinfo ID. For example, name=win10 is the same as id=http://microsoft.com/win/10
detect=on|off Whether virt-install should attempt OS detection from the specified install media. Detection is presently only attempted for URL and CDROM installs, and is not 100% reliable.
require=on|off If on, virt-install errors if no OS value is set or detected.
Some interesting examples:
--os-variant detect=on,require=on This tells virt-install to attempt detection from install media, but explicitly fail if that does not succeed. This will ensure your virt-install invocations don't fallback to a poorly performing config
--os-variant detect=on,name=OSNAME Attempt OS detection from install media, but if that fails, use OSNAME as a fallback.
By default, virt-install will do --os-variant detect=on,name=generic, using the detected OS if found, and falling back to the stub generic value otherwise, and printing a warning.
If any manual --os-variant value is specified, the default is all settings off or unset.
Use the command "osinfo-query os" to get the list of the accepted OS variant names.
--disk Syntax: --disk OPTIONS
Specifies media to use as storage for the guest, with various options. The general format of a disk string is
--disk opt1=val1,opt2=val2,...
The simplest invocation to create a new 10G disk image and associated disk device:
--disk size=10
virt-install will generate a path name, and place it in the default image location for the hypervisor. To specify media, the command can either be:
--disk /some/storage/path[,opt1=val1]...
or explicitly specify one of the following arguments:
path   A path to some storage media to use, existing or not. Existing media can be a file or block device.
Specifying a non-existent path implies attempting to create the new storage, and will require specifying a 'size' value. Even for remote hosts, virt-install will try to use libvirt storage APIs to automatically create the given path.
If the hypervisor supports it, path can also be a network URL, like https://example.com/some-disk.img . For network paths, they hypervisor will directly access the storage, nothing is downloaded locally.
pool   An existing libvirt storage pool name to create new storage on. Requires specifying a 'size' value.
vol    An existing libvirt storage volume to use. This is specified as 'poolname/volname'.
Options that apply to storage creation:
size   size (in GiB) to use if creating new storage
sparse whether to skip fully allocating newly created storage. Value is 'yes' or 'no'. Default is 'yes' (do not fully allocate) unless it isn't supported by the underlying storage type.
The initial time taken to fully-allocate the guest virtual disk (sparse=no) will be usually balanced by faster install times inside the guest. Thus use of this option is recommended to ensure consistently high performance and to avoid I/O errors in the guest should the host filesystem fill up.
format Disk image format. For file volumes, this can be 'raw', 'qcow2', 'vmdk', etc.  See format types in https://libvirt.org/storage.html for possible values.  This is often mapped to the driver_type value as well.
If not specified when creating file images, this will default to 'qcow2'.
If creating storage, this will be the format of the new image.  If using an existing image, this overrides libvirt's format auto-detection.
backing_store Path to a disk to use as the backing store for the newly created image.
backing_format Disk image format of backing_store
Some example device configuration suboptions:
device Disk device type. Example values are be 'cdrom', 'disk', 'lun' or 'floppy'.  The default is 'disk'.
boot.order Guest installation with multiple disks will need this parameter to boot correctly after being installed. A boot.order parameter will take values 1,2,3,...  Devices with lower value has higher priority.  This option applies to other bootable device types as well.
target.bus** or *bus Disk bus type. Example values are be 'ide', 'sata', 'scsi', 'usb', 'virtio' or 'xen'.  The default is hypervisor dependent since not all hypervisors support all bus types.
readonly Set drive as readonly (takes 'on' or 'off')
shareable Set drive as shareable (takes 'on' or 'off')
cache  The cache mode to be used. The host pagecache provides cache memory.  The cache value can be 'none', 'writethrough', 'directsync', 'unsafe' or 'writeback'.  'writethrough' provides read caching. 'writeback' provides read and write caching. 'directsync' bypasses the host page cache. 'unsafe' may cache all content and ignore flush requests from the guest.
driver.discard Whether discard (also known as "trim" or "unmap") requests are ignored or passed to the filesystem. The value can be either "unmap" (allow the discard request to be passed) or "ignore" (ignore the discard request). Since 1.0.6 (QEMU and KVM only)
driver.name Driver name the hypervisor should use when accessing the specified storage. Typically does not need to be set by the user.
driver.type Driver format/type the hypervisor should use when accessing the specified storage. Typically does not need to be set by the user.
driver.io Disk IO backend. Can be either "threads", "native" or "io_uring".
driver.error_policy How guest should react if a write error is encountered. Can be one of "stop", "ignore", or "enospace"
serial Serial number of the emulated disk device. This is used in linux guests to set /dev/disk/by-id symlinks. An example serial number might be: WD-WMAP9A966149
source.startupPolicy It defines what to do with the disk if the source file is not accessible.
snapshot Defines default behavior of the disk during disk snapshots.
See the examples section for some uses. This option deprecates -f/--file, -s/--file-size, --nonsparse, and --nodisks.
Use --disk=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsDisks
--filesystem Specifies a directory on the host to export to the guest. The most simple invocation is:
--filesystem /source/on/host,/target/point/in/guest
Which will work for recent QEMU and linux guest OS or LXC containers. For QEMU, the target point is just a mounting hint in sysfs, so will not be automatically mounted.
Some example suboptions:
type   The type or the source directory. Valid values are 'mount' (the default) or 'template' for OpenVZ templates.
accessmode or mode The access mode for the source directory from the guest OS. Only used with QEMU and type=mount. Valid modes are 'passthrough' (the default), 'mapped', or 'squash'. See libvirt domain XML documentation for more info.
source The directory on the host to share.
target The mount location to use in the guest.
Use --filesystem=? to see a list of all available sub options.  Complete details at https://libvirt.org/formatdomain.html#elementsFilesystems
-w, --network Syntax: -w, --network OPTIONS
Connect the guest to the host network. Examples for specifying the network type:
bridge=BRIDGE Connect to a bridge device in the host called BRIDGE. Use this option if the host has static networking config & the guest requires full outbound and inbound connectivity  to/from the LAN. Also use this if live migration will be used with this guest.
network=NAME Connect to a virtual network in the host called NAME. Virtual networks can be listed, created, deleted using the virsh command line tool. In an unmodified install of libvirt there is usually a virtual network with a name of default. Use a virtual network if the host has dynamic networking (eg NetworkManager), or using wireless. The guest will be NATed to the LAN by whichever connection is active.
type=direct,source=IFACE[,source.mode=MODE] Direct connect to host interface IFACE using macvtap.
user   Connect to the LAN using SLIRP. Only use this if running a QEMU guest as an unprivileged user. This provides a very limited form of NAT.
none   Tell virt-install not to add any default network interface.
If --network is omitted a single NIC will be created in the guest. If there is a bridge device in the host with a physical interface attached, that will be used for connectivity. Failing that, the virtual network called default will be used. This option can be specified multiple times to setup more than one NIC.
model.type or model Network device model as seen by the guest. Value can be any nic model supported by the hypervisor, e.g.: 'e1000', 'rtl8139', 'virtio', ...
mac.address or mac Fixed MAC address for the guest; If this parameter is omitted, or the value RANDOM is specified a suitable address will be randomly generated. For Xen virtual machines it is required that the first 3 pairs in the MAC address be the sequence '00:16:3e', while for QEMU or KVM virtual machines it must be '52:54:00'.