Module: Yast::UsersHelpsInclude

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

Instance Method Summary (collapse)

Instance Method Details

- (Object) AuthentizationDialogHelp



610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
# File '../../src/include/users/helps.rb', line 610

def AuthentizationDialogHelp
  help_text =
    # help text 1/2
    _(
      "<p>\n" +
        "<b>Configuration Overview</b><br>\n" +
        "Here, see a summary of modules that could affect sources\n" +
        "of user accounts or authentication type.\n" +
        "</p>\n"
    ) +
      # help text 2/2
      _(
        "<p>\n" +
          "<b>Changing the Values</b><br>\n" +
          "You can configure these settings by running appropriate modules. Select the module with <b>Configure</b>.\n" +
          "</p>\n"
      )

  help_text
end

- (String) DefaultsDialogHelp

Returns The help text.

Returns:

  • (String)

    The help text.



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
# File '../../src/include/users/helps.rb', line 101

def DefaultsDialogHelp
  # Help text 0/6
  _(
    "<p>\n" +
      "Here, set default values to use when creating new local or system users.\n" +
      "</p>\n"
  ) +
    # Help text 1/6
    _(
      "<p>\n" +
        "<b>Default Group</b><br>\n" +
        "The group name of a new user's primary group.\n" +
        "</p>\n"
    ) +
    # Help text 1.5/6
    _(
      "<p>\n" +
        "<b>Secondary Groups</b><br>\n" +
        "Names of additional groups to which to assign new users.\n" +
        "</p>\n"
    ) +
    # Help text 2/6
    _(
      "<p><b>Default Login Shell</b><br>\nThe name of the new user's login shell. Select one from the list or enter your own path to the shell.</P>\n"
    ) +
    #Help text 3/6
    _(
      "<p><b>Default Home</b><br>\n" +
        "The initial path prefix for a new user's home directory. The username is added\n" +
        "to the end of this value to create the default name of the home directory.\n" +
        "</P>\n"
    ) +
    # Help text 4/6
    _(
      "<p><b>Skeleton Directory</b><br>\nThe contents of this directory are copied to a user's home directory when a new user is added. </p>\n"
    ) +
    # Help text 4.5/6
    _(
      "<p><b>Umask for Home Directory</b><br>\nUmask to use for creating new home directories.</p>\n"
    ) +
    # Help text 5/6:
    # Don't reorder letters YYYY-MM-DD, date must be set in this format
    _(
      "<p><b>Expiration Date</b><br>\n" +
        "The date on which the user account is disabled. The date must be in the format\n" +
        "YYYY-MM-DD. Leave it empty if this account never expires.</P>\n"
    ) +
    # Help text 6/6
    _(
      "<P><B>Days after Password Expiration Login Is Usable</B><BR>\n" +
        "Users can log in after expiration of passwords. Set how many days \n" +
        "after expiration login is allowed. Use -1 for unlimited access.\n" +
        "</P>\n"
    )
end

- (String) EditGroupDialogHelp(more)

Help for EditGroupDialog.

Parameters:

  • more (Boolean)

    if the widget with more_users will be shown

Returns:

  • (String)

    help text



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
# File '../../src/include/users/helps.rb', line 310

