diff --git a/docs/vvd.1 b/docs/vvd.1 index 44319aa..a0981b7 100644 --- a/docs/vvd.1 +++ b/docs/vvd.1 @@ -1,6 +1,8 @@ -." Written by dd86k +." Hi! This manual (manpage) was written by dd86k. +." Please read man-pages(7) and groff_man(7) about the manual page format. +." https://www.man7.org/linux/man-pages/man7/groff_man.7.html -.TH vvd 1 "September 2019" dd86k "User Manual" +.TH vvd 1 "July 2020" dd86k "User Manual" .SH NAME .B vvd - Universal virtual disk management tool @@ -8,16 +10,27 @@ .SH SYNOPSIS .SY vvd { -.IR -I +.IR info | -.IR -M +.IR map | -.IR -N +.IR new | -.IR -C +.IR compact } -.OP rc +.IR FILE +.OP OPTIONS .YS + +.SY vvd +{ +.IR new +} +.IR FILE +.IR SIZE +.OP OPTIONS +.YS + .SY vvd { .IR --help @@ -30,45 +43,44 @@ .SH DESCRIPTION -vvd aims to be a simple to use universal virtual disk management tool. +vvd aims to be a simple universal virtual disk management tool. .SH OPERATIONS -One of these must be used to operate with a virtual disk. all virtual disk -file references are referenced by "VDISK". +One of these operations must be specified to operate. All virtual disk +file referred as "VDISK". All options with double dashes, as well as default +arguments (file paths, sizes) can be specified in any order after OPERATION. -.IP -I -Get information on VDISK +.SS info +Show VDISK information. Get VDISK information such as VDISK headers (type, virtual size, etc.), MBR, -EFI, and FS, if available. Supports option -.OP -r +GPT, and FS, if available. Supports option +.OP --raw -.IP -M -Get allocation map for VDISK +.SS map +Show allocation map for VDISK. -Get allocation map for VDISK. If the VDISK type is not dynamic, the operation +If the VDISK type is not dynamic, the operation is aborted. -.IP -N -Create new VDISK +.SS new +Create new VDISK. -Create a new VDISK with SIZE and optional TYPE specifications. Dynamic disks -are created by default. If -.OP -c -is specified (create as raw), the file is pre-allocated like a fixed VDISK. +Create a new VDISK with a specified SIZE. The file extension is detected automatically. +Dynamic disks are created by default. SIZE accepted suffixes are 'K', 'M, 'G', and 'T'. + .B WARNING: THIS WILL OVERWRITE ANYTHING GIVEN IN PATH! -Here is an example of the format: + +For example: .EX -vvd -N FILE SIZE [TYPE] +vvd new example.vdi 10G --create-fixed .EE -Where FILE is a path with an extension, which sets the format (.vdi, .vmdk, -etc.), SIZE is a binary size such as "2.50G", and TYPE is an optional type -setting for either "fixed" or "dynamic". +Will create a VDI fixed disk with a capacity of 10 GiB. -.IP -C +.SS compact Compact VDISK This will attempt to compact the VDISK. If the VDISK is not of type dynamic, @@ -76,51 +88,50 @@ .SH OPTIONS -Some options may be added alongside OPERATION. Here is an example with -.OP -r +.SS --raw +Open as raw. -.EX -$ vvd -Ir /dev/sda -.EE +Open file, or device, as raw. This bypasses all format and header verification. -.IP -r -Open as raw +.SS --create-raw +Create as raw. -Open file, or device, as raw. This bypasses all format and header verifications. +Create file as raw. Only used in the +.IR new +operation, pre-allocates to SIZE. -.IP -c -Create as raw +.SS --create-dyn +Used to specify a dynamic-size virtual disk at creation. -Create file as raw. Only used in -.IR -N -, pre-allocates to SIZE. +.SS --create-fixed +Used to specify a fixed-size virtual disk at creation. .SH EXAMPLES -.B Get VDISK information +.SS Get VDISK information .EX -$ vvd -I windows10.vhd +$ vvd info windows10.vhd .EE -.B Get disk information +.SS Get disk information -Open as raw. Requires elevated privileges. +Requires elevated privileges. .EX -$ vvd -Ir /dev/sda -> vvd -Ir \\\\.\\PhysicalDrive0 +$ vvd info --raw /dev/sda +> vvd info \\\\.\\PhysicalDrive0 --raw .EE -.B Create fixed VDISK +.SS Create fixed VDISK .EX -$ vvd -N arch.vdi 4G fixed +$ vvd new arch.vdi 4G --create-fixed .EE .SH WARNINGS -.B This tool is way too young to be called stable. This thing may explode violently. +.B This tool is way too young to be called stable and may explode violently. This tool may likely change often during its growth. @@ -129,10 +140,10 @@ .MT dd@dax.moe .ME -.UR https://git.dd86k.space/vvd +.UR https://git.dd86k.space/dd86k/vvd Homepage: .UE -A mirror is available at .UR https://github.com/dd86k/vvd +Mirror: .UE