From 533901409e09797c5baab9d02f02e89e9970e5f1 Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Sun, 14 Jun 2015 12:37:49 +0100 Subject: [PATCH] pod: Use F<> for filenames instead of C<>. Done using a sequence of regular expressions like this: perl -pi.bak -e 's{C meaning the +The device and partition name (eg. F meaning the first partition on the first block device). When listing all libvirt domains (no I<-a> or I<-d> option given) this @@ -151,12 +151,12 @@ For example: virt-alignment-scan --format=raw -a disk.img -forces raw format (no auto-detection) for C. +forces raw format (no auto-detection) for F. virt-alignment-scan --format=raw -a disk.img --format -a another.img -forces raw format (no auto-detection) for C and reverts to -auto-detection for C. +forces raw format (no auto-detection) for F and reverts to +auto-detection for F. If you have untrusted raw-format guest disk images, you should use this option to specify the disk format. This avoids a possible diff --git a/appliance/libguestfs-make-fixed-appliance.pod b/appliance/libguestfs-make-fixed-appliance.pod index 3242afc37..9807f800f 100644 --- a/appliance/libguestfs-make-fixed-appliance.pod +++ b/appliance/libguestfs-make-fixed-appliance.pod @@ -112,7 +112,7 @@ Display the version number and exit. Instead of creating the appliance in an output directory, create a compressed tarball of the appliance in the current directory called -C.tar.xz> where C is the version of +F.tar.xz> where C is the version of libguestfs. Using I<--xz> can take some time. If working normally, the tool is @@ -132,8 +132,8 @@ into a full appliance by running C. However, a simpler "fixed appliance" can also be used. libguestfs detects this by looking for a directory on the path containing four -files called C, C, C and C (note -the C file must be present as well). +files called F, F, F and F (note +the F file must be present as well). If the fixed appliance is found, libguestfs skips supermin entirely and just runs qemu with the kernel, initrd and root disk from the diff --git a/builder/virt-builder.pod b/builder/virt-builder.pod index aa19ea2ad..41cda1aa2 100644 --- a/builder/virt-builder.pod +++ b/builder/virt-builder.pod @@ -77,7 +77,7 @@ The first time this runs it has to download the template over the network, but this gets cached (see L). The name of the output file is derived from the template name, so -above it will be C. You can change the output filename +above it will be F. You can change the output filename using the I<-o> option: virt-builder fedora-20 -o mydisk.img @@ -87,7 +87,7 @@ logical volumes. virt-builder fedora-20 --format qcow2 -As above, but write the output in qcow2 format to C. +As above, but write the output in qcow2 format to F. virt-builder fedora-20 --size 20G @@ -104,7 +104,7 @@ As above, but using an i386 template, if available. virt-builder fedora-20 --root-password file:/tmp/rootpw Create a Fedora 20 image. The root password is taken from the file -C. +F. Note if you I set I<--root-password> then the guest is given a I root password. @@ -168,7 +168,7 @@ Or: --edit '/etc/yum.conf: s/gpgcheck=1/gpgcheck=0/' -which edits C inside the disk image (during disk image +which edits F inside the disk image (during disk image creation, long before boot). You can combine these options, and have multiple options of all types. @@ -220,7 +220,7 @@ C is usually C or C. Use C for ISOs. I<--cache> DIR sets the directory to use/check for cached template files. If not set, defaults to either -C<$XDG_CACHE_HOME/virt-builder/> or C<$HOME/.cache/virt-builder/>. +F<$XDG_CACHE_HOME/virt-builder/> or F<$HOME/.cache/virt-builder/>. I<--no-cache> disables template caching. @@ -295,7 +295,7 @@ specify it by using the I<--format> option. In the case where the guest contains multiple kernels, the one with the highest version number is chosen. To extract arbitrary kernels from the disk image, see L. To extract the entire -C directory of a guest, see L. +F directory of a guest, see L. =item B<--gpg> GPG @@ -436,7 +436,7 @@ the install). =item B<--output> filename -Write the output to C. If you don't specify this option, +Write the output to F. If you don't specify this option, then the output filename is generated by taking the C string and adding C<.img> (for raw format) or C<.qcow2> (for qcow2 format). @@ -680,7 +680,7 @@ See L and L for more details. -=head3 Keyboard layout using C +=head3 Keyboard layout using F For RHEL E 6, Fedora E 18 and similar, upload or modify the keyboard configuration file using the I<--upload>, I<--write> or @@ -693,7 +693,7 @@ The format of this file can be found documented in many places online. =head3 Keyboard layout with Debian-derived distros -For Debian-derived distros using C, upload or +For Debian-derived distros using F, upload or modify the keyboard file using the I<--upload>, I<--write> or I<--edit> options. For example: @@ -757,17 +757,17 @@ logged in one of the following locations: =over 4 -=item C +=item F On Linux, BSD and other guests. -=item C +=item F On Windows, DOS guests. -=item C +=item F -If C or C is missing. +If F or F is missing. =back @@ -781,7 +781,7 @@ the guest, so they can login without supplying a password. The C part of the option value is optional; in this case, I<--ssh-inject> C means that we look in the I -user's C<~/.ssh> directory to find the default public ID file. That +user's F<~/.ssh> directory to find the default public ID file. That key is uploaded. "default public ID" is the I file described in L. @@ -791,7 +791,7 @@ If specified, the C can be in one of the following formats: =item B<--ssh-inject> USER:file:FILENAME -Read the ssh key from C. C is usually a I<.pub> +Read the ssh key from F. F is usually a I<.pub> file. =item B<--ssh-inject> USER:string:KEY_STRING @@ -801,8 +801,8 @@ string like I. =back -In any case, the C<~USER/.ssh> directory and the -C<~USER/.ssh/authorized_keys> file will be created if not existing +In any case, the F<~USER/.ssh> directory and the +F<~USER/.ssh/authorized_keys> file will be created if not existing already. =head2 FIRST BOOT SCRIPTS @@ -1013,7 +1013,7 @@ Run L on the disk image: virt-rescue -a disk.img This gives you a rescue shell. You can mount the filesystems from the -disk image on C and examine them using ordinary Linux +disk image on F and examine them using ordinary Linux commands. You can also chroot into the guest to reinstall the bootloader. The virt-rescue man page has a lot more information and examples. @@ -1061,12 +1061,12 @@ with the I<.conf> extension and located in the following paths: =item * $XDG_CONFIG_HOME/virt-builder/repos.d/ (C<$XDG_CONFIG_HOME> is -C<$HOME/.config> if not set). +F<$HOME/.config> if not set). =item * $XDG_CONFIG_DIRS/virt-builder/repos.d/ (where C<$XDG_CONFIG_DIRS> -means any of the directories in that environment variable, or just C +means any of the directories in that environment variable, or just F if not set) =back @@ -1218,7 +1218,7 @@ using the following command: gpg --clearsign --armor index -This will create the final file called C which can be +This will create the final file called F which can be uploaded to the server (and is the I URL). As noted above, signing the index file is optional, but recommended. @@ -1420,7 +1420,7 @@ A tool called L is available to validate the index file to ensure it is correct. Note that the parser and tool can work on either the signed or -unsigned index file (ie. C or C). +unsigned index file (ie. F or F). The index is always encoded in UTF-8. @@ -1431,8 +1431,8 @@ The index is always encoded in UTF-8. Since the templates are usually very large, downloaded templates are cached in the user's home directory. -The location of the cache is C<$XDG_CACHE_HOME/virt-builder/> or -C<$HOME/.cache/virt-builder>. +The location of the cache is F<$XDG_CACHE_HOME/virt-builder/> or +F<$HOME/.cache/virt-builder>. You can print out information about the cache directory, including which guests are currently cached, by doing: @@ -1494,7 +1494,7 @@ To install a Fedora guest using a local mirror: =head4 Using a local mirror with Debian Assuming that you are using C to mirror the repository, you -should create a new C file to point to your proxy (see +should create a new F file to point to your proxy (see L) and then do: virt-builder debian-7 \ @@ -1664,9 +1664,9 @@ SELinux labels correctly in the disk image. Sometimes fixfiles is not possible during installation, in which case this option falls back on: -=item Touching C +=item Touching F -Guest templates may already contain a file called C, or +Guest templates may already contain a file called F, or it is touched if I<--selinux-relabel> cannot run fixfiles. For guests that use SELinux, this causes fixfiles to run at first @@ -1727,13 +1727,13 @@ This can point to the directory containing data files used for Windows firstboot installation. Normally you do not need to set this. If not set, a compiled-in -default will be used (something like C). +default will be used (something like F). This directory may contain the following files: =over 4 -=item C +=item F This is the RHSrvAny Windows binary, used to install a "firstboot" script in Windows guests. It is required if you intend to use the diff --git a/builder/virt-index-validate.pod b/builder/virt-index-validate.pod index d48a93afa..7a033e304 100644 --- a/builder/virt-index-validate.pod +++ b/builder/virt-index-validate.pod @@ -13,7 +13,7 @@ that it knows how to use. This index file has a specific format which virt-index-validate knows how to validate. Note that virt-index-validate can validate either the signed or -unsigned index file (ie. either C or C). It can +unsigned index file (ie. either F or F). It can only validate a local file, not a URL. =head1 OPTIONS diff --git a/cat/virt-cat.pod b/cat/virt-cat.pod index da9bb9bdc..acd43e0c8 100644 --- a/cat/virt-cat.pod +++ b/cat/virt-cat.pod @@ -29,7 +29,7 @@ L tool (see L below). =head1 EXAMPLES -Display C file from inside the libvirt VM called +Display F file from inside the libvirt VM called C: virt-cat -d mydomain /etc/fstab @@ -110,12 +110,12 @@ For example: virt-cat --format=raw -a disk.img file -forces raw format (no auto-detection) for C. +forces raw format (no auto-detection) for F. virt-cat --format=raw -a disk.img --format -a another.img file -forces raw format (no auto-detection) for C and reverts to -auto-detection for C. +forces raw format (no auto-detection) for F and reverts to +auto-detection for F. If you have untrusted raw-format guest disk images, you should use this option to specify the disk format. This avoids a possible @@ -124,7 +124,7 @@ security problem with malicious guests (CVE-2010-3851). =item B<--keys-from-stdin> Read key or passphrase parameters from stdin. The default is -to try to read passphrases from the user by opening C. +to try to read passphrases from the user by opening F. =item B<-m dev[:mountpoint[:options[:fstype]]]> @@ -132,7 +132,7 @@ to try to read passphrases from the user by opening C. Mount the named partition or logical volume on the given mountpoint. -If the mountpoint is omitted, it defaults to C. +If the mountpoint is omitted, it defaults to F. Specifying any mountpoint disables the inspection of the guest and the mount of its root and all of its mountpoints, so make sure @@ -205,7 +205,7 @@ journal. =head1 WINDOWS PATHS C has a limited ability to understand Windows drive letters -and paths (eg. C). +and paths (eg. F). If and only if the guest is running Windows then: @@ -262,7 +262,7 @@ file from a disk image directly, use: guestfish --ro -a disk.img -m /dev/sda1 download file - -where C is the disk image, C is the filesystem +where F is the disk image, F is the filesystem within the disk image, and C is the full path to the file. =head1 EXIT STATUS diff --git a/cat/virt-filesystems.pod b/cat/virt-filesystems.pod index 00f15dc4e..fd8e18dc2 100644 --- a/cat/virt-filesystems.pod +++ b/cat/virt-filesystems.pod @@ -64,7 +64,7 @@ I<--physical-volumes>, I<--block-devices> to list those items. You can use these options in combination as well (if you want a combination including filesystems, you have to add I<--filesystems>). -Notice that some items fall into several categories (eg. C +Notice that some items fall into several categories (eg. F might be both a partition and a filesystem). These items are listed several times. To get a list which includes absolutely everything that virt-filesystems knows about, use the I<--all> option. @@ -184,12 +184,12 @@ For example: virt-filesystems --format=raw -a disk.img -forces raw format (no auto-detection) for C. +forces raw format (no auto-detection) for F. virt-filesystems --format=raw -a disk.img --format -a another.img -forces raw format (no auto-detection) for C and reverts to -auto-detection for C. +forces raw format (no auto-detection) for F and reverts to +auto-detection for F. If you have untrusted raw-format guest disk images, you should use this option to specify the disk format. This avoids a possible @@ -204,7 +204,7 @@ In I<--long> mode, display sizes in human-readable format. =item B<--keys-from-stdin> Read key or passphrase parameters from stdin. The default is -to try to read passphrases from the user by opening C. +to try to read passphrases from the user by opening F. =item B<-l> @@ -300,7 +300,7 @@ in future versions of this tool. The filesystem, partition, block device or LVM name. For device and partition names these are displayed as canonical -libguestfs names, so that for example C is the second +libguestfs names, so that for example F is the second partition on the first device. If the I<--long> option is B specified, then only the name column diff --git a/cat/virt-log.pod b/cat/virt-log.pod index c258cdcae..096fcf3c5 100644 --- a/cat/virt-log.pod +++ b/cat/virt-log.pod @@ -14,7 +14,7 @@ C is a command line tool to display the log files from the named virtual machine (or disk image). This tool understands and displays both plain text log files -(eg. C) and binary formats such as the systemd +(eg. F) and binary formats such as the systemd journal. To display other types of files, use L. To copy files @@ -93,12 +93,12 @@ For example: virt-log --format=raw -a disk.img -forces raw format (no auto-detection) for C. +forces raw format (no auto-detection) for F. virt-log --format=raw -a disk.img --format -a another.img -forces raw format (no auto-detection) for C and reverts to -auto-detection for C. +forces raw format (no auto-detection) for F and reverts to +auto-detection for F. If you have untrusted raw-format guest disk images, you should use this option to specify the disk format. This avoids a possible @@ -107,7 +107,7 @@ security problem with malicious guests (CVE-2010-3851). =item B<--keys-from-stdin> Read key or passphrase parameters from stdin. The default is -to try to read passphrases from the user by opening C. +to try to read passphrases from the user by opening F. =item B<-v> diff --git a/cat/virt-ls.pod b/cat/virt-ls.pod index aa7919dab..e9a226dbe 100644 --- a/cat/virt-ls.pod +++ b/cat/virt-ls.pod @@ -332,12 +332,12 @@ For example: virt-ls --format=raw -a disk.img /dir -forces raw format (no auto-detection) for C. +forces raw format (no auto-detection) for F. virt-ls --format=raw -a disk.img --format -a another.img /dir -forces raw format (no auto-detection) for C and reverts to -auto-detection for C. +forces raw format (no auto-detection) for F and reverts to +auto-detection for F. If you have untrusted raw-format guest disk images, you should use this option to specify the disk format. This avoids a possible @@ -355,7 +355,7 @@ L above. =item B<--keys-from-stdin> Read key or passphrase parameters from stdin. The default is -to try to read passphrases from the user by opening C. +to try to read passphrases from the user by opening F. =item B<-m dev[:mountpoint[:options[:fstype]]]> @@ -363,7 +363,7 @@ to try to read passphrases from the user by opening C. Mount the named partition or logical volume on the given mountpoint. -If the mountpoint is omitted, it defaults to C. +If the mountpoint is omitted, it defaults to F. Specifying any mountpoint disables the inspection of the guest and the mount of its root and all of its mountpoints, so make sure diff --git a/customize/virt-customize.pod b/customize/virt-customize.pod index dc64bf9b3..838e40ce3 100644 --- a/customize/virt-customize.pod +++ b/customize/virt-customize.pod @@ -106,12 +106,12 @@ For example: virt-customize --format raw -a disk.img -forces raw format (no auto-detection) for C. +forces raw format (no auto-detection) for F. virt-customize --format raw -a disk.img --format auto -a another.img -forces raw format (no auto-detection) for C and reverts to -auto-detection for C. +forces raw format (no auto-detection) for F and reverts to +auto-detection for F. If you have untrusted raw-format guest disk images, you should use this option to specify the disk format. This avoids a possible @@ -231,13 +231,13 @@ This can point to the directory containing data files used for Windows firstboot installation. Normally you do not need to set this. If not set, a compiled-in -default will be used (something like C). +default will be used (something like F). This directory may contain the following files: =over 4 -=item C +=item F This is the RHSrvAny Windows binary, used to install a "firstboot" script in Windows guests. It is required if you intend to use the diff --git a/daemon/guestfsd.pod b/daemon/guestfsd.pod index 0f9c8b090..1ed31a9b0 100644 --- a/daemon/guestfsd.pod +++ b/daemon/guestfsd.pod @@ -17,13 +17,13 @@ does in both the libguestfs appliance and when using libguestfs live. For the architecture of the libguestfs appliance, see L. -After the appliance boots, the C script in the appliance starts +After the appliance boots, the F script in the appliance starts C with no arguments. C opens the virtio-serial port on a known path (see L). It initiates the protocol (see L) and processes requests one at a time from the library until the appliance is destroyed. -Filesystems are mounted under C and all filesystem +Filesystems are mounted under F and all filesystem operations happen relative to this directory. =head2 LIBGUESTFS LIVE @@ -32,7 +32,7 @@ In the libguestfs live case, C is started from the rc-scripts, systemd, etc. The C<-r> option causes the daemon to operate on the root filesystem -instead of C. +instead of F. Currently (because of limitations in virtio-serial) only one client can connect at a time, and C must be restarted after each @@ -52,8 +52,8 @@ Display brief help. =item B<-r> -Set the root filesystem to be C (instead of the default which is -C). Also do not unmount filesystems when the daemon exits. +Set the root filesystem to be F (instead of the default which is +F). Also do not unmount filesystems when the daemon exits. This option is used to enable libguestfs live. @@ -77,11 +77,11 @@ error. =over 4 -=item C +=item F The virtio serial port which C connects to. -=item C +=item F The Linux command line is parsed to discover C flags. The following flags are understood: @@ -99,7 +99,7 @@ information. =item B Set the path to the virtio-serial channel to something other than the -default (which is C). +default (which is F). This is used by the User-Mode Linux backend to use a regular emulated serial port instead of virtio-serial. diff --git a/df/virt-df.pod b/df/virt-df.pod index 331f6fc3a..3f7fc3f42 100644 --- a/df/virt-df.pod +++ b/df/virt-df.pod @@ -52,7 +52,7 @@ output human-readable: F14x64:/dev/sda1 484M 66M 393M 14% F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46% -Show disk usage for a disk image file called C: +Show disk usage for a disk image file called F: $ virt-df -a test1.img Filesystem 1K-blocks Used Available Use% @@ -129,12 +129,12 @@ For example: virt-df --format=raw -a disk.img -forces raw format (no auto-detection) for C. +forces raw format (no auto-detection) for F. virt-df --format=raw -a disk.img --format -a another.img -forces raw format (no auto-detection) for C and reverts to -auto-detection for C. +forces raw format (no auto-detection) for F and reverts to +auto-detection for F. If you have untrusted raw-format guest disk images, you should use this option to specify the disk format. This avoids a possible @@ -212,7 +212,7 @@ Run this command: guestfish --ro -d GuestName -i statvfs / -(change C to see stats for other filesystems). +(change F to see stats for other filesystems). =item From inside the guest @@ -220,7 +220,7 @@ Run this command: python -c 'import os; s = os.statvfs ("/"); print s' -(change C to see stats for other filesystems). +(change F to see stats for other filesystems). =back diff --git a/diff/virt-diff.pod b/diff/virt-diff.pod index 22e0aa06e..afab185be 100644 --- a/diff/virt-diff.pod +++ b/diff/virt-diff.pod @@ -149,12 +149,12 @@ For example: virt-diff --format=raw -a disk.img [...] -forces raw format (no auto-detection) for C. +forces raw format (no auto-detection) for F. virt-diff --format=raw -a disk.img --format -a another.img [...] -forces raw format (no auto-detection) for C and reverts to -auto-detection for C. +forces raw format (no auto-detection) for F and reverts to +auto-detection for F. If you have untrusted raw-format guest disk images, you should use this option to specify the disk format. This avoids a possible @@ -169,7 +169,7 @@ Display file sizes in human-readable format. =item B<--keys-from-stdin> Read key or passphrase parameters from stdin. The default is -to try to read passphrases from the user by opening C. +to try to read passphrases from the user by opening F. =item B<--times> diff --git a/edit/virt-edit.pod b/edit/virt-edit.pod index 537fee0e6..57b914295 100644 --- a/edit/virt-edit.pod +++ b/edit/virt-edit.pod @@ -148,12 +148,12 @@ For example: virt-edit --format=raw -a disk.img file -forces raw format (no auto-detection) for C. +forces raw format (no auto-detection) for F. virt-edit --format=raw -a disk.img --format -a another.img file -forces raw format (no auto-detection) for C and reverts to -auto-detection for C. +forces raw format (no auto-detection) for F and reverts to +auto-detection for F. If you have untrusted raw-format guest disk images, you should use this option to specify the disk format. This avoids a possible @@ -162,7 +162,7 @@ security problem with malicious guests (CVE-2010-3851). =item B<--keys-from-stdin> Read key or passphrase parameters from stdin. The default is -to try to read passphrases from the user by opening C. +to try to read passphrases from the user by opening F. =item B<-m dev[:mountpoint[:options[:fstype]]]> @@ -170,7 +170,7 @@ to try to read passphrases from the user by opening C. Mount the named partition or logical volume on the given mountpoint. -If the mountpoint is omitted, it defaults to C. +If the mountpoint is omitted, it defaults to F. Specifying any mountpoint disables the inspection of the guest and the mount of its root and all of its mountpoints, so make sure @@ -299,7 +299,7 @@ file): =head1 WINDOWS PATHS C has a limited ability to understand Windows drive letters -and paths (eg. C). +and paths (eg. F). If and only if the guest is running Windows then: @@ -345,7 +345,7 @@ Using C is approximately equivalent to doing: guestfish --rw -i -d domname edit /file -where C is the name of the libvirt guest, and C is the +where C is the name of the libvirt guest, and F is the full path to the file. The command above uses libguestfs's guest inspection feature and so @@ -355,8 +355,8 @@ on a disk image directly, use: guestfish --rw -a disk.img -m /dev/sda1 edit /file -where C is the disk image, C is the filesystem -within the disk image to edit, and C is the full path to the +where F is the disk image, F is the filesystem +within the disk image to edit, and F is the full path to the file. C cannot create new files. Use the guestfish commands diff --git a/examples/guestfs-faq.pod b/examples/guestfs-faq.pod index 07743a3ae..8d52ab2ba 100644 --- a/examples/guestfs-faq.pod +++ b/examples/guestfs-faq.pod @@ -202,7 +202,7 @@ can access them. =item * -(Nasty) Edit C and change the C setting. +(Nasty) Edit F and change the C setting. =back @@ -223,15 +223,15 @@ appliance: [...followed by a lot of debug output...] This is a complicated bug related to L appliances. The -appliance is constructed by copying files like C and many +appliance is constructed by copying files like F and many libraries from the host. The file C lists the files that should be copied from the host into the appliance. If some files don't exist on the host then they are missed out, but if these files -are needed in order to (eg) run C then you'll see the above +are needed in order to (eg) run F then you'll see the above error. Diagnosing the problem involves studying the libraries needed by -C, ie: +F, ie: ldd /bin/bash @@ -240,7 +240,7 @@ the host filesystem, and with the debug output printed in the error message. Once you've worked out which file is missing, install that file using your package manager and try again. -You should also check that files like C and C (in +You should also check that files like F and F (in the appliance) are executable. The debug output shows file modes. =head1 DOWNLOADING, INSTALLING, COMPILING LIBGUESTFS @@ -468,7 +468,7 @@ There is one known shortcoming: L will not use libvirt currently get the benefit of sVirt protection when using virt-rescue. You can check if sVirt is being used by enabling libvirtd logging (see -C), killing and restarting libvirtd, and +F), killing and restarting libvirtd, and checking the log files for S<"Setting SELinux context on ..."> messages. In theory sVirt should support AppArmor, but we have not tried it. It @@ -604,7 +604,7 @@ libguestfs caches a large-ish appliance in: /var/tmp/.guestfs- If the environment variable C is defined, then -C<$TMPDIR/.guestfs-EUIDE> is used instead. +F<$TMPDIR/.guestfs-EUIDE> is used instead. It is safe to delete this directory when you are not using libguestfs. @@ -712,7 +712,7 @@ but in the meantime you have three options: =item 1. If the guest is hosted on a live, reachable ESX server, then locate -and download the disk image called IC<-flat.vmdk>. Despite +and download the disk image called F-flat.vmdk>. Despite the name, this is a raw disk image, and can be opened by anything. If you have a recent enough version of qemu and libguestfs, then you @@ -977,7 +977,7 @@ calling launch. Use the event API. For examples, see: L and the -C program in the libguestfs sources. +F program in the libguestfs sources. =head2 Digging deeper into the appliance boot process. @@ -993,17 +993,17 @@ of L. =head2 Debugging libvirt If you are using the libvirt backend, and libvirt is failing, then you -can enable debugging by editing C. +can enable debugging by editing F. If you are running as non-root, then you have to edit a different -file. Create C<~/.config/libvirt/libvirtd.conf> containing: +file. Create F<~/.config/libvirt/libvirtd.conf> containing: log_level=1 log_outputs="1:file:/tmp/libvirtd.log" Kill any session (non-root) libvirtd that is running, and next time you run the libguestfs command, you should see a large amount of -useful debugging information from libvirtd in C +useful debugging information from libvirtd in F =head1 DESIGN/INTERNALS OF LIBGUESTFS @@ -1113,7 +1113,7 @@ What you have to do is to create a point-in-time snapshot. If it's a logical volume, use an LVM2 snapshot. If the filesystem is located inside something like a btrfs/ZFS file, use a btrfs/ZFS snapshot, and then run the fsck on the snapshot. In practice you don't need to use -libguestfs for this -- just run C directly. +libguestfs for this -- just run F directly. Creating point-in-time snapshots of host devices and files is outside the scope of libguestfs, although libguestfs can operate on them once @@ -1196,7 +1196,7 @@ Users expect some tools (like L) to work with VM paths: virt-cat fedora.img /var/log/messages -How does virt-cat know that C is a separate partition? The +How does virt-cat know that F is a separate partition? The trick is that virt-cat performs inspection on the disk image, and uses that to translate the path correctly. diff --git a/examples/guestfs-performance.pod b/examples/guestfs-performance.pod index abddcc8d7..7cf10aaa2 100644 --- a/examples/guestfs-performance.pod +++ b/examples/guestfs-performance.pod @@ -34,7 +34,7 @@ runs, so that you are measuring a typical "hot cache" case. This command starts up the libguestfs appliance on a null disk, and then immediately shuts it down. The first time you run the command, it will create an appliance and cache it (usually under -C). Subsequent runs should reuse the cached +F). Subsequent runs should reuse the cached appliance. =head3 Expected results @@ -70,7 +70,7 @@ L), mounts the guest's disks, then discards all these results and shuts down. The first time you run the command, it will create an appliance and -cache it (usually under C). Subsequent runs +cache it (usually under F). Subsequent runs should reuse the cached appliance. =head3 Expected results @@ -83,7 +83,7 @@ seconds). =head1 UNDERSTANDING THE APPLIANCE AND WHEN IT IS BUILT/CACHED The first time you use libguestfs, it will build and cache an -appliance. This is usually in C, unless you have +appliance. This is usually in F, unless you have set C<$TMPDIR> or C<$LIBGUESTFS_CACHEDIR> in which case it will be under that temporary directory. @@ -115,7 +115,7 @@ host will cause a one time rebuild of the appliance. =item * -C (or C<$TMPDIR>, C<$LIBGUESTFS_CACHEDIR>) should be on a +F (or C<$TMPDIR>, C<$LIBGUESTFS_CACHEDIR>) should be on a fast disk, and have plenty of space for the appliance. =back @@ -131,8 +131,8 @@ To build the appliance, run the command: replacing CdirectoryE> with the name of a directory where the appliance will be stored (normally you would name a subdirectory, -for example: C or -C). +for example: F or +F). Then set C<$LIBGUESTFS_PATH> (and ensure this environment variable is set in your libguestfs program), or modify your program so it calls @@ -151,7 +151,7 @@ L). In our testing we did not find that using a fixed appliance gave any measurable performance benefit, even when the appliance was located in -memory (ie. on C). However there are two points to +memory (ie. on F). However there are two points to consider: =over 4 @@ -399,7 +399,7 @@ L and this page: +Use F and this page: http://virt-tools.org/learning/check-hardware-virt/ @@ -414,7 +414,7 @@ no substitute for running libguestfs on baremetal. =head2 ENSURE KVM IS AVAILABLE Ensure that KVM is enabled and available to the user that will run -libguestfs. It should be safe to set 0666 permissions on C +libguestfs. It should be safe to set 0666 permissions on F and most distributions now do this. =head2 PROCESSORS TO AVOID @@ -449,7 +449,7 @@ The timestamps are seconds (incrementally since the previous line). You can use SystemTap (L) to get detailed timings from libguestfs programs. -Save the following script as C: +Save the following script as F: global last; diff --git a/examples/guestfs-recipes.pod b/examples/guestfs-recipes.pod index 2b253e65c..2491c25d8 100644 --- a/examples/guestfs-recipes.pod +++ b/examples/guestfs-recipes.pod @@ -49,7 +49,7 @@ To checksum a whole device, or a partition, LV etc within a disk image: Replace C with the type of checksum you want. See L for a list of supported types. -C means "the first partition". You could use C +F means "the first partition". You could use F to checksum the whole disk image, or the name of a logical volume or RAID device. @@ -72,11 +72,11 @@ For more details, see: L. =head1 Convert a CD-ROM / DVD / ISO to a tarball -This converts input C to output C: +This converts input F to output F: guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz -To export just a subdirectory, eg. C, do: +To export just a subdirectory, eg. F, do: guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz @@ -251,7 +251,7 @@ like this: =head1 Export any directory from a VM -To export C from a VM into a local directory use +To export F from a VM into a local directory use L: virt-copy-out -d Guest /home . @@ -332,11 +332,11 @@ getting the last assigned DHCP address of a virtual machine. L In the libguestfs source examples directory you will find the latest -version of the C program. +version of the F program. =head1 Get the operating system product name string -Save the following script into a file called C: +Save the following script into a file called F: #!/bin/sh - set -e @@ -480,12 +480,12 @@ SYSLINUX bootloader using either the guestfish commands C (for FAT-based guests) or C (for ext2/3/4 and btrfs-based guests). -This guide assumes a Linux guest where C is C, -C is the guest kernel, and C is the root +This guide assumes a Linux guest where F is F, +F is the guest kernel, and F is the root partition. For a Windows guest you would need a FAT-formatted boot partition and you would need to use the C command instead. -Create a C configuration file. You should check the +Create a F configuration file. You should check the SYSLINUX documentation at L but it may look something like this: @@ -497,7 +497,7 @@ something like this: APPEND ro root=/dev/sda3 Locate the syslinux master boot record (a file called something like -C). +F). guestfish -a disk.img -i # Upload the master boot record and configuration file: @@ -515,7 +515,7 @@ L: +Save the following to a file F: #!/bin/sh - set -e diff --git a/examples/guestfs-testing.pod b/examples/guestfs-testing.pod index 2186ed3c1..25286041a 100644 --- a/examples/guestfs-testing.pod +++ b/examples/guestfs-testing.pod @@ -170,7 +170,7 @@ into a guest or disk image. virt-copy-in -d Guest /etc /tmp -This should copy local directory C to C in the guest +This should copy local directory F to F in the guest (recursively). If you boot the guest, can you see all of the copied files and directories? @@ -187,7 +187,7 @@ out of a guest or disk image. Note the final space and period in the command is not a typo. -This should copy C from the guest into the current directory. +This should copy F from the guest into the current directory. =head2 Run virt-df. @@ -349,7 +349,7 @@ Using L, make a disk image more sparse: virt-sparsify /path/to/olddisk.img newdisk.img -Is C still bootable after sparsifying? Is the resulting +Is F still bootable after sparsifying? Is the resulting disk image smaller (use C to check)? =head2 B<*> "sysprep" a B Linux guest. diff --git a/fish/guestfish.pod b/fish/guestfish.pod index 20c354422..8d6e0fa48 100644 --- a/fish/guestfish.pod +++ b/fish/guestfish.pod @@ -64,7 +64,7 @@ L command. =head2 From shell scripts -Create a new C file in a guest or disk image: +Create a new F file in a guest or disk image: guestfish <<_EOF_ add disk.img @@ -89,13 +89,13 @@ List all the filesystems in a disk image: =head2 On one command line -Update C in a guest: +Update F in a guest: guestfish \ add disk.img : run : mount /dev/vg_guest/lv_root / : \ write /etc/resolv.conf "nameserver 1.2.3.4" -Edit C interactively: +Edit F interactively: guestfish --rw --add disk.img \ --mount /dev/vg_guest/lv_root \ @@ -111,7 +111,7 @@ disks from a virtual machine: guestfish --ro -d libvirt-domain -i cat /etc/group -Another way to edit C interactively is: +Another way to edit F interactively is: guestfish --rw -a disk.img -i edit /boot/grub/grub.conf @@ -127,7 +127,7 @@ Create a 100MB disk containing an ext2-formatted partition: =head2 Start with a prepared disk -An alternate way to create a 100MB disk called C containing +An alternate way to create a 100MB disk called F containing a single ext2-formatted partition: guestfish -N fs @@ -244,12 +244,12 @@ For example: guestfish --format=raw -a disk.img -forces raw format (no auto-detection) for C. +forces raw format (no auto-detection) for F. guestfish --format=raw -a disk.img --format -a another.img -forces raw format (no auto-detection) for C and reverts to -auto-detection for C. +forces raw format (no auto-detection) for F and reverts to +auto-detection for F. If you have untrusted raw-format guest disk images, you should use this option to specify the disk format. This avoids a possible @@ -290,7 +290,7 @@ were found. =item B<--keys-from-stdin> Read key or passphrase parameters from stdin. The default is -to try to read passphrases from the user by opening C. +to try to read passphrases from the user by opening F. =item B<--listen> @@ -308,9 +308,9 @@ Connect to a live virtual machine. Mount the named partition or logical volume on the given mountpoint. -If the mountpoint is omitted, it defaults to C. +If the mountpoint is omitted, it defaults to F. -You have to mount something on C before most commands will work. +You have to mount something on F before most commands will work. If any I<-m> or I<--mount> options are given, the guest is automatically launched. @@ -736,7 +736,7 @@ following will not do what you expect: rm-rf /home/* -Assuming you don't have a directory called literally C +Assuming you don't have a directory called literally F then the above command will return an error. To perform wildcard expansion, use the C command. @@ -770,15 +770,15 @@ Blank lines are also ignored. =head1 RUNNING COMMANDS LOCALLY Any line which starts with a I character is treated as a command -sent to the local shell (C or whatever L uses). +sent to the local shell (F or whatever L uses). For example: !mkdir local tgz-out /remote local/remote-data.tar.gz will create a directory C on the host, and then export -the contents of C on the mounted filesystem to -C. (See C). +the contents of F on the mounted filesystem to +F. (See C). To change the local directory, use the C command. C will have no effect, due to the way that subprocesses work in Unix. @@ -793,13 +793,13 @@ Thus you can use shell script to construct arbitrary guestfish commands which are then parsed by guestfish. For example it is tedious to create a sequence of files -(eg. C through C) using guestfish commands +(eg. F through F) using guestfish commands alone. However this is simple if we use a shell script to create the guestfish commands for us: : +or with names like F: : crypto_LUKS Then open those devices using L. This creates a -device-mapper device called C. +device-mapper device called F. > luks-open /dev/sda2 luksdev Enter key or passphrase ("key"): @@ -899,7 +899,7 @@ The parameter is rewritten "behind the scenes" by looking up the position where the drive is mounted, prepending that to the path, changing all backslash characters to forward slash, then resolving the result using L. For example if the E: drive -was mounted on C then the parameter might be rewritten like this: +was mounted on F then the parameter might be rewritten like this: win:e:\foo\bar => /e/FOO/bar @@ -913,7 +913,7 @@ special filename C<-> to mean "from stdin" or "to stdout". For example: upload - /foo -reads stdin and creates from that a file C in the disk image, +reads stdin and creates from that a file F in the disk image, and: tar-out /etc - | tar tf - @@ -996,7 +996,7 @@ I<--csh> option: =head2 REMOTE CONTROL DETAILS Remote control happens over a Unix domain socket called -C, where C<$UID> is the effective +F, where C<$UID> is the effective user ID of the process, and C<$PID> is the process ID of the server. Guestfish client and server versions must match exactly. @@ -1074,7 +1074,7 @@ make for you to save typing. This is particularly useful for testing purposes. This option is used instead of the I<-a> option, and like I<-a> can appear multiple times (and can be mixed with I<-a>). -The new disk is called C for the first I<-N>, C +The new disk is called F for the first I<-N>, F for the second and so on. Existing files in the current directory are I. You can use a different filename by specifying C before the type (see examples below). @@ -1097,7 +1097,7 @@ is automatically launched. =head2 EXAMPLES Create a 100MB disk with an ext4-formatted partition, called -C in the current directory: +F in the current directory: guestfish -N fs:ext4 @@ -1109,8 +1109,8 @@ Create a blank 200MB disk: guestfish -N disk:200M -Create a blank 200MB disk called C (instead of -C): +Create a blank 200MB disk called F (instead of +F): guestfish -N blankdisk.img=disk:200M @@ -1138,7 +1138,7 @@ The possible I<-a URI> formats are described below. =head2 B<-a file:///path/to/disk.img> -Add the local disk image (or device) called C. +Add the local disk image (or device) called F. =head2 B<-a ftp://[user@]example.com[:port]/disk.img> @@ -1454,7 +1454,7 @@ using a supermin appliance. The appliance is cached and shared between all handles which have the same effective user ID. If C is not set, then C is used. If -C is not set, then C is used. +C is not set, then F is used. See also L, L. @@ -1491,7 +1491,7 @@ The location where libguestfs will store temporary files used by each handle. If C is not set, then C is used. If -C is not set, then C is used. +C is not set, then F is used. See also L, L. @@ -1585,8 +1585,8 @@ to make guestfish case sensitive. =item test2.img (etc) When using the I<-N> or I<--new> option, the prepared disk or -filesystem will be created in the file C in the current -directory. The second use of I<-N> will use C and so on. +filesystem will be created in the file F in the current +directory. The second use of I<-N> will use F and so on. Any existing file with the same name will be overwritten. You can use a different filename by using the C prefix. diff --git a/fish/libguestfs-tools.conf.pod b/fish/libguestfs-tools.conf.pod index d3555ecaf..bae3f30d7 100644 --- a/fish/libguestfs-tools.conf.pod +++ b/fish/libguestfs-tools.conf.pod @@ -14,7 +14,7 @@ libguestfs-tools.conf - configuration file for guestfish, guestmount, virt-rescu =head1 DESCRIPTION -C (or C<$HOME/.libguestfs-tools.rc>) changes the +F (or F<$HOME/.libguestfs-tools.rc>) changes the defaults for the following programs only: =over 4 @@ -60,7 +60,7 @@ The order of the configuration files being read is, by importance: =item * $XDG_CONFIG_HOME/libguestfs/libguestfs-tools.conf (C<$XDG_CONFIG_HOME> is -C<$HOME/.config> if not set). +F<$HOME/.config> if not set). =item * @@ -69,7 +69,7 @@ $HOME/.libguestfs-tools.rc =item * $XDG_CONFIG_DIRS/libguestfs/libguestfs-tools.conf (where C<$XDG_CONFIG_DIRS> -means any of the directories in that environment variable, or just C +means any of the directories in that environment variable, or just F if not set) =item * @@ -80,9 +80,9 @@ if not set) This means local users can override the system configuration by copying the configuration file (or creating it anew) into -C<$XDG_CONFIG_HOME/libguestfs/libguestfs-tools.conf>. +F<$XDG_CONFIG_HOME/libguestfs/libguestfs-tools.conf>. -C and C<$HOME/.libguestfs-tools.rc> are the old +F and F<$HOME/.libguestfs-tools.rc> are the old non-XDG paths which are read for compatibility. =head1 SEE ALSO diff --git a/fish/virt-copy-in.pod b/fish/virt-copy-in.pod index 3891ce543..37d96df08 100644 --- a/fish/virt-copy-in.pod +++ b/fish/virt-copy-in.pod @@ -22,11 +22,11 @@ a virtual machine disk image or named libvirt domain. You can give one of more filenames and directories on the command line. Directories are copied in recursively. The final parameter must be the destination directory in the disk image which must be an -absolute path starting with a C character. +absolute path starting with a F character. =head1 EXAMPLES -Update C in a guest: +Update F in a guest: virt-copy-in -d MyGuest resolv.conf /etc diff --git a/format/virt-format.pod b/format/virt-format.pod index caec41182..2f8320311 100644 --- a/format/virt-format.pod +++ b/format/virt-format.pod @@ -25,7 +25,7 @@ or this: virt-format -a /dev/VG/LV -C or C must exist already. B or F must exist already. B. These commands will create a single empty partition covering the whole disk, with no filesystem inside it. @@ -101,12 +101,12 @@ For example: virt-format --format=raw -a disk.img -forces raw format (no auto-detection) for C. +forces raw format (no auto-detection) for F. virt-format --format=raw -a disk.img --format -a another.img -forces raw format (no auto-detection) for C and reverts to -auto-detection for C. +forces raw format (no auto-detection) for F and reverts to +auto-detection for F. If you have untrusted raw-format guest disk images, you should use this option to specify the disk format. This avoids a possible @@ -118,13 +118,13 @@ Set the filesystem label. =item B<--lvm=/dev/I/I> -Create a Linux LVM2 logical volume called C/I>. You +Create a Linux LVM2 logical volume called F/I>. You can change the name of the volume group and logical volume. =item B<--lvm> Create a Linux LVM2 logical volume with the default name -(C). +(F). =item B<--lvm=none> diff --git a/fuse/guestmount.pod b/fuse/guestmount.pod index 0db5c6c40..6dedf700a 100644 --- a/fuse/guestmount.pod +++ b/fuse/guestmount.pod @@ -31,7 +31,7 @@ manual page, or by looking at the examples below. FUSE lets you mount filesystems as non-root. The mountpoint must be owned by you, and the filesystem will not be visible to any other users unless you make certain global configuration changes to -C. To unmount the filesystem, use the +F. To unmount the filesystem, use the L command. =head1 EXAMPLES @@ -252,7 +252,7 @@ mounted on the real virtual machine. =item B<--keys-from-stdin> Read key or passphrase parameters from stdin. The default is -to try to read passphrases from the user by opening C. +to try to read passphrases from the user by opening F. =item B<--live> @@ -266,8 +266,8 @@ Connect to a live virtual machine. Mount the named partition or logical volume on the given mountpoint B (this has nothing to do with mountpoints in the host). -If the mountpoint is omitted, it defaults to C. You have to mount -something on C. +If the mountpoint is omitted, it defaults to F. You have to mount +something on F. The third (and rarely used) part of the mount parameter is the list of mount options used to mount the underlying filesystem. If this is not diff --git a/generator/actions.ml b/generator/actions.ml index 72522957a..d5e5ccf16 100644 --- a/generator/actions.ml +++ b/generator/actions.ml @@ -615,7 +615,7 @@ against. Note that because of dynamic linking this is not necessarily the version of libguestfs that you compiled against. You can compile the program, and then at runtime dynamically link -against a completely different C library. +against a completely different F library. This call was added in version C<1.0.58>. In previous versions of libguestfs there was no way to get the version @@ -830,7 +830,7 @@ to specify the QEMU interface emulation to use at run time." }; ]; shortdesc = "detect the architecture of a binary file"; longdesc = "\ -This detects the architecture of the binary C, +This detects the architecture of the binary F, and returns it if known. Currently defined architectures are: @@ -1234,23 +1234,23 @@ Please read L for more details." }; This returns a hash of where we think the filesystems associated with this operating system should be mounted. Callers should note that this is at best an educated guess -made by reading configuration files such as C. +made by reading configuration files such as F. I that this may return filesystems which are non-existent or not mountable and callers should be prepared to handle or ignore failures if they try to mount them. Each element in the returned hashtable has a key which -is the path of the mountpoint (eg. C) and a value +is the path of the mountpoint (eg. F) and a value which is the filesystem that would be mounted there -(eg. C). +(eg. F). Non-mounted devices such as swap devices are I returned in this list. For operating systems like Windows which still use drive letters, this call will only return an entry for the first -drive \"mounted on\" C. For information about the +drive \"mounted on\" F. For information about the mapping of drive letters to partitions, see C. @@ -1342,13 +1342,13 @@ not all belong to a single logical operating system fish_alias = ["add"]; shortdesc = "add an image to examine or modify"; longdesc = "\ -This function adds a disk image called C to the handle. -C may be a regular host file or a host device. +This function adds a disk image called F to the handle. +F may be a regular host file or a host device. When this function is called before C (the usual case) then the first time you call this function, -the disk appears in the API as C, the second time -as C, and so on. +the disk appears in the API as F, the second time +as F, and so on. In libguestfs E 1.20 you can also call this function after launch (with some restrictions). This is called @@ -1362,9 +1362,9 @@ for whatever operations you want to perform (ie. read access if you just want to read the image or write access if you want to modify the image). -This call checks that C exists. +This call checks that F exists. -C may be the special string C<\"/dev/null\">. +F may be the special string C<\"/dev/null\">. See L. The optional arguments are: @@ -1395,7 +1395,7 @@ deprecated C call (q.v.) =item C -The name the drive had in the original guest, e.g. C. +The name the drive had in the original guest, e.g. F. This is used as a hint to the guest inspection process if it is available. @@ -1403,8 +1403,8 @@ it is available. Give the disk a label. The label should be a unique, short string using I ASCII characters C<[a-zA-Z]>. -As well as its usual name in the API (such as C), -the drive will also be named C>. +As well as its usual name in the API (such as F), +the drive will also be named F>. See L. @@ -1419,7 +1419,7 @@ See also: L. =item C -C is interpreted as a local file or device. +F is interpreted as a local file or device. This is the default if the optional protocol parameter is omitted. @@ -1504,7 +1504,7 @@ in one of the following formats: unix:/path/to/socket If the port number is omitted, then the standard port number -for the protocol is used (see C). +for the protocol is used (see F). =item C @@ -1601,7 +1601,7 @@ The default is false. shortdesc = "get Windows systemroot of inspected operating system"; longdesc = "\ This returns the Windows systemroot of the inspected guest. -The systemroot is a directory path such as C. +The systemroot is a directory path such as F. This call assumes that the guest is Windows and that the systemroot could be determined by inspection. If this is not @@ -2192,7 +2192,7 @@ Please read L for more details." }; shortdesc = "get drive letter mappings"; longdesc = "\ This call is useful for Windows which uses a primitive system -of assigning drive letters (like \"C:\") to partitions. +of assigning drive letters (like F) to partitions. This inspection API examines the Windows Registry to find out how disks/partitions are mapped to drive letters, and returns a hash table as in the example below: @@ -2233,7 +2233,7 @@ If it was not possible to get an icon this function returns a zero-length (non-NULL) buffer. I. Libguestfs will start by looking for a file called -C or C +F or F and if it has the correct format, the contents of this file will be returned. You can disable favicons by passing the optional C boolean as false (default is true). @@ -2421,19 +2421,19 @@ returns them in a consistent format: =over 4 -=item C +=item F -=item C +=item F -These are returned as C. Note this works for device +These are returned as F. Note this works for device names and partition names. This is approximately the reverse of the algorithm described in L. -=item C +=item F -=item C +=item F -Converted to C form using C. +Converted to F form using C. =back @@ -2498,7 +2498,7 @@ or C functions." }; shortdesc = "find all files and directories"; longdesc = "\ This command lists out all files and directories, recursively, -starting at C. It is essentially equivalent to +starting at F. It is essentially equivalent to running the shell command C but some post-processing happens on the output, described below. @@ -2509,7 +2509,7 @@ if the directory structure was: /tmp/b /tmp/c/d -then the returned list from C C would be +then the returned list from C F would be 4 elements: a @@ -2517,7 +2517,7 @@ then the returned list from C C would be c c/d -If C is not a directory, then this command returns +If F is not a directory, then this command returns an error. The returned list is sorted." }; @@ -2742,7 +2742,7 @@ list a directory contents without making many round-trips." }; ]; shortdesc = "list the files in a directory"; longdesc = "\ -List the files in C (relative to the root directory, +List the files in F (relative to the root directory, there is no cwd). The '.' and '..' entries are not returned, but hidden files are shown." }; @@ -2783,8 +2783,8 @@ data." }; ]; shortdesc = "detect the disk format of a disk image"; longdesc = "\ -Detect and return the format of the disk image called C. -C can also be a host device, etc. If the format of the +Detect and return the format of the disk image called F. +F can also be a host device, etc. If the format of the image could not be detected, then C<\"unknown\"> is returned. Note that detecting the disk format can be insecure under some @@ -2814,7 +2814,7 @@ See also: L" }; shortdesc = "return virtual size of a disk"; longdesc = "\ Detect and return the virtual size in bytes of the disk image -called C. +called F. Note that detecting disk features can be insecure under some circumstances. See L." }; @@ -2840,7 +2840,7 @@ circumstances. See L." }; ]; shortdesc = "return whether disk has a backing file"; longdesc = "\ -Detect and return whether the disk image C has a +Detect and return whether the disk image F has a backing file. Note that detecting disk features can be insecure under some @@ -3011,7 +3011,7 @@ Set the directory used by the handle to store temporary files. The environment variables C and C control the default value: If C is set, then that is the default. Else if C is set, then that is -the default. Else C is the default." }; +the default. Else F is the default." }; { defaults with name = "get_tmpdir"; added = (1, 19, 58); @@ -3036,7 +3036,7 @@ effective user ID. The environment variables C and C control the default value: If C is set, then that is the default. Else if C is set, then that is -the default. Else C is the default." }; +the default. Else F is the default." }; { defaults with name = "get_cachedir"; added = (1, 19, 58); @@ -3149,7 +3149,7 @@ the libguestfs protocol." }; test_excuse = "tests in tests/create subdirectory"; shortdesc = "create a blank disk image"; longdesc = "\ -Create a blank disk image called C (a host file) +Create a blank disk image called F (a host file) with format C (usually C or C). The size is C bytes. @@ -3160,7 +3160,7 @@ size of the backing file, which is discovered automatically. You are encouraged to also pass C to describe the format of C. -If C refers to a block device, then the device is +If F refers to a block device, then the device is formatted. The C is ignored since block devices have an intrinsic size. @@ -3378,14 +3378,14 @@ let daemon_functions = [ shortdesc = "mount a guest disk at a position in the filesystem"; longdesc = "\ Mount a guest disk at a position in the filesystem. Block devices -are named C, C and so on, as they were added to +are named F, F and so on, as they were added to the guest. If those block devices contain partitions, they will have -the usual names (eg. C). Also LVM C-style +the usual names (eg. F). Also LVM F-style names can be used, or 'mountable' strings returned by C or C. The rules are the same as for L: A filesystem must -first be mounted on C before others can be mounted. Other +first be mounted on F before others can be mounted. Other filesystems can only be mounted on directories which already exist. @@ -3439,7 +3439,7 @@ file types such as directories, symbolic links, block special etc." }; test_excuse = "tricky to test because it depends on the exact format of the 'ls -l' command, which changed between Fedora 10 and Fedora 11"; shortdesc = "list the files in a directory (long format)"; longdesc = "\ -List the files in C (relative to the root directory, +List the files in F (relative to the root directory, there is no cwd) in the format of 'ls -la'. This command is mostly useful for interactive sessions. It @@ -3458,7 +3458,7 @@ is I intended that you try to parse the output string." }; longdesc = "\ List all the block devices. -The full block device names are returned, eg. C. +The full block device names are returned, eg. F. See also C." }; @@ -3482,7 +3482,7 @@ See also C." }; longdesc = "\ List all the partitions detected on all block devices. -The full partition device names are returned, eg. C +The full partition device names are returned, eg. F This does not return logical volumes. For that you will need to call C. @@ -3514,7 +3514,7 @@ List all the physical volumes detected. This is the equivalent of the L command. This returns a list of just the device names that contain -PVs (eg. C). +PVs (eg. F). See also C." }; @@ -3580,7 +3580,7 @@ List all the logical volumes detected. This is the equivalent of the L command. This returns a list of the logical volume device names -(eg. C). +(eg. F). See also C, C." }; @@ -3635,7 +3635,7 @@ You must call this before using any other C commands. C is the filesystem root. C must not be NULL, -use C instead. +use F instead. The flags are the same as the flags defined in Eaugeas.hE, the logical I of the following @@ -3774,7 +3774,7 @@ the tree before or after C (depending on the boolean flag C). C must match exactly one existing node in the tree, and -C. The optional parameter C represents the qgroup which the newly created subvolume will be added to." }; @@ -10768,7 +10768,7 @@ command (see L), for example: longdesc = "\ This specialized command is used to get a listing of the filenames in the directory C. The list of filenames -is written to the local file C (on the host). +is written to the local file F (on the host). In the output file, the filenames are separated by C<\\0> characters. @@ -10826,7 +10826,7 @@ C calls." }; ]; shortdesc = "open a Windows Registry hive file"; longdesc = "\ -Open the Windows Registry hive file named C. +Open the Windows Registry hive file named F. If there was any previous hivex handle associated with this guestfs session, then it is closed. @@ -10978,7 +10978,7 @@ See also: C." }; longdesc = "\ Commit (write) changes to the hive. -If the optional C parameter is null, then the changes +If the optional F parameter is null, then the changes are written back to the same hive that was opened. If this is not null then they are written to the alternate filename given and the original hive is left untouched. @@ -11171,12 +11171,12 @@ silently create an ext2 filesystem instead." }; If you add drives using the optional C