def EditGroupDialogHelp(more)
  # help text 1/6
  helptext = Ops.add(
    Ops.add(
      Ops.add(
        Ops.add(
          _("<p>\nEnter the group data here.   \n</p>\n") +
            # help text 2/6
            _(
              "<p>\n" +
                "<b>Group Name:</b>\n" +
                "Avoid long names for groups. Normal lengths are between \n" +
                "two and eight characters.  \n" +
                "You can redefine the list of characters allowed for group names in\n" +
                "the /etc/login.defs file. Read its man page for information.\n" +
                "</p>\n"
            ),
          # help text 3/6, %1 is number
          Builtins.sformat(
            _(
              "<p>\n" +
                "<b>Group ID (gid):</b>\n" +
                "In addition to its name, a group must be assigned a numerical ID for its\n" +
                "internal representation. These values are between 0 and\n" +
                "%1. Some of the IDs are already assigned during installation. You will be\n" +
                "warned if you try to use an already set one.\n" +
                "</p>\n"
            ),
            UsersCache.GetMaxGID("local")
          )
        ),
        # help text 4/6
        _(
          "<p>\n" +
            "<b>Password:</b>\n" +
            "To require users who are not members of the group to identify themselves when\n" +
            "switching to this group (see the man page of <tt>newgrp</tt>), assign a\n" +
            "password to this group. For security reasons, this password is not shown\n" +
            "here. This entry is not required.\n" +
            "</p>\n"
        )
      ),
      # help text 5/6
      _(
        "<p>\n" +
          "<b>Confirm Password:</b>\n" +
          "Enter the password a second time to avoid typing errors.\n" +
          "</p>\n"
      )
    ),
    # help text 6/6
    _(
      "<p>\n" +
        "<b>Group Members:</b>\n" +
        "Here, select which users should be members of this group.\n" +
        "</p>\n"
    )
  )

  if more
    helptext = Ops.add(
      helptext,
      # additional helptext for EditFroup dialog
      _(
        "The second list shows users for which this group is the default\n        group. The default group can only be changed by editing the user."
      )
    )
  end

  helptext
end

- (String) EditUserDetailsDialogHelp(user_type, what)

Help for EditUserDetailsDialog.

Parameters:

  • user_type (String)

    type of edited user (local/system/ldap/nis)

  • what (String)

    what to do with a user (add_user/edit_user)

Returns:

  • (String)

    help text



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
# File '../../src/include/users/helps.rb', line 387

def EditUserDetailsDialogHelp(user_type, what)
  # help text 1/8
  helptext = Ops.add(
    Ops.add(
      Ops.add(
        _("<p>\nAdditional user data includes:\n</p>"),
        # help text 2/8, %1 is number
        Builtins.sformat(
          _(
            "<p>\n" +
              "<b>User ID (uid):</b>\n" +
              "Each user is known to the system by a unique number,\n" +
              "the user ID. For normal users, you should use\n" +
              "a UID larger than %1 because the smaller UIDs are used\n" +
              "by the system for special purposes and pseudo logins.\n" +
              "</p>\n"
          ),
          UsersCache.GetMaxUID("system")
        )
      ),
      # help text 3/8
      _(
        "<p>\n" +
          "If you change the UID of an existing user, the rights of the files\n" +
          "this user owns must be changed. This is done automatically\n" +
          "for the files in the user's home directory, but not for files \n" +
          "located elsewhere.</p>\n"
      )
    ),
    # help text 4/8
    _(
      "<p>\n" +
        "<b>Home Directory:</b>\n" +
        "The home directory of the user. Normally this is\n" +
        "/home/username. \n" +
        "To select an existing directory, click <b>Browse</b>.\n" +
        "</p>\n"
    )
  )
  if what == "add_user"
    # help text for user's home directory mode
    helptext = Ops.add(
      helptext,
      _(
        "<p>Optionally, set the <b>Home Directory Permission Mode</b> for this user's home directory different from the default.</p>"
      )
    )

    defaults = Users.GetLoginDefaults
    helptext = Ops.add(
      helptext,
      # alternate helptext 4.5/8; %1 is directory (e.g. '/etc/skel')
      Builtins.sformat(
        _(
          "<p>To create only an empty home directory,\n" +
            "check <b>Empty Home</b>. Otherwise, the new home directory\n" +
            "is created from the default skeleton (%1).</p>\n"
        ),
        Ops.get_string(defaults, "skel", "")
      )
    )
  else
    # help text for Move to new location checkbox
    helptext = Ops.add(
      helptext,
      _(
        "<p>If changing the location of a user's home directory, move the contents of the current directory with <b>Move to New Location</b>, activated by default. Otherwise a new home directory is created without any of the existing data.</p>"
      )
    )
  end

  if user_type == "system" || user_type == "local" ||
      user_type == "ldap" && Ldap.file_server
    if UsersRoutines.CryptedHomesEnabled
      # help text for directory encryption
      helptext = Ops.add(
        helptext,
        _(
          "<p>To encrypt the user's home directory, enable <b>Use Encrypted Home\n" +
            "Directory</b> and set the directory size. Encrypting a user's home directory\n" +
            "does not provide strong security from other users. If this machine is shared\n" +
            "among multiple users, it may be possible for a user to compromise system\n" +
            "security by obtaining another user's key and gaining access to the encrypted data. If strong security is required, the system should not be physically shared.</p>"
        )
      )
    else
      # help text for directory encryption
      helptext = Ops.add(
        helptext,
        _(
          "<p>Home directories cannot be encrypted if a fingerprint reader device is used. To encrypt the user's home directory, disable fingerprint configuration first.</p>"
        )
      )
    end
  end

  if user_type == "ldap"
    helptext = Ops.add(
      helptext,
      # alternate helptext 5/8
      _(
        "<p>\n" +
          "The home directory of an LDAP user can be changed only on the\n" +
          "file server.</p>"
      )
    )
  elsif user_type == "system" || user_type == "local"
    helptext = Ops.add(
      helptext,
      # alternate helptext 5/8
      _(
        "<p><b>Additional Information:</b>\n" +
          "Some additional user data could be set here. This field may contain up to\n" +
          "three parts, separated by commas. The standard usage is to write\n" +
          "<i>office</i>,<i>work phone</i>,<i>home phone</i>. This information is \n" +
          "shown when you use the <i>finger</i> command on this user.</p>\n"
      )
    )
  end

  # help text 6/8
  helptext = Ops.add(
    Ops.add(
      Ops.add(
        helptext,
        _(
          "<p>\n" +
            "<b>Login Shell:</b>\n" +
            "The login shell (command interpreter) for the user.\n" +
            "Select a shell from the list of all shells installed\n" +
            "on your system.\n" +
            "</p>"
        )
      ),
      # help text 7/8
      _(
        "<p>\n" +
          "<b>Default Group:</b>\n" +
          "The primary group to which the user belongs. Select one group\n" +
          "from the list of all groups existing on your system.\n" +
          "</p>"
      )
    ),
    # help text 8/8
    _(
      "<p>\n" +
        "<b>Additional Groups:</b>\n" +
        "Select additional groups in which the user should be a member.\n" +
        "</p>\n"
    )
  )
  helptext
