diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/pies.texi | 110 |
1 files changed, 70 insertions, 40 deletions
diff --git a/doc/pies.texi b/doc/pies.texi index 93a329e..0bc3bee 100644 --- a/doc/pies.texi +++ b/doc/pies.texi | |||
@@ -29,8 +29,10 @@ | |||
29 | @include macros.texi | 29 | @include macros.texi |
30 | 30 | ||
31 | @ifinfo | 31 | @ifinfo |
32 | @dircategory GNU Utilities | 32 | @dircategory System Administration |
33 | @direntry (pies) pies. Program execution supervisor. | 33 | @direntry |
34 | * Pies: (pies). Program Invocation and Execution Supervisor. | ||
35 | * pies: (pies) Invocation. Pies Command Line Options. | ||
34 | @end direntry | 36 | @end direntry |
35 | @end ifinfo | 37 | @end ifinfo |
36 | 38 | ||
@@ -81,7 +83,7 @@ documents @command{pies} Version @value{VERSION}. | |||
81 | * Pies Debugging:: | 83 | * Pies Debugging:: |
82 | * Configuration Example:: | 84 | * Configuration Example:: |
83 | * Command Line Usage:: | 85 | * Command Line Usage:: |
84 | * Pies Invocation:: | 86 | * Invocation:: |
85 | * Reporting Bugs:: | 87 | * Reporting Bugs:: |
86 | 88 | ||
87 | Appendices | 89 | Appendices |
@@ -507,6 +509,24 @@ is similar to GNU m4 @option{--prefix-builtin} options, but has an | |||
507 | advantage that it works with non-GNU @command{m4} implementations as | 509 | advantage that it works with non-GNU @command{m4} implementations as |
508 | well. | 510 | well. |
509 | 511 | ||
512 | Additional preprocessor symbols may be defined and the existing | ||
513 | symbols may be undefined using the following command line options: | ||
514 | |||
515 | @table @option | ||
516 | @xopindex{define, described} | ||
517 | @cindex @option{-D} | ||
518 | @item --define=@var{sym}[=@var{value}] | ||
519 | @itemx -D @var{symbol}[=@var{value}] | ||
520 | Define symbol @var{sym} as having @var{value}, or emtpy, if | ||
521 | the @var{value} is not given. | ||
522 | |||
523 | @xopindex{undefine, described} | ||
524 | @cindex @option{-U} | ||
525 | @item --undefine=@var{sym} | ||
526 | @itemx -U @var{sym} | ||
527 | Undefine symbol @var{sym}. | ||
528 | @end table | ||
529 | |||
510 | @node Component Statement | 530 | @node Component Statement |
511 | @section Component Statement | 531 | @section Component Statement |
512 | @kwindex component | 532 | @kwindex component |
@@ -1802,16 +1822,12 @@ smtpc: qmgr | |||
1802 | smtps: smar qmgr | 1822 | smtps: smar qmgr |
1803 | @end smallexample | 1823 | @end smallexample |
1804 | 1824 | ||
1805 | @node Pies Invocation | 1825 | @node Invocation |
1806 | @chapter Pies Invocation | 1826 | @chapter Pies Invocation |
1807 | 1827 | ||
1808 | This section summarizes @command{pies} command line options. | 1828 | This section summarizes @command{pies} command line options. |
1809 | 1829 | ||
1810 | @table @option | 1830 | @table @option |
1811 | @opsummary{config-help} | ||
1812 | @item --config-help | ||
1813 | Show configuration file summary. @xref{Pies Configuration File}. | ||
1814 | |||
1815 | @opsummary{config-file} | 1831 | @opsummary{config-file} |
1816 | @item --config-file=@var{file} | 1832 | @item --config-file=@var{file} |
1817 | @item -c @var{file} | 1833 | @item -c @var{file} |
@@ -1820,6 +1836,30 @@ Read configuration from @var{file}, instead of the default | |||
1820 | 1836 | ||
1821 | @xref{Pies Configuration File}. | 1837 | @xref{Pies Configuration File}. |
1822 | 1838 | ||
1839 | @opsummary{config-help} | ||
1840 | @item --config-help | ||
1841 | Show configuration file summary. @xref{Pies Configuration File}. | ||
1842 | |||
1843 | @opsummary{define} | ||
1844 | @item --define=@var{sym}[=@var{value}] | ||
1845 | @itemx -D @var{symbol}[=@var{value}] | ||
1846 | Define symbol @var{sym} as having @var{value}, or emtpy, if | ||
1847 | the @var{value} is not given. @xref{Preprocessor}. | ||
1848 | |||
1849 | @opsummary{debug} | ||
1850 | @item --debug=@var{level} | ||
1851 | @itemx -x @var{level} | ||
1852 | Set debug verbosity level. @xref{Pies Debugging}, for a description | ||
1853 | of @var{level}. | ||
1854 | |||
1855 | @opsummary{dump-depmap} | ||
1856 | @item --dump-depmap | ||
1857 | Dump dependency map. @xref{dump-depmap}. | ||
1858 | |||
1859 | @opsummary{dump-prereq} | ||
1860 | @item --dump-prereq | ||
1861 | Dump prerequisite charts. @xref{dump-prereq}. | ||
1862 | |||
1823 | @item -E | 1863 | @item -E |
1824 | Preprocess configuration file and exit. @xref{Preprocessor}. | 1864 | Preprocess configuration file and exit. @xref{Preprocessor}. |
1825 | 1865 | ||
@@ -1831,28 +1871,35 @@ Force startup even if another instance may be running. | |||
1831 | @item --foreground | 1871 | @item --foreground |
1832 | Remain in foreground. | 1872 | Remain in foreground. |
1833 | 1873 | ||
1834 | @opsummary{source-info} | 1874 | @item --help |
1835 | @item --source-info | 1875 | Display a short usage summary and exit. |
1836 | Show source info with debugging messages. @xref{source-info}. | ||
1837 | 1876 | ||
1838 | @opsummary{lint} | 1877 | @opsummary{lint} |
1839 | @item --lint | 1878 | @item --lint |
1840 | @itemx -t | 1879 | @itemx -t |
1841 | 1880 | ||
1881 | @opsummary{source-info} | ||
1882 | @item --source-info | ||
1883 | Show source info with debugging messages. @xref{source-info}. | ||
1884 | |||
1885 | @opsummary{status} | ||
1886 | @item --status | ||
1887 | @itemx -s | ||
1888 | Display info about the running instance. @xref{pies-status}. | ||
1889 | |||
1842 | @opsummary{stderr} | 1890 | @opsummary{stderr} |
1843 | @item --stderr | 1891 | @item --stderr |
1844 | Log to standard error. | 1892 | Log to standard error. |
1845 | 1893 | ||
1894 | @opsummary{stop} | ||
1895 | @item --stop | ||
1896 | @itemx -S | ||
1897 | Stop the running instance. | ||
1898 | |||
1846 | @opsummary{syslog} | 1899 | @opsummary{syslog} |
1847 | @item --syslog | 1900 | @item --syslog |
1848 | Log to syslog. This is the default. | 1901 | Log to syslog. This is the default. |
1849 | 1902 | ||
1850 | @opsummary{debug} | ||
1851 | @item -x @var{level} | ||
1852 | @itemx --debug=@var{level} | ||
1853 | Set debug verbosity level. @xref{Pies Debugging}, for a description | ||
1854 | of @var{level}. | ||
1855 | |||
1856 | @opsummary{reload} | 1903 | @opsummary{reload} |
1857 | @opsummary{hup} | 1904 | @opsummary{hup} |
1858 | @item -r | 1905 | @item -r |
@@ -1865,33 +1912,16 @@ Reload the running instance of pies. | |||
1865 | @itemx --restart-component | 1912 | @itemx --restart-component |
1866 | Restart components named in the command line. @xref{pies-restart}. | 1913 | Restart components named in the command line. @xref{pies-restart}. |
1867 | 1914 | ||
1868 | @opsummary{status} | 1915 | @item --version |
1869 | @item -s | 1916 | Display program version and license information and exit. |
1870 | @itemx --status | ||
1871 | Display info about the running instance. @xref{pies-status}. | ||
1872 | |||
1873 | @opsummary{stop} | ||
1874 | @item -S | ||
1875 | @itemx --stop | ||
1876 | Stop the running instance. | ||
1877 | |||
1878 | @opsummary{dump-depmap} | ||
1879 | @item --dump-depmap | ||
1880 | Dump dependency map. @xref{dump-depmap}. | ||
1881 | |||
1882 | @opsummary{dump-prereq} | ||
1883 | @item --dump-prereq | ||
1884 | Dump prerequisite charts. @xref{dump-prereq}. | ||
1885 | 1917 | ||
1886 | @item --help | 1918 | @xopindex{undefine} |
1887 | Display a short usage summary and exit. | 1919 | @item --undefine=@var{sym} |
1920 | @itemx -U @var{sym} | ||
1921 | Undefine symbol @var{sym}. @xref{Preprocessor}. | ||
1888 | 1922 | ||
1889 | @item --usage | 1923 | @item --usage |
1890 | Display a short summary of available options and exit. | 1924 | Display a short summary of available options and exit. |
1891 | |||
1892 | @item --version | ||
1893 | Display program version and license information and exit. | ||
1894 | |||
1895 | @end table | 1925 | @end table |
1896 | 1926 | ||
1897 | @node Reporting Bugs | 1927 | @node Reporting Bugs |