diff options
| -rw-r--r-- | Makefile.am | 2 | ||||
| -rw-r--r-- | configure.ac | 1 | ||||
| -rw-r--r-- | doc/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/chrysalide.1 | 78 |
4 files changed, 84 insertions, 1 deletions
diff --git a/Makefile.am b/Makefile.am index 0b2a436..3a73461 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,6 @@ EXTRA_DIST = config.rpath ChangeLog gettext.h i18n.h -SUBDIRS = tools pixmaps src plugins po themes +SUBDIRS = doc tools pixmaps src plugins po themes ACLOCAL_AMFLAGS = -I m4 diff --git a/configure.ac b/configure.ac index 0d48687..cfaad8c 100644 --- a/configure.ac +++ b/configure.ac @@ -335,6 +335,7 @@ AC_CONFIG_FILES([stamp-h po/Makefile.in], [echo timestamp > stamp-h]) AC_CONFIG_COMMANDS([marshal], [echo -e "VOID:UINT64\nVOID:INT,UINT64,INT\nVOID:OBJECT,OBJECT\nVOID:ENUM,OBJECT\nVOID:ENUM,ENUM\nVOID:BOOLEAN,UINT64\nVOID:BOOLEAN,ULONG,ULONG\nVOID:INT,INT\nVOID:OBJECT,BOOLEAN\nVOID:ULONG,BOOLEAN" > src/glibext/chrysamarshal.list]) AC_CONFIG_FILES([Makefile + doc/Makefile pixmaps/Makefile plugins/Makefile plugins/arm/Makefile diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..94b25ff --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,4 @@ + +man_MANS = chrysalide.1 + +EXTRA_DIST = $(man_MANS) diff --git a/doc/chrysalide.1 b/doc/chrysalide.1 new file mode 100644 index 0000000..41fabc0 --- /dev/null +++ b/doc/chrysalide.1 @@ -0,0 +1,78 @@ +.TH chrysalide 1 "September 1 2018" "Version 1" "Chrysalide Manual Pages" + +.SH NAME +Chrysalide - a reverse-engineering factory. + +.SH SYNOPSIS +.B chrysalide +[options] [filename] [filename...] + +.SH DESCRIPTION +Chrysalide is a fast tool collection for binary analysis. + +It is written using the GTK+ toolkit and support several file formats and architectures. + +Python bindings are also available. + +.SH OPTIONS +Chrysalide accepts the following options: + +.TP 8 +.B \-h, \-\-help +Show Chrysalide command\-line options. + +.TP 8 +.B \-v, \-\-version +Display the program version. + +.TP 8 +.B \-V, \-\-verbosity=level +Set the log level (0 for all messages, 5 for none). + +.TP 8 +.B \-b, \-\-batch +Exit after processing files. + +.TP 8 +.B \-s, \-\-save +Save disassembly cache after analysis in batch mode (ignored in normal mode). + +.TP 8 +.B \-p, \-\-project=filename +Open an existing project or create a new one. + +.SH FILES + +.TP 8 +.B $HOME/.config/chrysalide/cache/ +Location of cache created for processed binaries. + +.TP 8 +.B $HOME/.config/chrysalide/cdbs/ +Location of Chrysalide Databases storing the configuration of each loaded binaries. + +.TP 8 +.B $HOME/.config/chrysalide/id_rsa.priv +.TQ 8 +.B $HOME/.config/chrysalide/id_rsa.pub +.TQ 8 +.B $HOME/.config/chrysalide/clients/ +.TQ 8 +.B $HOME/.config/chrysalide/servers/ +Credentials used to share information about processed analysis. + +.SH FEATURE REQUESTS AND BUG REPORTS + +Any bugs found should be reported to the online bug-tracking system +available at https://bugs.chrysalide.re/. + +New features should also be requested using the same system. + +Before reporting or requesting, please check the current list in order +to avoid duplications. + +When reporting bugs, it is important to include a reliable way to +reproduce the bugs. + +.SH AUTHORS +Cyrille BAGARD. |