end

- (String) EditUserDialogHelp(mail, type, what)

Help for EditUserDialog.

Parameters:

  • mail (Boolean)

    if checkbox for mail forwarding should be included

  • type (String)

    type of user created

Returns:

  • (String)

    help text



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# File '../../src/include/users/helps.rb', line 199

def EditUserDialogHelp(mail, type, what)
  help = ""
  if type == "ldap"
    # help text 1/7
    help = _(
      "<p>\n" +
        "Enter the <b>First Name</b>, <b>Last Name</b>, \n" +
        "<b>Username</b>, and\n" +
        "<b>Password</b> to assign to this user.\n" +
        "</p>\n"
    )
  else
    # alternative help text 1/7
    help = _(
      "<p>\n" +
        "Enter the <b>User's Full Name</b>, <b>Username</b>, and <b>Password</b> to\n" +
        "assign to this user account.\n" +
        "</p>\n"
    )
  end

  help = Ops.add(help, help_password(type))

  if what == "add_user"
    help = Ops.add(
      help,
      # help text 2/7
      _(
        "<p>\n" +
          "Create the <b>Username</b> from components of the full name by\n" +
          "clicking <b>Suggestion</b>. It may be modified, but use only\n" +
          "letters (no accented characters), digits, and <tt>._-</tt>.\n" +
          "Do not use uppercase letters in this entry unless you know what you are doing.\n" +
          "Usernames have stricter restrictions than passwords. You can redefine the\n" +
          "restrictions in the /etc/login.defs file. Read its man page for information.\n" +
          "</p>\n"
      )
    )
  else
    help = Ops.add(
      help,
      # alternative help text 2/7
      _(
        "<p>\n" +
          "For the <b>Username</b>, use only\n" +
          "letters (no accented characters), digits, and <tt>._-</tt>.\n" +
          "Do not use uppercase letters in this entry unless you know what you are doing.\n" +
          "Usernames have stricter restrictions than passwords. You can redefine the\n" +
          "restrictions in the /etc/login.defs file.  Read its man page for information.\n" +
          "</p>\n"
      )
    )
  end

  if mail # these are used only during installation time
    # help text 4/7 (only during installation)
    help = Ops.add(
      Ops.add(
        Ops.add(
          help,
          _(
            "<p>\nThe username and password created here are needed to log in and work with your Linux system. With <b>Automatic Login</b> enabled, the login procedure is skipped. This user is logged in automatically.</p>\n"
          )
        ),
        # help text 5/7 (only during installation)
        _(
          "<p>\nHave mail for root forwarded to this user by checking <b>Receive System Mail</b>.</p>\n"
        )
      ),
      # help text 6/7 (only during installation)
      _(
        "<p>Press <b>User Management</b> to add more users or groups to your system.</p>"
      )
    )
  else
    # alternative help text 4/7
    help = Ops.add(
      Ops.add(
        help,
        _(
          "<p>\n" +
            "To see more details, such as the home directory or the user ID, click\n" +
            "<b>Details</b>.\n" +
            "</p>\n"
        )
      ),
      # alternative help text 5/7
      _(
        "<p>\nTo edit various password settings of this user, such as expiration date, click <b>Password Settings</b>.</p>\n"
      )
    )
  end

  if !mail && type != "nis"
    # help text 7/7
    help = Ops.add(
      help,
      _(
        "<p>To forbid this user to\nlog in, check <b>Disable User Login</b>.</p>"
      )
    )
  end
  help
