pharos-validator/src/validation_tool/doc/pharos-validator.1

   1 .TH pharoscmp 1 "2016-06-01" "version 0.1"
   2 .SH NAME
   3 pharoscmp - Testing tool for Pharos specification
   4
   5 .SH SYNOPSIS
   6 .B pharoscmp [ options ]
   7
   8 .SH DESCRIPTION
   9 This tool uses the virtual Linux filesystems to determine a computer's hardware and evaluate it against the Pharos specification to see if said computer is sufficient for being a node as part of the pod.
  10
  11 .SH OPTIONS
  12 .BR \-h ", " \-\-help
  13 Show a help message and exit
  14 .PP
  15 .BR \-\-version
  16 Show program version
  17 .PP
  18 .BR \-c ", " \-\-color
  19 Enable colored console output
  20 .PP
  21 .BR \-v ", " \-\-verbose
  22 Enable more verbose console output
  23 .PP
  24 .BR \-q ", " \-\-quiet
  25 Disable console output
  26 .PP
  27 .BR \-o ", " \-\-output
  28 Define path to output file for yaml file of results
  29 .PP
  30 .BR \-f ", " \-\-force
  31 Forcefully override file defined by --output
  32 .PP
  33 .BR \-P ", " \-\-path
  34 Path to the directory where the test should poll for the file called "nodeinfo.yaml" to arrive in. This file is usually sent via ssh to wherever the test is running
  35 .PP
  36
  37 .SH BUGS
  38 Please report bugs to https://tommy.iol.unh.edu/redmine/projects/pharoscmp
  39
  40 .SH AUTHOR
  41 AUTHOR INFO GOES HERE
  42
  43 .SH LICENSE
  44 Licensed under the Apache License, Version 2.0 (the "License");
  45 you may not use this file except in compliance with the License.
  46 You may obtain a copy of the License at
  47
  48         http://www.apache.org/licenses/LICENSE-2.0
  49
  50 Unless required by applicable law or agreed to in writing, software
  51 distributed under the License is distributed on an "AS IS" BASIS,
  52 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  53 See the License for the specific language governing permissions and
  54 limitations under the License.