Advanced Hyperkey Commands

• These Hyperkey commands allow for more sophisticated data access:
• use [<use-type>] [<use-action>] [<use-mode>]*

   

  where:

  <use-type>

  :=

  <key>

  | .

  | ..

  <use-action>

  :=

  | -

  | --

  <use-mode>

  :=

  -default | -def

  | -new
  • Sets or reports the 'current' starting database setting.
  • The current database is the one that will be searched first when trying to match a key. The setting is persistent across sessions.
  • By default, the current database is empty, so normal the search sequence will begin with the database set by the first 'set Database' line in the '_hkey_init.txt' init file. If no option is specified, reports the current database with a message of the form:
    • CURRENT DATABASE IS IN "<path>/_hkey.db.txt"
      • if there is a current database, or:
    • NO CURRENT DATABASE
      • if not.
  • If a key is specified, looks up the key given by <key>, and if finds a match, sets the database to be "<path>/_hkey.db.txt" where <path> is the path of the key.
  • If the '.' option is specified, sets the current database to the one in the current directory.
  • If the '..' option is specified, sets the current database to the one in the parent directory of the current directory.
  • If the '-' option is specified, clears the current database for the current session. The effect of this change is not persistent across sessions.
  • If the '--' option is specified, clears the current database and sets 'none' as the default, and is persistent across sessions.
  • If the '-new' option is specified, creates a new database file in the current base path, which can be set by one of the <use-type> options. It then invokes the text editor to edit it.
  • If the '-default/-def' mode option is specified, sets the current database as the default. This option can be used in conjunction with the <use-type> options.
• share [<key>]

  sh [<key>]
  • If the key argument is specified, relocates the local folder of the key to the shared-file location on the server. This action persists, until revoked by an 'unshare' command for the same key.
  • If the key argument is not specified, all commands during that commmand session will default to the 'shared' storage location.
  • This command allows a folder in a shared location to be treated as the local location. This is useful when working as a group on the same files, as all machines will have the same 'local' location. It is also useful when a single user is working on multiple machines for the same reason. An example would be if a user was doing CAD work on one machine and CAM/Machining work on another machine.
• unshare [<key>]

  unsh [<key>]
  • If the key argument is specified, restores the local folder of the key to its original location. This un-does any 'share' commands for the key. If the key is not currently shared, will issue a message to that effect, but has no other negative effects.
  • If the key argument is not specified, the default 'share' behavior that affect all commands is turned off.
  • This command would normally be used when the need to share a common folder across machines is no longer required.
• setlocdrive <path>

  setlocdrive .
  • Overrides the base folder of the 'local' location with a new path.
  • If the path value is '.', it will set the override folder to be the current one in the command line.
  • This command is an easy way to create off-line backups of important keys, by setting the local drive to off-line storage such as a USB drive.