cdt-ld man page created

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] <input file>\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=<string>\f[B]\f[R]
+.IP
+.nf
+\f[C]
+Add directory to library search path
+\f[R]
+.fi
+.PP
+\f[B]\f[CB]\-\-abi\-version=<string>\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=<string>\f[B]\f[R]
+.IP
+.nf
+\f[C]
+Root name of library to link
+\f[R]
+.fi
+.PP
+\f[B]\f[CB]\-\-lto\-opt=<string>\f[B]\f[R]
+.IP
+.nf
+\f[C]
+LTO Optimization level (O0\-O3)
+\f[R]
+.fi
+.PP
+\f[B]\f[CB]\-\-mllvm=<string>\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=<string>\f[B]\f[R]
+.IP
+.nf
+\f[C]
+Write output to <file>
+\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=<int>\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

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] <input file>`
+
+# DESCRIPTION
+
+**cdt-ld** Is a compiled smart contract linker which creates WebAssemply code for 
+execution in Antelope block chain virtual machines. 
+
+# OPTIONS
+
+**`-L=<string>`**
+
+ Add directory to library search path
+
+**`--abi-version=<string>`**
+
+ 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=<string>`**
+
+ Root name of library to link
+
+**`--lto-opt=<string>`**
+
+ LTO Optimization level (O0-O3)
+
+**`--mllvm=<string>`**
+
+ Pass arguments to llvm
+
+**`--no-abigen`**
+
+ Disable ABI file generation
+
+**`--no-missing-ricardian-clause`**
+
+ Disable warnings for missing Ricardian clauses
+
+**`-o=<string>`**
+
+ Write output to <file>
+
+**`--shared`**
+
+ Make shared object native library
+
+**`--stack-canary`**
+
+ Stack canary for non stack first layouts
+
+**`--stack-size=<int>`**
+
+ 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
+
+

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