#!/bin/cat #? NAME #? usage_examples - examples for advanced usage of o-saft.pl #? #? DESCRIPTION #? This file just contains examples and hints for advanced usage of #? o-saft.pl. #? ############################################################################### ### ### Command completion ### # Command and parameter completion exists for following shells: # # shell file to be used # -------+------------------------- # bash bash_completion_o-saft # fish fish_completion_o-saft # tcsh tcsh_completion_o-saft # -------+------------------------- # # These files are located in the contrib/ directory. For installing and using # them, please see the files itself and the shell's manual pages. ############################################################################### ### ### Postprocessing output ### # All output is designed to be easily parsed by postprocessors. For details # please see: o-saft.pl --help=OUTPUT o-saft.pl --help=RESULTS # For converting (postprocessing) the results to other formats, some filter # scripts are provided in the contrib/ directory. The usage i.g. is like: # o-saft.pl ... | contrib/filter-script # for example: o-saft.pl +cipher --header --enabled your.tld | contrib/HTML-table.awk # If you write your own filter script, it's probably best to use o-saft.pl's # --legacy=quick option, which separates label and value by a TAB character. # However, it should be still possible to parse the default format of the # results, which is: # Text of label: TABvalue # Where the : (colon) terminates the label text, which is followed by spaces # to align in columns, followed by a TAB character (aka \t aka 0x09) followed # by the value (the result). # # For practical examples, please see contrib/filter_examples . ############################################################################### ### ### Postprocessing output with colours ### # To colourize the results, the script contrib/bunt.pl (or contrib/bunt.sh) # can be used. It generates ANSI codes for the termnal. Example: o-saft.pl some.tld +check | contrib/bunt.pl # Sometimes colours need to be adapted, i.e. for red-green visual impairments # or when a light background is used. o-saft.pl some.tld +check | contrib/bunt.pl --blind o-saft.pl some.tld +check | contrib/bunt.pl --purple # If the "aha - Ansi HTML Adapter" (from https://github.com/theZiz/aha) is # available, the output can be converted to an HTML page: o-saft.pl some.tld +check | contrib/bunt.pl | aha -w -b -t "some.tld +check" > some.tld_check.html # If "ansi2html" is availabe (sometimes in package colorized-logs), output # can be converted to an HTML page: o-saft.pl some.tld +check | contrib/bunt.pl | ansi2html > some.tld_check.html ############################################################################### ### ### Beautify output ### # Replace values yes and no by character symbols. o-saft.pl some.tld +check | contrib/symbol.pl # Just print data from certificate o-saft.pl some.tld +info | contrib/Cert-beautify.pl ############################################################################### ### ### Generating a list with all possible commands ### o-saft.pl --help=cmd # same, but one command per line: o-saft.pl --help=cmd --norc | awk 'BEGIN{i=4}{while (i