Module: Yast::SquidHelpsInclude

Defined in:
../../src/include/squid/helps.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) initialize_squid_helps(include_target)



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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File '../../src/include/squid/helps.rb', line 28

def initialize_squid_helps(include_target)
  textdomain "squid"

  # All helps are here
  @HELPS = {
    # Read dialog help 1/2
    "read"            => _(
      "<p><b><big>Initializing Squid Configuration</big></b><br>\n</p>\n"
    ) +
      # Read dialog help 2/2
      _(
        "<p><b><big>Aborting Initialization:</big></b><br>\nSafely abort the configuration utility by pressing <b>Abort</b> now.</p>\n"
      ),
    # Write dialog help 1/2
    "write"           => _(
      "<p><b><big>Saving Squid Configuration</big></b><br>\n</p>\n"
    ) +
      # Write dialog help 2/2
      _(
        "<p><b><big>Aborting Saving:</big></b><br>\n" +
          "Abort the save procedure by pressing <b>Abort</b>.\n" +
          "An additional dialog informs whether it is safe to do so.\n" +
          "</p>\n"
      ),
    # Summary dialog help
    "summary"         => _(
      "<p><b><big>Squid Configuration</big></b><br>\nConfigure Squid here.<br></p>\n"
    ),
    # Ovreview dialog help
    "overview"        => _(
      "<p><b><big>Squid Configuration Overview</big></b><br>\n" +
        "Obtain an overview of installed squids and\n" +
        "edit their configurations if necessary.<br></p>\n"
    ),
    # Http Ports Dialog
    "http_ports"      => _(
      "<p>Define all ports where Squid will\nlisten for clients' http requests.</p>\n"
    ) +
      _(
        "<p><b>Host</b> can contain a hostname or IP address\nor remain empty.</p>\n"
      ),
    # Cache Dialog
    "cache"           => _(
      "<p><b>Refresh Patterns</b> define how Squid treats the objects in the cache.</p>\n"
    ) +
      _(
        "<p>The refresh patterns are checked in the order listed here.\nThe first matching entry is used.</p>\n"
      ) +
      _(
        "<p><b>Min</b> determines how long (in minutes) an object should be\nconsidered fresh if no explicit expiry time is given.\n"
      ) +
      _(
        "<p><b>Percent</b> is the percentage of the object's age (time since last\n" +
          "modification). An object without explicit expiry time will be\n" +
          "considered fresh.</p>\n"
      ) +
      _(
        "<p><b>Max</b> is the upper limit of how long objects without an explicit\nexpiry time will be considered fresh.</p>\n"
      ),
    # Cache 2 Dialog
    "cache2"          => _(
      "<p><b>Cache memory</b> defines the ideal amount of memory to be used for objects.</p>"
    ) +
      _(
        "<p><b>Max Object Size</b> defines the maximum size for objects to be stored\non the disk. Objects larger than this size will not be saved on disk.</p>\n"
      ) +
      _(
        "<p><b>Min Object Size</b> specifies the minimum size for objects. Smaller \nobjects will not be saved to the disk.</p>\n"
      ) +
      _(
        "<p>Replacement begins when the swap (disk) usage is above the\n" +
          "<b>Swap Low-Water Mark</b> and attempts to maintain utilization near the\n" +
          "<b>Swap Low-Water Mark</b>. As swap utilization gets close to\n" +
          "<b>Swap High-Water Mark</b>, object eviction becomes more aggressive.\n" +
          "If utilization is close to the <b>Swap Low-Water Mark</b>, less replacement\n" +
          "is done each time.\n"
      ) +
      _(
        "<p><b>Cache Replacement Policy</b> determines which objects are to be replaced\n" +
          "when disk space is needed.\n" +
          "<b>Memory Replacement Policy</b> specifies the policy for object replacement in\n" +
          "memory when space for new objects is not available.\n" +
          "Policies could be:\n" +
          "<table>\n" +
          "    <tr>\n" +
          "      <td>lru</td>\n" +
          "      <td>least recently used</td>\n" +
          "    </tr>\n" +
          "    <tr>\n" +
          "      <td>heap GDSF</td>\n" +
          "      <td>Greedy-Dual Size Frequency</td>\n" +
          "    </tr>\n" +
          "    <tr>\n" +
          "      <td>heap LFUDA</td>\n" +
          "      <td>Least Frequently Used with Dynamic Aging</td>\n" +
          "    <tr>\n" +
          "    <tr>\n" +
          "      <td>heap LRU</td>\n" +
          "      <td>lru policy implemented using a heap</td>\n" +
          "    </tr>\n" +
          "</table>\n" +
          "</p>"
      ),
    # Cache Directory
    "cache_directory" => _(
      "<p><b>Directory Name</b> defines a top-level directory where cache swap files will be stored.</p>"
    ) +
      _(
        "<p><b>Size</b> defines the amount of disk space (in MB) to use under this directory.</p>"
      ) +
      _(
        "<p><b>Level 1 Directories</b> defines a number of first-level subdirectories, \nwhich will be created under the <b>Directory Name</b> directory.</p>\n"
      ) +
      _(
        "<p><b>Level 2 Directories</b> defines a number of second-level subdirectories,\nwhich will be created under each first-level directory.</p>\n"
      ),
    # ACL Groups
    "acl_groups"      => _(
      "<p>Access to the Squid server can be controlled via <b>ACL Groups</b>.</p>"
    ) +
      _(
        "<p><b>ACL Group</b> has various types and the description of ACL Group depends\non the particular type.</p>\n"
      ),
    "http_access"     => _(
      "<p>In the <b>Access Control</b> table, access can be denied or allowed to ACL Groups.\n" +
        "If there are more ACL Groups in one line, it means that access will be allowed\n" +
        "or denied to members who belong to all ACL Groups at the same time.</p>\n"
    ) +
      _(
        "<p>The <b>Access Control</b> table is checked in the order listed here.\nThe first matching entry is used.</p>\n"
      ),
    # Logging and Timeouts Dialog
    "logging"         => _(
      "<p><b>Access Log</b> defines the file in which client activities are logged.</p>"
    ) +
      _(
        "<p><b>Cache Log</b> defines the file in which general information about your\ncache's behavior is logged.</p>\n"
      ) +
      _(
        "<p><b>Cache Store Log</b> defines the location of the transaction log of all\n" +
          "objects that are stored in the object store, as well as the time when an object\n" +
          "gets deleted. This option can be left empty.</p>\n"
      ) +
      _(
        "<p>With <b>Emulate httpd Log</b> specify that Squid writes its\n<b>Access Log</b> in HTTPD common log file format.</p>\n"
      ),
    "timeouts"        => _(
      "<p><b>Connection Timeout</b> is an option to force Squid to close\nconnections after a specified time.</p>"
    ) +
      _(
        "<p><b>Client Lifetime</b> defines the maximum amount of time that a client\n(browser) is allowed to remain connected to the cache process.</p>"
      ),
    # Miscellaneous Dialog
    "miscellaneous"   => _(
      "<p><b>Administrator's email</b> is the address which will be added to any\nerror pages that are displayed to clients. Defaults to webmaster.</p>\n"
    )
  } 

  # EOF
end