SYSDOC(8) SYSDOC(8) NAME sysdoc - create system documentation (Version 0.994-Rel.8) SYNOPSIS sysdoc [-c] [-h] [-V] [-x set,set,...] OPTIONS -c The option -c (cleanup) will cause a removal of any /tmp/sys- doc*-file -h The option -h (or --help) displays help. -V shows the version and codename (in '') of sysdoc (does nothing else) -x set,... means "exclusion" of an info-set (-x ? or -x L gives a list of valid sets). This option can be used if sysdoc unfortunately hangs w/in a set (then abort w/ "^C" and restart sysdoc w/ parameters -c -x set) Note: if you encounter such a situation, please give us a hint (sysdoc...tgz ;-) or minimum the OS ver- sion included) via email. We like to prevent you from that in the future. DESCRIPTION sysdoc puts some informations of the installed OS into a "tgz"-file. A sysdoc run takes two parts: 1. it runs sitar(1), if it is installed 2. it collects (hopefully) most of the relevant system-files/states (if not excluded via -x) and even link-targets of collected files sysdoc grabs some important files and stores them in the "tgz" with full pathname, so you can find any relevant info about the installed system (if you know where to search) later in the "tgz". This "tgz"-ar- chive could be read very well w/out unpacking via Konqueror (and also w/ Winzp-like software under Windows). The fullpathes gives you the ability to restore the archived system-files in a subtree. From that subtree it should not be difficult to restore them to the real system (e.g. with find(1)). May be, in a later version of sysdoc there is an option to do that..... All gathered infos (which are held in .txt-files under /doc of the "tgz"), all collected system files (w/ fullpath), the sitar-output (if any), the README and the logfile (which contains the output from the current sysdoc-run) are put together into the "tgz". This archive is then stored w/ system-name and time and date of the run under /tmp. (The file name is reported at the end of the run) sysdoc also includes the directory $HOME/doc. So, if you miss some information in the implemented funtionality, you can place this info within this dir, to be included into the "tgz" (path name in the "tgz" is typically /root/doc). Supported architectures are: x86, x86-64, AMD64, IPF (aka ia64), Blade- Frame (cBlade) Unfortunately sysdoc just works fine with the SuSE/Novell-flavour of Linux only. It is tested with SuSE/Novell SLES 8/9/10/11, OpenSuSE 10.x/11.x and XEN based systems. The RH2.1 and later (RHEL4) running w/in BladeFrame-cBlades is also supported (most OS-features). For future versions it is planed to cover RedHat and Debian too. (yes, it works on those distributions, but some information is not gathered correctly if locations of config-files differ from SuSE) Some commands which are used by sysdoc are not available in all distri- butions. So some infos could not be retrieved sometimes. The output (and the log; see FILES below) will report this. For a most complete list of gathered information, please have a look at the README-file under .../doc/packages/sysdoc. ENVIRONMENT n.a. EXAMPLE As easy as can be: # sysdoc or, in case of hanging (for example w/in ---sysfs---): # sysdoc -x sysfs HINTS · Any info that sysdoc will not collect by its own, can be also archived within the "tgz" by placing the info in a file w/in a directory named "~/doc". · You should be "root" in order to invoke sysdoc! · Because Windows has problems w/ real long path/file-names and spe- cial characters like ":" there is a good chance to gain somes popups w/ e.g. Winzip if the "tgz" includes an PCS-dump. You can OK-them blind. As a result the file-list will not contain files w/ very long names. But if you unpack the archive, all files are put to filesys- tem (in most cases). Of course Linux has no Problem w/ that ;-) FILES /tmp/sysdoc_-YYYYMMDD-HHMM.tgz the "tgz"-archive /usr/share/doc/packages/sysdoc/README some additional info to sysdoc, also packed into every "tgz" /usr/share/doc/packages/sysdoc/CHANGES changelog of sysdoc /usr/share/doc/packages/sysdoc/AUTHORS the people how built sysdoc /usr/share/doc/packages/sysdoc/LICENSE license text /usr/share/doc/packages/sysdoc/COPYING copying info /usr/share/doc/packages/sysdoc/sysdoc_man8.txt sysdocs man page in plain text format /usr/share/man/man8/sysdoc.8.gz sysdocs man page /usr/sbin/sysdoc sysdoc script itself /usr/sbin/patchstr a sysdoc helper program (do "man patchstr" to get more info) SEE ALSO sitar(1) BUGS surely ;-) , please feel free to report all of them to me. LICENSE sysdoc is licensed under the GPL V2 AUTHOR christopher "csh" schnirch DOWNLOAD http://www.sysdoc.de September 22, 2018 SYSDOC(8)