Basic Hyperkey Commands

• Once the Hyperkey database has been created and the dbrec keys added, the following commands can use the keys to access the resources associated with they keys:
• start [<key>] <cmdline-opt>*

  s [<key>] <cmdline-opt>*

  2 [<key>] <cmdline-opt>*
  • Opens the folder of the local location of the key if the key is for a file or folder.
  • Opens the resource (such as a URL) if not.
  • This command is the keyboard equivalent of a Windows shortcut icon. It allows quick access to locations by name, freeing the user from having to remember where things are located.
  • The 2 <key> command is shorthand for 'start <key> -nw'.
• backup <key> <bak-opt>* <cmdline-opt>*

  bak <key> <bak-opt>* <cmdline-opt>*

  b <key> <bak-opt>* <cmdline-opt>*

  where:

  <bak-opt>

  :=

  -delta | -d

  | -cp [<checkpoint-name>]

  | -sel

  | -excl <filelist>

  | -only <filelist>

  | -file-list <filename>

  | -force

  | -diff

  <filelist>

  :=

  "<file-patt>" [ "<file-patt>"]+

  <cmdline-opt>

  :=

  See section on "Command Line Options" below.
  • Backs up all the files of the key to their server locations.
  • The backed-up files can then be later retrieved via the 'get' and 'rest' commands below.
  • The 'b <key>' command is shorthand for 'backup <key> -d'.
  • The '-d' option specifies to only back up the files that have changed.
  • The '-cp' option creates a new Daily backup file with the given checkpoint name. If the name is not provided in the command line, HFL will prompt for it. The filename stored in the 'Daily' server location will include the checkpoint name, with spaces replaced with periods.
  • The '-sel' option requests that for each file the user is to be prompted whether to back it up or not.
  • The '-excl <filelist>' option specifies the files or filename patterns that not to be backed up. All other files within the range of effect of the key will be backed up normally.
  • The '-only <filelist>' option specifies that only the files in the list of filenames or filename patterns are to be backed up, and all others left alone.
  • The '-file-list <filename>' option specifies that only the files in the list of filename stored in the given file are to be backed up, and all others left alone. This is basically the same as the '-only' option, except that the file names are stored separately in a file, instead of being specified in-line.
  • The '-force' option overrides the default backup behavior of the '-delta' option where only files with newer timestamps are backed up. This option forces all files that are changed to be backed up. This is needed sometimes when it is desirable to replace a newer version of a file with an older one.
  • For more details on how the backup works, or to see more advanced options, See the section on the 'Backup Command'.
• diffkey <key> <diffkey-opt>* <cmdline-opt>*

  d <key> <diffkey-opt>* <cmdline-opt>*

   

  where:

  <diffkey-opt>

  :=

  -excl <filelist> | -only <filelist>

  | -ver <date-spec>

  <filelist>

  :=

  "<file-patt>" [ "<file-patt>"]+

  <date-spec>

  :=

  (see 'restore' below for details)
  • Compares the files of the key that are in the local location to those in the server location, and list the files that are different.
  • Displays the text differences for any files that are of type 'text'.
  • This command is the normal way that one can find out which files associated with a key have changed. It is often useful in determining whether major changes have been made.
  • The '-excl <filelist>' option specifies the files or filename patterns that not to be compared. All other files within the range of effect of the key will be compared normally.
  • The '-only <filelist>' option specifies that only the files in the list of filenames or filename patterns are to be compared, and all others are ignored.
  • If the '-ver' option is specified, compares the local copy to the version that was saved under that date and Incremental version number. The <date-spec> follows the same syntax rules as the 'restore' command below.
  • (See the section on the 'Diffkey Command' for the full syntax and a more detailed description.)
• restore <key> [-ver <date-spec>]

  rest <key> [-ver <date-spec>]

   

  where:

  <date-spec>

  :=

  <relative-ver> | <date-ver>

  <relative-ver>

  :=

  a negative number, e.g. -1

  <date-ver>

  :=

  <mmddyy>[.<vv>]

  <mmddyy>

  :=

  a date string, e.g. 021715

  <vv>

  :=

  a two-digit version number, e.g. 04
  • Restores the local copy of the files of the key to the requested date and incremental version that was backed up onto the server.
  • If the '-ver' option is not specified, restores the local copy to match the current 'Main' server copy.
  • If the '-ver' option is specified, restores the local copy to a version prior to the last one saved.
  • There are three different ways to specify the target <date-spec> version:
    1. As a relative version from the latest, expressed as a negative number, where '-1' would be the version just prior to the current, '-2' would be the one before that, and so on. This specification format is the easiest to use, and is useful for just reversing the changes for a version or two.
    2. As a version saved on a specific date without a specific version number. This will restore to the final version saved for that date.
    3. As a version saved on a specific date with a specific version number. This will restore to any date that was saved, and any incremental version on that date. This format is more difficult to use, because one must first see what versions were saved by looking at the 'Backup' and 'Incremental' directories first. (This can be done via the gobak <key> and goinc <key> commands, respectively.)
  • This command is the normal way that one synchronizes a local copy of the files of a key with the ones on the server. This is often useful when multiple users are updating the same file set, as each can download the changes of the others. It is also useful for restoring local files to the base version after making trial changes.
  • (See the section on the 'Restore Command' for the full syntax and a more detailed description.)
• findkey <search-patt> <find-opts>

  fk <search-patt> <find-opts>

  where:

  <search-patt>

  :=

  <primary-string> [+ <secondary-string>]*

  <find-opts>

  :=

  -key | -k

  | -exact | -x

  | -head

  | -h

  | -edit

  | -e
  • Searches the chain of databases, comparing the dbrecs and dbrec headers for the given primary string, and displays any matches that it finds, subject to restrictions specified by other options.
  • If any secondary strings are specified, restricts matches to those values that also contain those strings as well. The secondary strings can match any other part of the dbrec or header, even if a restriction option is specified.
  • If the -key option is specified, only matches dbrecs whose 'key' field contains the primary string.
  • If the -exact option is specified, only matches dbrecs whose 'key' field is an exact match to the primary string.
  • If the -head option is specified, only matches dbrec headers.
  • If the -edit option is specified, invokes the default text editor on the file containing the match. Positions cursor to the line number of the match if the text editor supports it.
  • See the section on the 'Findkey Command' for a more detailed description.