Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hollasch committed Apr 23, 2022
1 parent 32dacb7 commit f5d36f3
Showing 1 changed file with 34 additions and 13 deletions.
47 changes: 34 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,25 @@ command).
Usage
------
drives: Print Windows drive and volume information
Usage: drives [--json|-j] [--verbose|-v] [drive]
[--help|-h|/?] [--version]
usage : drives [--json|-j] [--verbose|-v] [drive]
[--help|-h|/?] [--version]

This program prints drive information for all devices, network mappings, DOS
devices, and drive substitutions.
devices, and drive substitutions (via the `subst` command).

Unless the `--json` option is supplied, the following drive values will be
printed, in this order:

- Drive Letter
- Label
- Serial Number
- Type (No root, Removable, Fixed, Remote, CD-ROM, or RAM Disk)
- File System (for example, NTFS, FAT, or FAT32)
- Volume GUID, drive substitution or target, or network mapping

The volume GUID can be used in a formal volume name, with the following form:

\\?\Volume{GUID}\

Options
[drive]
Expand All @@ -31,24 +45,31 @@ Usage
GetVolumeInformationW().

--verbose, -v
Print additional information. This switch is ignored if the `--json`
option is supplied.
Generally, print additional volume information. This switch is ignored
if the `--json` option is supplied. Additional volume information
includes the amount of free space and the total drive capacity.

--version
Print program version.

drives 3.0.0-alpha.4 | 2022-04-22 | https://github.com/hollasch/drives

Sample Output
--------------

C:\> drives
A: "Data" 69cc-bf14 Fixed [NTFS]
B: "Backup" 182b-29c2 Fixed [NTFS]
C: "System" cf99-12f4 Fixed [NTFS]
D: "USB" a0f3-59a6 Removable [FAT32]
H: "NASStore" 9f8b-fd0f Remote [NTFS] --> \\common\files
R: - - CD-ROM -
T: "Data" fa6f-f71d Fixed [NTFS] === A:\setup
X: "Scratch" 4fdd-258e Fixed [NTFS] === C:\Users\Fred\scratch
A: "Data" 69cc-bf14 Fixed NTFS 0f355eb5-6b2d-4583-8c15-350f09a59add
B: "Backup" 182b-29c2 Fixed NTFS 65b25216-ace2-4bc0-a768-00cd5ce46082
C: "System" cf99-12f4 Fixed NTFS c25514ce-c902-460a-aee5-a15d63e154ca
D: "ESD-USB" a0f3-59a6 Fixed FAT32 ca8f1d7e-f70c-40c3-b71f-6aad1b4f4848
E: - 9f8b-fd0f Removable FAT32 2b3413e6-3be6-4376-8d46-282aed06561b
F: "Data" fa6f-f71d Fixed NTFS === A:\setup\tools
G: "Games" 4fdd-258e Fixed NTFS b4f4619b-838c-484e-96f8-05a1bfd96a7a
R: - - CD-ROM -
S: "Scratch" 0083-3922 Fixed NTFS ce38d56e-b4c0-477f-b77c-866b629c0c87
V: "NAS3" 7f10-6416 Remote NTFS --> \\common\files
X: "Data" 2175-ff77 Remote NTFS --> \\klaatu\a$


Building
----------
Expand Down

0 comments on commit f5d36f3

Please sign in to comment.