From 3f3ae9df62d82b0c213502d817eb7c62d59fa55c Mon Sep 17 00:00:00 2001 From: wesleyleite <1591080+wesleyleite@users.noreply.github.com> Date: Sat, 5 Mar 2022 15:15:18 -0300 Subject: [PATCH] issue #46 update documentation programming --- doc/source/programming.rst | 83 +++++++++++++++++++++++++++++++++++++- 1 file changed, 82 insertions(+), 1 deletion(-) diff --git a/doc/source/programming.rst b/doc/source/programming.rst index 088e85f..05a5e3f 100644 --- a/doc/source/programming.rst +++ b/doc/source/programming.rst @@ -19,13 +19,65 @@ Generates on the standard output ``C`` skeleton. $ bh_skel_c #include - int main(int argc, char *argv[]) { + int main(int argc, char ***argv[]**) { return 0; } +bh_skel_go +--------- +Generates on the standard output ``go`` skeleton. + +.. note:: + + Usage + + ``bh_skel_go`` + +.. code-block:: bash + + $ bh_skel_go + package main + + import ( + "fmt" + ) + + func main() { + + fmt.Println("test") + } + + +bh_skel_latex +--------- +Generates on the standard output ``latex`` skeleton. + +.. note:: + + Usage + + ``bh_skel_latex`` +.. code-block:: bash + + $ bh_skel_latex + \documentclass{article} + + \usepackage[english]{babel} + \usepackage[utf8]{inputenc} + \usepackage[margin=1in]{geometry} + + \author{} + \title{} + + \begin{document} + \maketitle + + \end{document} + + bh_skel_python -------------- @@ -46,4 +98,33 @@ Generates on the standard output ``python`` skeleton. if __name__ == '__main__': +bh_skel_yara +-------------- + +Generates on the standard output ``yara`` skeleton. + +.. note:: + + Usage + + ``bh_skel_yara`` + +.. code-block:: bash + + $ bh_skel_yara + rule test { + meta: + author = "mb" + description = "" + date = "2022-03-03" + ref = "" + hash = "" + + strings: + $a = "test" ascii wide + + condition: + all of them + } +