chainlib

Generic blockchain access library and tooling
Info | Log | Files | Refs | README | LICENSE

chainlib-gen.groff (1569B)


      1 .TH chainlib-gen 1
      2 
      3 .SH NAME
      4 chainlib-gen \- Generate bytecode and arguments from modules implementing chainlib
      5 
      6 
      7 .SH SYNOPSIS
      8 
      9 .SY chainlib-gen
     10 -l
     11 .YS
     12 
     13 .SY chainlib-gen
     14 <module> <command> -k
     15 .YS
     16 
     17 .SY chainlib-gen
     18 <module> <command> [args...]
     19 .YS
     20 
     21 
     22 .SH DESCRIPTION
     23 .P
     24 chainlib-gen can be used to generate inputs necessary for publishing executable code for blockchain environments.
     25 .P
     26 A python module is considered to support chainlib-gen if the file \fI<package_dir>/data/.chainlib\fP exists.
     27 
     28 
     29 .SH Top-level options
     30 
     31 .TP
     32 .TQ
     33 .B -h
     34 .TQ
     35 .B --help
     36 Command help summary.
     37 
     38 .TP
     39 .B -v
     40 Verbose logging
     41 
     42 .TP
     43 .B -vv
     44 Very verbose logging
     45 
     46 
     47 .TP
     48 .B -l
     49 List supported module names
     50 
     51 
     52 .SH DISCOVERING MODULES
     53 .P
     54 Using the \fI-l\fP flag, chainlib-gen will list the names all supporing modules found in its search path.
     55 
     56 
     57 .SH Command options
     58 .P
     59 A supporting module will implement one or more commands.
     60 
     61 .TP
     62 \fB-k\fP
     63 List required and optional arguments for <command> under <module>.
     64 
     65 
     66 .SH KNOWN ISSUES
     67 .P
     68 Currently there is no way except reading module code to discover which module commands are available.
     69 
     70 
     71 .SH LICENSE
     72 
     73 This documentation and its source is licensed under the Creative Commons Attribution-Sharealike 4.0 International license.
     74 
     75 The source code of the tool this documentation describes is licensed under the Affero GNU General Public License 3.0.
     76 
     77 
     78 .SH COPYRIGHT AND CONTACT
     79 
     80 .MT dev@holbrook.no
     81 Louis Holbrook
     82 .ME
     83 
     84 .UR https://holbrook.no
     85 .UE https://holbrook.no
     86 
     87 .P
     88 PGP: 59A844A484AC11253D3A3E9DCDCBD24DD1D0E001
     89 
     90 
     91 .SH SOURCE CODE
     92 
     93 https://git.defalsify.org/chainlib