Dogcows Code - chaz/groupsecret/blob - README.md

   1 # NAME
   2
   3 App::GroupSecret - A simple tool for maintaining a shared group secret
   4
   5 # VERSION
   6
   7 version 0.300
   8
   9 # DESCRIPTION
  10
  11 This module is part of the command-line interface for managing keyfiles.
  12
  13 See [groupsecret](https://metacpan.org/pod/groupsecret) for documentation.
  14
  15 # METHODS
  16
  17 ## new
  18
  19     $script = App::GroupSecret->new;
  20
  21 Construct a new script object.
  22
  23 ## main
  24
  25     $script->main(@ARGV);
  26
  27 Run a command with the given command-line arguments.
  28
  29 ## filepath
  30
  31     $filepath = $script->filepath;
  32
  33 Get the path to the keyfile.
  34
  35 ## file
  36
  37     $file = $script->file;
  38
  39 Get the [App::GroupSecret::File](https://metacpan.org/pod/App::GroupSecret::File) instance for the keyfile.
  40
  41 ## private\_key
  42
  43     $filepath = $script->private_key;
  44
  45 Get the path to a private key used to decrypt the keyfile.
  46
  47 # BUGS
  48
  49 Please report any bugs or feature requests on the bugtracker website
  50 [https://github.com/chazmcgarvey/groupsecret/issues](https://github.com/chazmcgarvey/groupsecret/issues)
  51
  52 When submitting a bug or request, please include a test-file or a
  53 patch to an existing test-file that illustrates the bug or desired
  54 feature.
  55
  56 # AUTHOR
  57
  58 Charles McGarvey <chazmcgarvey@brokenzipper.com>
  59
  60 # COPYRIGHT AND LICENSE
  61
  62 This software is Copyright (c) 2017 by Charles McGarvey.
  63
  64 This is free software, licensed under:
  65
  66     The MIT (X11) License