components/ruby/facter/files/facter.8

   1 .\" generated with Ronn/v0.7.3
   2 .\" http://github.com/rtomayko/ronn/tree/0.7.3
   3 .
   4 .TH "FACTER" "8" "February 2014" "" ""
   5 .
   6 .SH "NAME"
   7 \fBfacter\fR \- Gather system information
   8 .
   9 .SH "SYNOPSIS"
  10 Collect and display facts about the system\.
  11 .
  12 .SH "USAGE"
  13 .
  14 .nf
  15
  16 facter [\-h|\-\-help] [\-t|\-\-timing] [\-d|\-\-debug] [\-p|\-\-puppet] [\-v|\-\-version]
  17   [\-y|\-\-yaml] [\-j|\-\-json] [\-\-plaintext] [\-\-external\-dir DIR] [\-\-no\-external\-dir]
  18   [fact] [fact] [\.\.\.]
  19 .
  20 .fi
  21 .
  22 .SH "DESCRIPTION"
  23 Collect and display facts about the current system\. The library behind Facter is easy to expand, making Facter an easy way to collect information about a system from within the shell or within Ruby\.
  24 .
  25 .P
  26 If no facts are specifically asked for, then all facts will be returned\.
  27 .
  28 .SH "EXAMPLE"
  29 Display all facts:
  30 .
  31 .IP "" 4
  32 .
  33 .nf
  34
  35 $ facter
  36 architecture => amd64
  37 blockdevices => sda,sr0
  38 domain => example\.com
  39 fqdn => puppet\.example\.com
  40 hardwaremodel => x86_64
  41 [\.\.\.]
  42 .
  43 .fi
  44 .
  45 .IP "" 0
  46 .
  47 .P
  48 Display a single fact:
  49 .
  50 .IP "" 4
  51 .
  52 .nf
  53
  54 $ facter kernel
  55 Linux
  56 .
  57 .fi
  58 .
  59 .IP "" 0
  60 .
  61 .P
  62 Format facts as JSON:
  63 .
  64 .IP "" 4
  65 .
  66 .nf
  67
  68 $ facter \-\-json architecture kernel hardwaremodel
  69 {
  70   "architecture": "amd64",
  71   "kernel": "Linux",
  72   "hardwaremodel": "x86_64"
  73 }
  74 .
  75 .fi
  76 .
  77 .IP "" 0
  78 .
  79 .SH "AUTHOR"
  80 Luke Kanies
  81 .
  82 .SH "COPYRIGHT"
  83 Copyright (c) 2011\-2014 Puppet Labs, Inc Licensed under the Apache 2\.0 license
  84 .
  85 .SH "OPTIONS"
  86 .
  87 .nf
  88
  89 \-y, \-\-yaml                       Emit facts in YAML format\.
  90 \-j, \-\-json                       Emit facts in JSON format\.
  91     \-\-plaintext                  Emit facts in plaintext format\.
  92     \-\-trace                      Enable backtraces\.
  93     \-\-external\-dir DIR           The directory to use for external facts\.
  94     \-\-no\-external\-dir            Turn off external facts\.
  95 \-d, \-\-debug                      Enable debugging\.
  96 \-t, \-\-timing                     Enable timing\.
  97 \-p, \-\-puppet                     Load the Puppet libraries, thus allowing Facter to load Puppet\-specific facts\.
  98 \-v, \-\-version                    Print the version and exit\.
  99 \-h, \-\-help                       Print this help message\.
 100 .
 101 .fi
 102