diff --git a/.github/workflows/CD.yaml b/.github/workflows/CD.yaml index 3a6550ec..8fbc5caa 100644 --- a/.github/workflows/CD.yaml +++ b/.github/workflows/CD.yaml @@ -59,7 +59,7 @@ jobs: targets: ${{ matrix.target }} - name: Install cross if: ${{ matrix.use-cross }} - uses: taiki-e/install-action@v2.32.17 + uses: taiki-e/install-action@v2.32.20 with: tool: cross - name: Cache build artifacts diff --git a/Cargo.lock b/Cargo.lock index 05a504fd..8519b345 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -28,7 +28,7 @@ dependencies = [ [[package]] name = "abcrypt-cli" -version = "0.3.1" +version = "0.3.2" dependencies = [ "abcrypt", "anyhow", @@ -252,7 +252,7 @@ dependencies = [ "proc-macro-crate", "proc-macro2", "quote", - "syn 2.0.59", + "syn 2.0.60", "syn_derive", ] @@ -428,7 +428,7 @@ dependencies = [ "heck 0.5.0", "proc-macro2", "quote", - "syn 2.0.59", + "syn 2.0.60", ] [[package]] @@ -861,9 +861,9 @@ dependencies = [ [[package]] name = "proc-macro2" -version = "1.0.80" +version = "1.0.81" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a56dea16b0a29e94408b9aa5e2940a4eedbd128a1ba20e8f7ae60fd3d465af0e" +checksum = "3d1597b0c024618f09a9c3b8655b7e430397a36d23fdafec26d6965e9eec3eba" dependencies = [ "unicode-ident", ] @@ -935,7 +935,7 @@ dependencies = [ "proc-macro2", "pyo3-macros-backend", "quote", - "syn 2.0.59", + "syn 2.0.60", ] [[package]] @@ -948,7 +948,7 @@ dependencies = [ "proc-macro2", "pyo3-build-config", "quote", - "syn 2.0.59", + "syn 2.0.60", ] [[package]] @@ -1127,22 +1127,22 @@ checksum = "1c107b6f4780854c8b126e228ea8869f4d7b71260f962fefb57b996b8959ba6b" [[package]] name = "serde" -version = "1.0.197" +version = "1.0.198" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3fb1c873e1b9b056a4dc4c0c198b24c3ffa059243875552b2bd0933b1aee4ce2" +checksum = "9846a40c979031340571da2545a4e5b7c4163bdae79b301d5f86d03979451fcc" dependencies = [ "serde_derive", ] [[package]] name = "serde_derive" -version = "1.0.197" +version = "1.0.198" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7eb0b34b42edc17f6b7cac84a52a1c5f0e1bb2227e997ca9011ea3dd34e8610b" +checksum = "e88edab869b01783ba905e7d0153f9fc1a6505a96e4ad3018011eedb838566d9" dependencies = [ "proc-macro2", "quote", - "syn 2.0.59", + "syn 2.0.60", ] [[package]] @@ -1208,9 +1208,9 @@ dependencies = [ [[package]] name = "syn" -version = "2.0.59" +version = "2.0.60" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4a6531ffc7b071655e4ce2e04bd464c4830bb585a61cabb96cf808f05172615a" +checksum = "909518bc7b1c9b779f1bbf07f2929d35af9f0f37e47c6e9ef7f9dddc1e1821f3" dependencies = [ "proc-macro2", "quote", @@ -1226,7 +1226,7 @@ dependencies = [ "proc-macro-error", "proc-macro2", "quote", - "syn 2.0.59", + "syn 2.0.60", ] [[package]] @@ -1292,7 +1292,7 @@ checksum = "c61f3ba182994efc43764a46c018c347bc492c79f024e705f46567b418f6d4f7" dependencies = [ "proc-macro2", "quote", - "syn 2.0.59", + "syn 2.0.60", ] [[package]] @@ -1430,7 +1430,7 @@ dependencies = [ "once_cell", "proc-macro2", "quote", - "syn 2.0.59", + "syn 2.0.60", "wasm-bindgen-shared", ] @@ -1464,7 +1464,7 @@ checksum = "e94f17b526d0a461a191c78ea52bbce64071ed5c04c9ffe424dcb38f74171bb7" dependencies = [ "proc-macro2", "quote", - "syn 2.0.59", + "syn 2.0.60", "wasm-bindgen-backend", "wasm-bindgen-shared", ] @@ -1497,7 +1497,7 @@ checksum = "b7f89739351a2e03cb94beb799d47fb2cac01759b40ec441f7de39b00cbf7ef0" dependencies = [ "proc-macro2", "quote", - "syn 2.0.59", + "syn 2.0.60", ] [[package]] diff --git a/crates/abcrypt/Cargo.toml b/crates/abcrypt/Cargo.toml index 475d788a..39f09434 100644 --- a/crates/abcrypt/Cargo.toml +++ b/crates/abcrypt/Cargo.toml @@ -44,7 +44,7 @@ argon2 = { version = "0.5.3", default-features = false } blake2 = { version = "0.10.6", default-features = false } chacha20poly1305 = { version = "0.10.1", default-features = false, features = ["getrandom"] } rand = { version = "0.8.5", default-features = false, features = ["getrandom", "std_rng"] } -serde = { version = "1.0.197", default-features = false, features = ["derive"], optional = true } +serde = { version = "1.0.198", default-features = false, features = ["derive"], optional = true } [dev-dependencies] anyhow.workspace = true diff --git a/crates/capi/docs/man b/crates/capi/docs/man deleted file mode 120000 index bd22fe5f..00000000 --- a/crates/capi/docs/man +++ /dev/null @@ -1 +0,0 @@ -../../../docs/man \ No newline at end of file diff --git a/crates/capi/docs/man/man3 b/crates/capi/docs/man/man3 new file mode 120000 index 00000000..dc313d3d --- /dev/null +++ b/crates/capi/docs/man/man3 @@ -0,0 +1 @@ +../../../../docs/man/man3 \ No newline at end of file diff --git a/crates/cli/CHANGELOG.adoc b/crates/cli/CHANGELOG.adoc index e45a0a7d..10be7f6c 100644 --- a/crates/cli/CHANGELOG.adoc +++ b/crates/cli/CHANGELOG.adoc @@ -14,6 +14,13 @@ All notable changes to this project will be documented in this file. The format is based on https://keepachangelog.com/[Keep a Changelog], and this project adheres to https://semver.org/[Semantic Versioning]. +== {compare-url}/abcrypt-cli-v0.3.1\...abcrypt-cli-v0.3.2[0.3.2] - 2024-04-17 + +=== Changed + +* Change to remove unnecessary files from the book + ({pull-request-url}/382[#382]) + == {compare-url}/abcrypt-cli-v0.3.0\...abcrypt-cli-v0.3.1[0.3.1] - 2024-04-16 === Added diff --git a/crates/cli/Cargo.toml b/crates/cli/Cargo.toml index 377f53f1..a0b13c90 100644 --- a/crates/cli/Cargo.toml +++ b/crates/cli/Cargo.toml @@ -4,7 +4,7 @@ [package] name = "abcrypt-cli" -version = "0.3.1" +version = "0.3.2" authors.workspace = true edition.workspace = true rust-version.workspace = true diff --git a/crates/cli/docs/man b/crates/cli/docs/man deleted file mode 120000 index bd22fe5f..00000000 --- a/crates/cli/docs/man +++ /dev/null @@ -1 +0,0 @@ -../../../docs/man \ No newline at end of file diff --git a/crates/cli/docs/man/man1 b/crates/cli/docs/man/man1 new file mode 120000 index 00000000..13267a08 --- /dev/null +++ b/crates/cli/docs/man/man1 @@ -0,0 +1 @@ +../../../../docs/man/man1 \ No newline at end of file diff --git a/crates/cli/docs/man/man5 b/crates/cli/docs/man/man5 new file mode 120000 index 00000000..7730b16a --- /dev/null +++ b/crates/cli/docs/man/man5 @@ -0,0 +1 @@ +../../../../docs/man/man5 \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man b/docs/book/modules/capi/pages/man deleted file mode 120000 index c2d1339f..00000000 --- a/docs/book/modules/capi/pages/man +++ /dev/null @@ -1 +0,0 @@ -../../../../man \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/ABCRYPT_HEADER_SIZE.3.adoc b/docs/book/modules/capi/pages/man/man3/ABCRYPT_HEADER_SIZE.3.adoc new file mode 120000 index 00000000..20330b01 --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/ABCRYPT_HEADER_SIZE.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/ABCRYPT_HEADER_SIZE.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/ABCRYPT_TAG_SIZE.3.adoc b/docs/book/modules/capi/pages/man/man3/ABCRYPT_TAG_SIZE.3.adoc new file mode 120000 index 00000000..ae85a04e --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/ABCRYPT_TAG_SIZE.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/ABCRYPT_TAG_SIZE.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/abcrypt_decrypt.3.adoc b/docs/book/modules/capi/pages/man/man3/abcrypt_decrypt.3.adoc new file mode 120000 index 00000000..ab35572a --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/abcrypt_decrypt.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/abcrypt_decrypt.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/abcrypt_encrypt.3.adoc b/docs/book/modules/capi/pages/man/man3/abcrypt_encrypt.3.adoc new file mode 120000 index 00000000..db454330 --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/abcrypt_encrypt.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/abcrypt_encrypt.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/abcrypt_encrypt_with_params.3.adoc b/docs/book/modules/capi/pages/man/man3/abcrypt_encrypt_with_params.3.adoc new file mode 120000 index 00000000..8b5ab8de --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/abcrypt_encrypt_with_params.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/abcrypt_encrypt_with_params.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/abcrypt_error_code.3.adoc b/docs/book/modules/capi/pages/man/man3/abcrypt_error_code.3.adoc new file mode 120000 index 00000000..b69601b5 --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/abcrypt_error_code.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/abcrypt_error_code.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/abcrypt_error_message.3.adoc b/docs/book/modules/capi/pages/man/man3/abcrypt_error_message.3.adoc new file mode 120000 index 00000000..01b44d96 --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/abcrypt_error_message.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/abcrypt_error_message.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/abcrypt_error_message_out_len.3.adoc b/docs/book/modules/capi/pages/man/man3/abcrypt_error_message_out_len.3.adoc new file mode 120000 index 00000000..e5368b98 --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/abcrypt_error_message_out_len.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/abcrypt_error_message_out_len.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/abcrypt_params.3.adoc b/docs/book/modules/capi/pages/man/man3/abcrypt_params.3.adoc new file mode 120000 index 00000000..973b2eda --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/abcrypt_params.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/abcrypt_params.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/abcrypt_params_free.3.adoc b/docs/book/modules/capi/pages/man/man3/abcrypt_params_free.3.adoc new file mode 120000 index 00000000..942736ca --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/abcrypt_params_free.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/abcrypt_params_free.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/abcrypt_params_memory_cost.3.adoc b/docs/book/modules/capi/pages/man/man3/abcrypt_params_memory_cost.3.adoc new file mode 120000 index 00000000..1d714b0c --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/abcrypt_params_memory_cost.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/abcrypt_params_memory_cost.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/abcrypt_params_new.3.adoc b/docs/book/modules/capi/pages/man/man3/abcrypt_params_new.3.adoc new file mode 120000 index 00000000..e7467b63 --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/abcrypt_params_new.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/abcrypt_params_new.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/abcrypt_params_parallelism.3.adoc b/docs/book/modules/capi/pages/man/man3/abcrypt_params_parallelism.3.adoc new file mode 120000 index 00000000..b4a908bd --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/abcrypt_params_parallelism.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/abcrypt_params_parallelism.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/abcrypt_params_read.3.adoc b/docs/book/modules/capi/pages/man/man3/abcrypt_params_read.3.adoc new file mode 120000 index 00000000..0c26f392 --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/abcrypt_params_read.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/abcrypt_params_read.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/pages/man/man3/abcrypt_params_time_cost.3.adoc b/docs/book/modules/capi/pages/man/man3/abcrypt_params_time_cost.3.adoc new file mode 120000 index 00000000..75f63be7 --- /dev/null +++ b/docs/book/modules/capi/pages/man/man3/abcrypt_params_time_cost.3.adoc @@ -0,0 +1 @@ +../../../../../../man/man3/abcrypt_params_time_cost.3.adoc \ No newline at end of file diff --git a/docs/book/modules/capi/partials/man/man3/include b/docs/book/modules/capi/partials/man/man3/include new file mode 120000 index 00000000..b9940f7a --- /dev/null +++ b/docs/book/modules/capi/partials/man/man3/include @@ -0,0 +1 @@ +../../../../../../man/man3/include \ No newline at end of file diff --git a/docs/book/modules/cli/pages/man b/docs/book/modules/cli/pages/man deleted file mode 120000 index c2d1339f..00000000 --- a/docs/book/modules/cli/pages/man +++ /dev/null @@ -1 +0,0 @@ -../../../../man \ No newline at end of file diff --git a/docs/book/modules/cli/pages/man/man1/abcrypt-decrypt.1.adoc b/docs/book/modules/cli/pages/man/man1/abcrypt-decrypt.1.adoc new file mode 120000 index 00000000..097752b6 --- /dev/null +++ b/docs/book/modules/cli/pages/man/man1/abcrypt-decrypt.1.adoc @@ -0,0 +1 @@ +../../../../../../man/man1/abcrypt-decrypt.1.adoc \ No newline at end of file diff --git a/docs/book/modules/cli/pages/man/man1/abcrypt-encrypt.1.adoc b/docs/book/modules/cli/pages/man/man1/abcrypt-encrypt.1.adoc new file mode 120000 index 00000000..cd81ac51 --- /dev/null +++ b/docs/book/modules/cli/pages/man/man1/abcrypt-encrypt.1.adoc @@ -0,0 +1 @@ +../../../../../../man/man1/abcrypt-encrypt.1.adoc \ No newline at end of file diff --git a/docs/book/modules/cli/pages/man/man1/abcrypt-help.1.adoc b/docs/book/modules/cli/pages/man/man1/abcrypt-help.1.adoc new file mode 120000 index 00000000..de587841 --- /dev/null +++ b/docs/book/modules/cli/pages/man/man1/abcrypt-help.1.adoc @@ -0,0 +1 @@ +../../../../../../man/man1/abcrypt-help.1.adoc \ No newline at end of file diff --git a/docs/book/modules/cli/pages/man/man1/abcrypt-information.1.adoc b/docs/book/modules/cli/pages/man/man1/abcrypt-information.1.adoc new file mode 120000 index 00000000..ba8b34b3 --- /dev/null +++ b/docs/book/modules/cli/pages/man/man1/abcrypt-information.1.adoc @@ -0,0 +1 @@ +../../../../../../man/man1/abcrypt-information.1.adoc \ No newline at end of file diff --git a/docs/book/modules/cli/pages/man/man1/abcrypt.1.adoc b/docs/book/modules/cli/pages/man/man1/abcrypt.1.adoc new file mode 120000 index 00000000..38586ef4 --- /dev/null +++ b/docs/book/modules/cli/pages/man/man1/abcrypt.1.adoc @@ -0,0 +1 @@ +../../../../../../man/man1/abcrypt.1.adoc \ No newline at end of file diff --git a/docs/book/modules/cli/partials/man/man1/include b/docs/book/modules/cli/partials/man/man1/include new file mode 120000 index 00000000..164c2bd6 --- /dev/null +++ b/docs/book/modules/cli/partials/man/man1/include @@ -0,0 +1 @@ +../../../../../../man/man1/include \ No newline at end of file diff --git a/docs/man/man1/abcrypt-decrypt.1.adoc b/docs/man/man1/abcrypt-decrypt.1.adoc index 12de92f8..6ae4f8e2 100644 --- a/docs/man/man1/abcrypt-decrypt.1.adoc +++ b/docs/man/man1/abcrypt-decrypt.1.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt {revnumber}] ifndef::revnumber[:mansource: abcrypt] :manmanual: General Commands Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -70,9 +70,11 @@ _FILE_:: Print version number. The long flag (*--version*) will also print the copyright notice, the license notice and where to report bugs. -include::{includedir}/section-exit-status.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-exit-status.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-exit-status.adoc[]] -include::{includedir}/section-notes.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-notes.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-notes.adoc[]] == EXAMPLES @@ -92,9 +94,11 @@ Print the encryption parameters when decrypting:{blank}:: $ *abcrypt decrypt -v data.txt.abcrypt > data.txt* -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man1/abcrypt-encrypt.1.adoc b/docs/man/man1/abcrypt-encrypt.1.adoc index c4288329..c2d78a3f 100644 --- a/docs/man/man1/abcrypt-encrypt.1.adoc +++ b/docs/man/man1/abcrypt-encrypt.1.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt {revnumber}] ifndef::revnumber[:mansource: abcrypt] :manmanual: General Commands Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -93,9 +93,11 @@ _FILE_:: Print version number. The long flag (*--version*) will also print the copyright notice, the license notice and where to report bugs. -include::{includedir}/section-exit-status.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-exit-status.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-exit-status.adoc[]] -include::{includedir}/section-notes.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-notes.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-notes.adoc[]] == EXAMPLES @@ -119,9 +121,11 @@ Print the encryption parameters when encrypting:{blank}:: $ *abcrypt encrypt -v data.txt > data.txt.abcrypt* -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man1/abcrypt-help.1.adoc b/docs/man/man1/abcrypt-help.1.adoc index c240db19..c8fc9105 100644 --- a/docs/man/man1/abcrypt-help.1.adoc +++ b/docs/man/man1/abcrypt-help.1.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt {revnumber}] ifndef::revnumber[:mansource: abcrypt] :manmanual: General Commands Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -33,13 +33,17 @@ _COMMAND_:: Subcommand to print the help. -include::{includedir}/section-exit-status.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-exit-status.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-exit-status.adoc[]] -include::{includedir}/section-notes.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-notes.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-notes.adoc[]] -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man1/abcrypt-information.1.adoc b/docs/man/man1/abcrypt-information.1.adoc index 2e984237..c3c86598 100644 --- a/docs/man/man1/abcrypt-information.1.adoc +++ b/docs/man/man1/abcrypt-information.1.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt {revnumber}] ifndef::revnumber[:mansource: abcrypt] :manmanual: General Commands Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -50,9 +50,11 @@ endif::[] Print version number. The long flag (*--version*) will also print the copyright notice, the license notice and where to report bugs. -include::{includedir}/section-exit-status.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-exit-status.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-exit-status.adoc[]] -include::{includedir}/section-notes.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-notes.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-notes.adoc[]] == EXAMPLES @@ -66,9 +68,11 @@ Print the encryption parameters as JSON:{blank}:: $ *abcrypt information -j data.txt.abcrypt* endif::[] -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man1/abcrypt.1.adoc b/docs/man/man1/abcrypt.1.adoc index 744848cd..53423a04 100644 --- a/docs/man/man1/abcrypt.1.adoc +++ b/docs/man/man1/abcrypt.1.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt {revnumber}] ifndef::revnumber[:mansource: abcrypt] :manmanual: General Commands Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -84,13 +84,17 @@ abcrypt format. Zsh. -include::{includedir}/section-exit-status.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-exit-status.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-exit-status.adoc[]] -include::{includedir}/section-notes.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-notes.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-notes.adoc[]] -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man1/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/ABCRYPT_HEADER_SIZE.3.adoc b/docs/man/man3/ABCRYPT_HEADER_SIZE.3.adoc index 1f6971d6..35a274cc 100644 --- a/docs/man/man3/ABCRYPT_HEADER_SIZE.3.adoc +++ b/docs/man/man3/ABCRYPT_HEADER_SIZE.3.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -32,9 +32,11 @@ This constant represents the number of bytes of the header. This constant was added in version 0.1.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/ABCRYPT_TAG_SIZE.3.adoc b/docs/man/man3/ABCRYPT_TAG_SIZE.3.adoc index 3f949595..62071305 100644 --- a/docs/man/man3/ABCRYPT_TAG_SIZE.3.adoc +++ b/docs/man/man3/ABCRYPT_TAG_SIZE.3.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -33,9 +33,11 @@ the ciphertext. This constant was added in version 0.1.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/abcrypt_decrypt.3.adoc b/docs/man/man3/abcrypt_decrypt.3.adoc index 35f3e01d..061f4179 100644 --- a/docs/man/man3/abcrypt_decrypt.3.adoc +++ b/docs/man/man3/abcrypt_decrypt.3.adoc @@ -10,7 +10,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -77,9 +77,11 @@ defined in *abcrypt_error_code*(3). This function was added in version 0.1.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/abcrypt_encrypt.3.adoc b/docs/man/man3/abcrypt_encrypt.3.adoc index bb80097e..67a74063 100644 --- a/docs/man/man3/abcrypt_encrypt.3.adoc +++ b/docs/man/man3/abcrypt_encrypt.3.adoc @@ -10,7 +10,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] :owasp-cheatsheets: https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html == NAME @@ -80,9 +80,11 @@ defined in *abcrypt_error_code*(3). This function was added in version 0.1.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/abcrypt_encrypt_with_params.3.adoc b/docs/man/man3/abcrypt_encrypt_with_params.3.adoc index 137e14b1..608cde10 100644 --- a/docs/man/man3/abcrypt_encrypt_with_params.3.adoc +++ b/docs/man/man3/abcrypt_encrypt_with_params.3.adoc @@ -10,7 +10,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -93,9 +93,11 @@ defined in *abcrypt_error_code*(3). This function was added in version 0.1.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/abcrypt_error_code.3.adoc b/docs/man/man3/abcrypt_error_code.3.adoc index 25ffc2a8..ba86e886 100644 --- a/docs/man/man3/abcrypt_error_code.3.adoc +++ b/docs/man/man3/abcrypt_error_code.3.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -80,9 +80,11 @@ _ABCRYPT_ERROR_CODE_INVALID_MAC_:: This type was added in version 0.1.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/abcrypt_error_message.3.adoc b/docs/man/man3/abcrypt_error_message.3.adoc index cb881ead..b19ea9ce 100644 --- a/docs/man/man3/abcrypt_error_message.3.adoc +++ b/docs/man/man3/abcrypt_error_message.3.adoc @@ -10,7 +10,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -56,9 +56,11 @@ defined in *abcrypt_error_code*(3). This function was added in version 0.1.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/abcrypt_error_message_out_len.3.adoc b/docs/man/man3/abcrypt_error_message_out_len.3.adoc index 254ad89a..3c33aef3 100644 --- a/docs/man/man3/abcrypt_error_message_out_len.3.adoc +++ b/docs/man/man3/abcrypt_error_message_out_len.3.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -42,9 +42,11 @@ Returns the number of output bytes of the error message. This function was added in version 0.1.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/abcrypt_params.3.adoc b/docs/man/man3/abcrypt_params.3.adoc index 8d93a23b..ab98e7f6 100644 --- a/docs/man/man3/abcrypt_params.3.adoc +++ b/docs/man/man3/abcrypt_params.3.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -50,9 +50,11 @@ _parallelism_:: This type was added in version 0.1.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/abcrypt_params_free.3.adoc b/docs/man/man3/abcrypt_params_free.3.adoc index 14ff21d5..99b3c34f 100644 --- a/docs/man/man3/abcrypt_params_free.3.adoc +++ b/docs/man/man3/abcrypt_params_free.3.adoc @@ -10,7 +10,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -46,9 +46,11 @@ Returns nothing. This function was added in version 0.1.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/abcrypt_params_memory_cost.3.adoc b/docs/man/man3/abcrypt_params_memory_cost.3.adoc index dddb8c4f..36111fd5 100644 --- a/docs/man/man3/abcrypt_params_memory_cost.3.adoc +++ b/docs/man/man3/abcrypt_params_memory_cost.3.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -42,9 +42,11 @@ Returns `0` if `params` is `NULL`, otherwise returns the memory size in KiB. This function was added in version 0.3.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/abcrypt_params_new.3.adoc b/docs/man/man3/abcrypt_params_new.3.adoc index 3e254c6a..c4301c8c 100644 --- a/docs/man/man3/abcrypt_params_new.3.adoc +++ b/docs/man/man3/abcrypt_params_new.3.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -40,9 +40,11 @@ Returns a pointer to the Argon2 parameters structure. This function was added in version 0.1.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/abcrypt_params_parallelism.3.adoc b/docs/man/man3/abcrypt_params_parallelism.3.adoc index 702f4789..5b51241a 100644 --- a/docs/man/man3/abcrypt_params_parallelism.3.adoc +++ b/docs/man/man3/abcrypt_params_parallelism.3.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -42,9 +42,11 @@ Returns `0` if `params` is `NULL`, otherwise returns the degree of parallelism. This function was added in version 0.3.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/abcrypt_params_read.3.adoc b/docs/man/man3/abcrypt_params_read.3.adoc index 4b632885..449208e1 100644 --- a/docs/man/man3/abcrypt_params_read.3.adoc +++ b/docs/man/man3/abcrypt_params_read.3.adoc @@ -10,7 +10,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -56,9 +56,11 @@ defined in *abcrypt_error_code*(3). This function was added in version 0.1.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/abcrypt_params_time_cost.3.adoc b/docs/man/man3/abcrypt_params_time_cost.3.adoc index df14918a..8c6effcf 100644 --- a/docs/man/man3/abcrypt_params_time_cost.3.adoc +++ b/docs/man/man3/abcrypt_params_time_cost.3.adoc @@ -9,7 +9,7 @@ ifdef::revnumber[:mansource: abcrypt-capi {revnumber}] ifndef::revnumber[:mansource: abcrypt-capi] :manmanual: Library Functions Manual -:includedir: ./include +ifndef::site-gen-antora[:includedir: ./include] == NAME @@ -42,9 +42,11 @@ Returns `0` if `params` is `NULL`, otherwise returns the number of iterations. This function was added in version 0.3.0. -include::{includedir}/section-reporting-bugs.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-reporting-bugs.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-reporting-bugs.adoc[]] -include::{includedir}/section-copyright.adoc[] +ifndef::site-gen-antora[include::{includedir}/section-copyright.adoc[]] +ifdef::site-gen-antora[include::partial$man/man3/include/section-copyright.adoc[]] == SEE ALSO diff --git a/docs/man/man3/include/section-reporting-bugs.adoc b/docs/man/man3/include/section-reporting-bugs.adoc deleted file mode 100644 index f48d7801..00000000 --- a/docs/man/man3/include/section-reporting-bugs.adoc +++ /dev/null @@ -1,9 +0,0 @@ -// SPDX-FileCopyrightText: 2022 Shun Sakai -// -// SPDX-License-Identifier: CC-BY-4.0 - -== REPORTING BUGS - -Report bugs to:{blank}:: - - https://github.com/sorairolake/abcrypt/issues diff --git a/docs/man/man3/include/section-reporting-bugs.adoc b/docs/man/man3/include/section-reporting-bugs.adoc new file mode 120000 index 00000000..86dcdef5 --- /dev/null +++ b/docs/man/man3/include/section-reporting-bugs.adoc @@ -0,0 +1 @@ +../../man1/include/section-reporting-bugs.adoc \ No newline at end of file