Class: Atlasq::Command::Help

Inherits:
Base
  • Object
show all
Defined in:
lib/atlasq/command/help.rb

Instance Attribute Summary

Attributes inherited from Base

#search_terms

Instance Method Summary collapse

Methods inherited from Base

#initialize, run, to_pager?

Constructor Details

This class inherits a constructor from Atlasq::Command::Base

Instance Method Details

#content ⇒ String

Returns:

  • (String) 


9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/atlasq/command/help.rb', line 9

def content
  <<~HELP
    NAME
      atlasq -- a utility to query country info

    SYNOPSIS:
      atlasq [query ...]
      atlasq [option]
      atlasq [option] [query ...]

    DESCRIPTIONS
      Atlas Query aims to be the the simplest way to query for country
      info at the command line. It includes logic to not only find
      countries by name but also by region and currency.

      To do this we take advantage of a myriad of different ISO standards:
        - ISO3166 : Alpha and numeric codes for countries and subdivisions
        - ISO4217 : Alpha and numeric codes for currencies
        - ISO639  : Alpha and numeric codes for languages

    OPTIONS
      [none]
        : Search for countries by the following criteria
          1. country  (like --country)
          2. region   (like --region)
          3. currency (like --money)

      -c/--country
        : Display all countries
      -c/--country [query ...]
        : Search for countries by the following criteria
          1. alpha2 (ISO3166 standard 2 letter code)
          2. alpha3 (ISO3166 standard 3 letter code)
          3. number (ISO3166 standard 3 digit code)
          4. name   (common, localized, unofficial)
          5. partial match on name

      -r/--region
        : Display all countries by subregion
      -r/--region  [query ...]
        : Search for countries by the following criteria
          1. region
          2. subregion
          3. world region (4 letter code)
          4. continent

      -m/--money
        : Display all countries by currency
      -m/--money   [query ...]
        : Search for countries by the following criteria
          1. code   (ISO4127 standard 3 letter code)
          2. name   (ISO4127 standard name)
          3. symbol
          4. partial match on name

      -l/--language
        : Display all countries by language
      -l/--language   [query ...]
        : Search for countries by the following criteria
          1. alpha2 (ISO639 standard 2 letter code)
          2. alpha3 (ISO639 standard 3 letter code)
          3. partial match on name in English or French

      -h/--help
        : Display this page

      -v/--version
        : Display the version (#{VERSION})

      -d/--debug
        : Display debug output
  HELP
end