Module: xenomai-2.6 Branch: master Commit: 69f6cb5ec287afff5ab197528d9eb1177f6de6d6 URL: http://git.xenomai.org/?p=xenomai-2.6.git;a=commit;h=69f6cb5ec287afff5ab197528d9eb1177f6de6d6
Author: Gilles Chanteperdrix <gilles.chanteperd...@xenomai.org> Date: Sun Jun 9 11:58:42 2013 +0200 doc: small updates in manual pages --- doc/man/latency.adoc | 4 +++- doc/man/switchtest.adoc | 5 +++-- doc/man/xeno-config.adoc | 35 ++++++++++++++++++++++++++--------- 3 files changed, 32 insertions(+), 12 deletions(-) diff --git a/doc/man/latency.adoc b/doc/man/latency.adoc index 9668966..ea8fb97 100644 --- a/doc/man/latency.adoc +++ b/doc/man/latency.adoc @@ -39,7 +39,9 @@ OPTIONS print histograms of min, avg, max latencies *-g <file>*:: -dump histogram to <file> in gnuplot format +dump histogram to <file> in a format easily readable with gnuplot. An +example script for gnuplot may be found in scripts/histo.gp in Xenomai +sources distribution *-s*:: print statistics of min, avg, max latencies diff --git a/doc/man/switchtest.adoc b/doc/man/switchtest.adoc index 6faf62b..8a2f539 100644 --- a/doc/man/switchtest.adoc +++ b/doc/man/switchtest.adoc @@ -37,7 +37,7 @@ OPTIONS -------- Each threadspec specifies the characteristics of a thread to be created: -threadspec = (rtk|rtup|rtus|rtuo)(_fp|_ufpp|_ufps)*[0-9]* +threadspec = (rtk|rtup|rtus|rtuo)(_fp|_ufpp|_ufps)\*[0-9]* *rtk*:: for a kernel-space real-time thread @@ -60,7 +60,8 @@ means that the created thread will use the FPU when in primary mode\n(invalid fo *_ufps*:: means that the created thread will use the FPU when in secondary mode (invalid for rtk and rtup) -*"[0-9]\*" specifies the ID of the CPU where the created thread will run, 0 if unspecified*:: +*[0-9]*:: +specifies the ID of the CPU where the created thread will run, 0 if unspecified Passing no *threadspec* diff --git a/doc/man/xeno-config.adoc b/doc/man/xeno-config.adoc index 4ce6fdd..14cc06b 100644 --- a/doc/man/xeno-config.adoc +++ b/doc/man/xeno-config.adoc @@ -29,7 +29,7 @@ SYNOPSIS *xeno-config --help*:: -*xeno-config* [*--version*] [*--cc*] [*--arch*] [*--prefix*] [*--xeno-cflags*] [*--xeno-ldflags*] [*--posix-cflags*] [*--posix-ldflags*] [*--lib*-dir*|*--library-dir*|*--libdir*|*--user-libdir*] +*xeno-config* [*--version*] [*--cc*] [*--arch*] [*--prefix*] [*--skin native|posix|psos|rtdm|uitron|vrtx|vxworks*] [*--cflags*] [*--ldflags*] [*--lib***-dir*|*--library-dir*|*--libdir*|*--user-libdir*] DESCRIPTION ------------ @@ -65,24 +65,41 @@ May be different from the architecture of the currently running system, if cross *--prefix*:: Outputs one line with the absolute path to the base Xenomai installation directory. +*--skin*:: +Choose the skin for which xeno-config should print the compilation flags. + +*--cflags*:: +Outputs one line with the C compiler command-line options that are necessary to compile applications that use the Xenomai skin passed to the *--skin* option. + +*--ldflags*:: +Outputs one line with the C compiler command-line options that are necessary to link applications that use the Xenomai skin passed to the *--skin* option with the necessary libraries. + + +*--lib***-dir, --library-dir, --libdir, --user-libdir*:: +Outputs one line with the absolute path to Xenomai's libraries. +In the --lib*-dir option name, the *** is meant as a wildcard: *--lib-dir*, *--libfoo-dir* and *--libbar-dir* are all valid and synonymous options. + +DEPRECATED OPTIONS +------------------ + *--xeno-cflags*:: -Outputs one line with the C compiler command-line options that are necessary to compile applications that use the Xenomai libraries. +This option is deprecated, please use *--skin* and *--cflags* instead. +Outputs one line with the C compiler command-line options that are necessary to compile applications that use any Xenomai skin, except the posix skin. *--xeno-ldflags*:: -Outputs one line with the C compiler command-line options that are necessary to link applications against the Xenomai libraries. +This option is deprecated, please use *--skin* and *--ldflags* instead. +Outputs one line with the C compiler command-line options that are necessary to link applications that use any Xenomai skin, except the posix skin, with the necessary libraries. Note that the particular *-llibskin* flag should be added to the flags returned by this option. *--posix-cflags*:: +This option is deprecated, please use *--skin posix --cflags* instead. Outputs one line with the C compiler command-line options that are necessary to compile applications that use Xenomai's Posix-compatible layer library. *--posix-ldflags*:: +This option is deprecated, please use *--skin posix --ldflags* instead. Outputs one line with the C compiler command-line options that are necessary to link applications against Xenomai's Posix-compatible layer library. -*--lib*-dir, --library-dir, --libdir, --user-libdir*:: -Outputs one line with the absolute path to Xenomai's libraries. -In the *--lib*-dir* option name, the *** is meant as a wildcard: *--lib-dir*, *--libfoo-dir* and *--libbar-dir* are all valid and synonymous options. - ENVIRONMENT VARIABLES ------------------------- +--------------------- *DESTDIR*:: If the *DESTDIR* variable is set, its content is prepended to the Xenomai installed directories and files names output by the @@ -93,7 +110,7 @@ options. If *DESTDIR* was set when compiling and installing Xenomai, e.g. for cross-compilation, *DESTDIR* must be set to the same value before calling *xeno-config*, in order to output valid directory and file names. RETURN CODES ---------------- +------------ *0*:: Successful script execution. _______________________________________________ Xenomai-git mailing list Xenomai-git@xenomai.org http://www.xenomai.org/mailman/listinfo/xenomai-git
