components/sysutils/cpuid/files/cpuid.ronn

   1 cpuid(1) -- dump and extract information from the x86 CPUID instruction
   2 =======================================================================
   3
   4 ## SYNOPSIS
   5
   6 `cpuid` [--help] [--dump] [--vendor <name>] [--ignore-vendor] [--parse <filename>]
   7
   8 ## DESCRIPTION
   9
  10 `cpuid` is a very simple C program, designed to dump and extract information
  11 from the x86 CPUID instruction.
  12
  13 `cpuid` is capable of dumping all CPUID leaves (except any unknown leaves which
  14 require special ECX values to dump all information). `cpuid` can only decode
  15 certain leaves, but this functionality will be expanded as the CPUID
  16 specifications provided by AMD and Intel change.
  17
  18 ## OPTIONS
  19
  20   `-c`, `--cpu`
  21   Index (starting at 0) of CPU to get info from
  22
  23   `-d`, `--dump`
  24   Dump a raw CPUID table
  25
  26   `-f`, `--parse`
  27   Read and decode a raw CPUID table from the file specified
  28
  29   `-h`, `--help`
  30   Print list of options
  31
  32   `--ignore-vendor`
  33   Show feature flags from all vendors
  34
  35   `--sanity`
  36   Do a sanity check of the CPUID data
  37
  38   `--vendor`
  39   Override the processor vendor string
  40
  41   `--version`
  42   Print `cpuid` version and license
  43
  44 ## STANDARDS
  45
  46 You can find current Intel and AMD CPUID specifications at these locations:
  47
  48 [Intel Software Developer Manual volume 2A](https://www.intel.com/content/www/us/en/architecture-and-technology/64-ia-32-architectures-software-developer-vol-2a-manual.html)
  49
  50 [AMD Processor Programming Reference](http://developer.amd.com/resources/developer-guides-manuals/)
  51
  52 Please notify me if you notice any inconsistencies or if features you
  53 find relevant are not being decoded.
  54
  55 ## BUGS
  56
  57 If you find a bug in `cpuid`, please submit details about it to the bug tracker
  58 on GitHub: https://github.com/tycho/cpuid/issues
  59
  60 If the bug is regarding the decoding or dumping of CPUID details, then you
  61 should include the dump.txt and decode.txt generated with these commands:
  62
  63 ```
  64 cpuid -d -c -1 > dump.txt
  65 cpuid -c -1 > decode.txt
  66 ```
  67
  68 You should also specify what revision of `cpuid` you are running. If you don't
  69 know, you can find out with:
  70
  71 ```
  72 cpuid --version
  73 ```
  74
  75 ## AUTHOR
  76
  77 Steven Noonan <steven@uplinklabs.net>