lib/chroot-mount/libusage.sh

   1 #!/bin/sh -e
   2 # ==============================================================================
   3 # portsreinstall library script
   4 # Overlay onto lib/libusage.sh for portsreinstall-chroot-mount
   5 # - Help messages -
   6 # Copyright (C) 2018-2021 Mamoru Sakaue, MwGhennndo, All Rights Reserved.
   7 # This software is distributed under the 2-Clause BSD License.
   8 # ==============================================================================
   9
  10 # ============= Content of the short help =============
  11 usage_short_content ()
  12 {
  13         cat << eof
  14 USAGE: ${APPNAME} [OPTIONS] [--] [command]
  15
  16 [OPTIONS]
  17  <Group 1: Just show messages and exit without operation>
  18  -H : Show a long help whose content is the same as the manual page.
  19  -h : Show this short help.
  20  -V : Show the current version.
  21  <Group 2: Effective anytime>
  22  -a : Suppress messages to be batch-friendly.
  23  -f: Forcible operation to ignore the lock.
  24  -J : Exit by doing nothing but just saving the options and command mode
  25  -S : Suppress the credit, opening and terminating messages.
  26
  27 [ARGUMENTS]
  28  command:
  29             mount (default)  | unmount
  30
  31 [DESCRIPTIONS]
  32  This utility is for assisting portsreinstall-chroot(8) to mount and unmount a builder environment at the grand host environment in case that the target environment is a chroot(8) or jail(8) virtual environment which does not have sufficient privilege to operate the file systems. Execution of this utility will be suggested by portsreinstall-chroot(8) executed at the target environment. The executable file of this utility is installed outside the scope of the search paths, and expected to be launched by specifying the full path.
  33
  34
  35 [ROBUSTNESS AGAINST TERMINATION AND RESTART]
  36  Execution of this utility can be terminated at any points and restarted from there.
  37 eof
  38 }