From 5a0e481e9b728567cb6dd00cdf262df58122aefa Mon Sep 17 00:00:00 2001 From: Alexander Molchevsky Date: Fri, 14 Apr 2023 17:26:34 +0300 Subject: [PATCH 1/2] cdt-ld man page created --- docs/man/cdt-ld.1 | 215 +++++++++++++++++++++++++++++++++++++++++++ docs/man/cdt-ld.1.md | 127 +++++++++++++++++++++++++ docs/man/make_man.sh | 7 +- 3 files changed, 346 insertions(+), 3 deletions(-) create mode 100644 docs/man/cdt-ld.1 create mode 100644 docs/man/cdt-ld.1.md diff --git a/docs/man/cdt-ld.1 b/docs/man/cdt-ld.1 new file mode 100644 index 0000000000..a7071fec5f --- /dev/null +++ b/docs/man/cdt-ld.1 @@ -0,0 +1,215 @@ +.\" Automatically generated by Pandoc 2.5 +.\" +.TH "CDT\-LD" "1" "April 13, 2023" "AntelopeIO" "User Manual" +.hy +.SH NAME +.PP +cdt\-ld \- Antelope smart contract WebAssembly linker +.SH SYNOPSIS +.PP +\f[C]cdt\-ld [options] \f[R] +.SH DESCRIPTION +.PP +\f[B]cdt\-ld\f[R] Is a compiled smart contract linker which creates +WebAssemply code for execution in Antelope block chain virtual machines. +.SH OPTIONS +.PP +\f[B]\f[CB]\-L=\f[B]\f[R] +.IP +.nf +\f[C] +Add directory to library search path +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-abi\-version=\f[B]\f[R] +.IP +.nf +\f[C] +Which ABI version to generate +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-allow\-names\f[B]\f[R] +.IP +.nf +\f[C] +Allows name section to be created +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-fasm\f[B]\f[R] +.IP +.nf +\f[C] +Assemble file for x86\-64 +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-fnative\f[B]\f[R] +.IP +.nf +\f[C] +Compile and link for x86\-64 +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-fno\-cfl\-aa\f[B]\f[R] +.IP +.nf +\f[C] +Disable CFL Alias Analysis +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-fno\-lto\f[B]\f[R] +.IP +.nf +\f[C] +Disable LTO +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-fno\-post\-pass\f[B]\f[R] +.IP +.nf +\f[C] +Don\[aq]t run post processing pass +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-fno\-stack\-first\f[B]\f[R] +.IP +.nf +\f[C] +Don\[aq]t set the stack first in memory +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-fquery\f[B]\f[R] +.IP +.nf +\f[C] +Produce binaries for wasmql +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-fquery\-client\f[B]\f[R] +.IP +.nf +\f[C] +Produce binaries for wasmql +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-fquery\-server\f[B]\f[R] +.IP +.nf +\f[C] +Produce binaries for wasmql +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-fuse\-main\f[B]\f[R] +.IP +.nf +\f[C] +Use main as entry +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-help\f[B]\f[R] +.IP +.nf +\f[C] +Display available options (\-\-help\-hidden for more) +\f[R] +.fi +.PP +\f[B]\f[CB]\-l=\f[B]\f[R] +.IP +.nf +\f[C] +Root name of library to link +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-lto\-opt=\f[B]\f[R] +.IP +.nf +\f[C] +LTO Optimization level (O0\-O3) +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-mllvm=\f[B]\f[R] +.IP +.nf +\f[C] +Pass arguments to llvm +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-no\-abigen\f[B]\f[R] +.IP +.nf +\f[C] +Disable ABI file generation +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-no\-missing\-ricardian\-clause\f[B]\f[R] +.IP +.nf +\f[C] +Disable warnings for missing Ricardian clauses +\f[R] +.fi +.PP +\f[B]\f[CB]\-o=\f[B]\f[R] +.IP +.nf +\f[C] +Write output to +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-shared\f[B]\f[R] +.IP +.nf +\f[C] +Make shared object native library +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-stack\-canary\f[B]\f[R] +.IP +.nf +\f[C] +Stack canary for non stack first layouts +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-stack\-size=\f[B]\f[R] +.IP +.nf +\f[C] +Specifies the maximum stack size for the contract. Defaults to 8192 bytes +\f[R] +.fi +.PP +\f[B]\f[CB]\-\-version\f[B]\f[R] +.IP +.nf +\f[C] +Display the version of this program +\f[R] +.fi +.SH BUGS +.PP +Please submit bug reports online at +https://github.com/AntelopeIO/cdt/issues +.SH SEE ALSO +.PP +For more details consult the full documentation and sources +https://github.com/AntelopeIO/cdt diff --git a/docs/man/cdt-ld.1.md b/docs/man/cdt-ld.1.md new file mode 100644 index 0000000000..6895789891 --- /dev/null +++ b/docs/man/cdt-ld.1.md @@ -0,0 +1,127 @@ +--- +title: CDT-LD +section: 1 +header: User Manual +footer: AntelopeIO +date: April 14, 2023 +--- +# NAME +cdt-ld - Antelope smart contract WebAssembly linker + +# SYNOPSIS + +`cdt-ld [options] ` + +# DESCRIPTION + +**cdt-ld** Is a compiled smart contract linker which creates WebAssemply code for +execution in Antelope block chain virtual machines. + +# OPTIONS + +**`-L=`** + + Add directory to library search path + +**`--abi-version=`** + + Which ABI version to generate + +**`--allow-names`** + + Allows name section to be created + +**`--fasm`** + + Assemble file for x86-64 + +**`--fnative`** + + Compile and link for x86-64 + +**`--fno-cfl-aa`** + + Disable CFL Alias Analysis + +**`--fno-lto`** + + Disable LTO + +**`--fno-post-pass`** + + Don't run post processing pass + +**`--fno-stack-first`** + + Don't set the stack first in memory + +**`--fquery`** + + Produce binaries for wasmql + +**`--fquery-client`** + + Produce binaries for wasmql + +**`--fquery-server`** + + Produce binaries for wasmql + +**`--fuse-main`** + + Use main as entry + +**`--help`** + + Display available options (--help-hidden for more) + +**`-l=`** + + Root name of library to link + +**`--lto-opt=`** + + LTO Optimization level (O0-O3) + +**`--mllvm=`** + + Pass arguments to llvm + +**`--no-abigen`** + + Disable ABI file generation + +**`--no-missing-ricardian-clause`** + + Disable warnings for missing Ricardian clauses + +**`-o=`** + + Write output to + +**`--shared`** + + Make shared object native library + +**`--stack-canary`** + + Stack canary for non stack first layouts + +**`--stack-size=`** + + Specifies the maximum stack size for the contract. Defaults to 8192 bytes + +**`--version`** + + Display the version of this program + + +# BUGS + +Please submit bug reports online at https://github.com/AntelopeIO/cdt/issues + +# SEE ALSO + +For more details consult the full documentation and sources https://github.com/AntelopeIO/cdt + + diff --git a/docs/man/make_man.sh b/docs/man/make_man.sh index b2dc811f5a..0a413a4f24 100755 --- a/docs/man/make_man.sh +++ b/docs/man/make_man.sh @@ -1,3 +1,4 @@ -#!/bin/sh - -pandoc cdt-cpp.1.md -s -t man -o cdt-cpp.1 +#!/bin/bash +for file in cdt-*.1.md; do + pandoc "$file" -s -t man -o "${file%.md}" +done From 968f4a7822893081036543a0d98a35299c438f7e Mon Sep 17 00:00:00 2001 From: Alexander Molchevsky Date: Mon, 17 Apr 2023 13:51:27 +0300 Subject: [PATCH 2/2] The headers changed --- docs/man/cdt-cpp.1 | 2 +- docs/man/cdt-cpp.1.md | 2 +- docs/man/cdt-ld.1 | 2 +- docs/man/cdt-ld.1.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/man/cdt-cpp.1 b/docs/man/cdt-cpp.1 index 0ae663c738..b72d51c7fa 100644 --- a/docs/man/cdt-cpp.1 +++ b/docs/man/cdt-cpp.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.5 .\" -.TH "CDT\-CPP" "1" "April 08, 2023" "AntelopeIO" "User Manual" +.TH "CDT\-CPP" "1" "April 08, 2023" "AntelopeIO" "Contract Development Toolkit (CDT)" .hy .SH NAME .PP diff --git a/docs/man/cdt-cpp.1.md b/docs/man/cdt-cpp.1.md index 13c0f950fc..95587afd0a 100644 --- a/docs/man/cdt-cpp.1.md +++ b/docs/man/cdt-cpp.1.md @@ -1,7 +1,7 @@ --- title: CDT-CPP section: 1 -header: User Manual +header: Contract Development Toolkit (CDT) footer: AntelopeIO date: April 08, 2023 --- diff --git a/docs/man/cdt-ld.1 b/docs/man/cdt-ld.1 index a7071fec5f..2f9f470ec0 100644 --- a/docs/man/cdt-ld.1 +++ b/docs/man/cdt-ld.1 @@ -1,6 +1,6 @@ .\" Automatically generated by Pandoc 2.5 .\" -.TH "CDT\-LD" "1" "April 13, 2023" "AntelopeIO" "User Manual" +.TH "CDT\-LD" "1" "April 14, 2023" "AntelopeIO" "Contract Development Toolkit (CDT)" .hy .SH NAME .PP diff --git a/docs/man/cdt-ld.1.md b/docs/man/cdt-ld.1.md index 6895789891..7063e871bc 100644 --- a/docs/man/cdt-ld.1.md +++ b/docs/man/cdt-ld.1.md @@ -1,7 +1,7 @@ --- title: CDT-LD section: 1 -header: User Manual +header: Contract Development Toolkit (CDT) footer: AntelopeIO date: April 14, 2023 ---