end

- (String) EditUserPasswordDialogHelp

Help for editing password settings

Returns:

  • (String)

    help text



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
# File '../../src/include/users/helps.rb', line 571

def EditUserPasswordDialogHelp
  # Help text 1/6
  _(
    "<p>Activate <b>Force Password Change</b> to force the user to change the\n" +
      "password at the next login. If <b>Last Password Change</b> is set to\n" +
      "<i>Never</i>, the user will be forced to change the password.</p>"
  ) +
    # Help text 2/6
    _(
      "<p>\n" +
        "<b>Days before Password Expiration to Issue Warning</B><BR>\n" +
        "Users can be warned before their passwords expire. Set \n" +
        "how long before expiration the warning should be issued. Set -1 to disable\n" +
        "the warning. \n" +
        "</p>\n"
    ) +
    # Help text 3/6
    _(
      "<P><B>Days after Password Expires with Usable Login</B><BR>\n" +
        "Users can log in after their passwords have expired. Set how many days to\n" +
        "allow login. Use -1 for unlimited access.\n" +
        "</P>\n"
    ) +
    #Help text 4/6
    _(
      "<P><B>Maximum Number of Days for the Same Password</B><BR>Set how many days a user \ncan use the same password before it expires.</P>\n"
    ) +
    # Help text 5/6
    _(
      "<P><B>Minimum Number of Days for the Same Password</B><BR>Set the minimum age of \na password before a user is allowed to change it.</P>\n"
    ) +
    # Help text 6/6 : Don't reorder letters YYYY-MM-DD, date must be set in this format
    _(
      "<P><B>Expiration Date</B><BR>Set the date when this account expires. \n" +
        "The date must be in the format YYYY-MM-DD. \n" +
        "Leave it empty if this account never expires.</P>\n"
    )
end

- (String) help_password(type)

Password help text.

Parameters:

  • type (String)

    user type

Returns:

  • (String)

    help text



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
# File '../../src/include/users/helps.rb', line 48

def help_password(type)
  password_length = ""
  enc_to_string = {
    # encryption type
    "des"   => _("DES"),
    # encryption type
    "crypt" => _("DES"),
    # encryption type
    "md5"   => _("MD5")
  }
  method = Users.EncryptionMethod
  method = UsersLDAP.GetEncryption if type == "ldap"

  # help text 1/4
  help_text = _(
    "<p>\n" +
      "When entering a password, distinguish between uppercase and\n" +
      "lowercase. Passwords should not contain any accented characters or umlauts. \n" +
      "</p>\n"
  )

  # help text 2/4 %1 is encryption type, %2,%3 numbers
  help_text = Ops.add(
    help_text,
    Builtins.sformat(
      _(
        "<p>\n" +
          "With the current password encryption (%1), the password length should be between\n" +
          " %2 and %3 characters.\n" +
          "</p>"
      ),
      Ops.get_string(enc_to_string, method, method),
      Users.GetMinPasswordLength(type),
      Users.GetMaxPasswordLength(type)
    )
  )

  help_text = Ops.add(help_text, Users.ValidPasswordHelptext)

  #help text 4/4
  help_text = Ops.add(
    help_text,
    _(
      "<p>\n" +
        "To ensure that the password was entered correctly,\n" +
        "repeat it exactly in a second field. Do not forget your password.\n" +
        "</p>\n"
    )
  )
  help_text
end

- (Object) initialize_users_helps(include_target)



33
34
35
36
37
38
39
40
41
42
43
# File '../../src/include/users/helps.rb', line 33

def initialize_users_helps(include_target)
  textdomain "users"

  Yast.import "Label"
  Yast.import "Ldap"
  Yast.import "Stage"
  Yast.import "Users"
  Yast.import "UsersCache"
  Yast.import "UsersLDAP"
  Yast.import "UsersRoutines"
end

- (Object) PluginDialogHelp

help text for dualogs with plugins



542
543
544
545
546
547
548
549
550
551
552
553
554
555
# File '../../src/include/users/helps.rb', line 542

def PluginDialogHelp
  # helptxt for plugin dialog 1/2
  _(
    "<p>Here, see the list of plug-ins, the\nextensions of user and group configuration.</p>\n"
  ) +
    # helptext for plugin dialog 2/3
    _(
      "The check mark in the left part of the table indicates that the plug-in\nis currently in use."
    ) +
    # helptext for plugin dialog 3/3
    _(
      "<p>Start the detailed configuration of a particular plug-in by selecting <b>Launch</b>.</p>"
    )
end

- (String) ReadDialogHelp

Help for the ReadDialog () dialog.

Returns:

  • (String)

    The help text.



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# File '../../src/include/users/helps.rb', line 160

def ReadDialogHelp
  # For translators: read dialog help, part 1 of 2
  _(
    "<P><B><BIG>Initializing User Management</BIG></B><BR>\n" +
      "Please wait...\n" +
      "<BR></P>\n"
  ) +
    # For translators: read dialog help, part 2 of 2
    _(
      "<P><B><BIG>Aborting the Initialization</BIG></B><BR>\n" +
        "You can safely abort the configuration utility by pressing <B>Abort</B>\n" +
        "now.\n" +
        "</P>"
    )
end

- (String) usersSaveDialogHelp

Help for usersSave.

Returns:

  • (String)

    help text



560
561
562
563
564
565
566
567
# File '../../src/include/users/helps.rb', line 560

def usersSaveDialogHelp
  # help texts 1/1
  _(
    "<p>\n" +
      "Save the current user and group settings to the system.\n" +
      "</p>"
  )
end

- (String) WriteDialogHelp

Help for the WriteDialog () dialog.

Returns:

  • (String)

    The help text.



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File '../../src/include/users/helps.rb', line 178

def WriteDialogHelp
  # For translators: read dialog help, part 1 of 2
  _(
    "<P><B><BIG>Saving User Configuration</BIG></B><BR>\n" +
      "Please wait...\n" +
      "<BR></P>\n"
  ) +
    # For translators: read dialog help, part 2 of 2
    _(
      "<P><B><BIG>Aborting the Save Process:</BIG></B><BR>\n" +
        "Abort the save process by pressing <B>Abort</B>.\n" +
        "An additional dialog will inform you whether it is safe to do so.\n" +
        "</P>\n"
    )
end