Index: doc/nxsh.1 =================================================================== diff -u -r5ea59fff5cd655425fe4c060cd8e032fd4c266e1 -r30cf844dee8fba6fb14a020ef9dfab0fd3dfda87 --- doc/nxsh.1 (.../nxsh.1) (revision 5ea59fff5cd655425fe4c060cd8e032fd4c266e1) +++ doc/nxsh.1 (.../nxsh.1) (revision 30cf844dee8fba6fb14a020ef9dfab0fd3dfda87) @@ -1,75 +1,82 @@ '\" -'\" Generated from file 'nxsh.man' by tcllib/doctools with format 'nroff' -'\" Copyright (c) 2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3.0 Austria license (CC BY 3.0 AT). +'\" Generated from file 'nxsh\&.man' by tcllib/doctools with format 'nroff' +'\" Copyright (c) 2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3\&.0 Austria license (CC BY 3\&.0 AT)\&. '\" -'\" The definitions below are for supplemental macros used in Tcl/Tk -'\" manual entries. -'\" -'\" .AP type name in/out ?indent? -'\" Start paragraph describing an argument to a library procedure. -'\" type is type of argument (int, etc.), in/out is either "in", "out", -'\" or "in/out" to describe whether procedure reads or modifies arg, -'\" and indent is equivalent to second arg of .IP (shouldn't ever be -'\" needed; use .AS below instead) -'\" -'\" .AS ?type? ?name? -'\" Give maximum sizes of arguments for setting tab stops. Type and -'\" name are examples of largest possible arguments that will be passed -'\" to .AP later. If args are omitted, default tab stops are used. -'\" -'\" .BS -'\" Start box enclosure. From here until next .BE, everything will be -'\" enclosed in one large box. -'\" -'\" .BE -'\" End of box enclosure. -'\" -'\" .CS -'\" Begin code excerpt. -'\" -'\" .CE -'\" End code excerpt. -'\" -'\" .VS ?version? ?br? -'\" Begin vertical sidebar, for use in marking newly-changed parts -'\" of man pages. The first argument is ignored and used for recording -'\" the version when the .VS was added, so that the sidebars can be -'\" found and removed when they reach a certain age. If another argument -'\" is present, then a line break is forced before starting the sidebar. -'\" -'\" .VE -'\" End of vertical sidebar. -'\" -'\" .DS -'\" Begin an indented unfilled display. -'\" -'\" .DE -'\" End of indented unfilled display. -'\" -'\" .SO -'\" Start of list of standard options for a Tk widget. The -'\" options follow on successive lines, in four columns separated -'\" by tabs. -'\" -'\" .SE -'\" End of list of standard options for a Tk widget. -'\" -'\" .OP cmdName dbName dbClass -'\" Start of description of a specific option. cmdName gives the -'\" option's name as specified in the class command, dbName gives -'\" the option's name in the option database, and dbClass gives -'\" the option's class in the option database. -'\" -'\" .UL arg1 arg2 -'\" Print arg1 underlined, then print arg2 normally. -'\" -'\" RCS: @(#) $Id: man.macros,v 1.1 2009/01/30 04:56:47 andreas_kupries Exp $ -'\" -'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. +.TH "nxsh" 1 2\&.0\&.0 nxsh "Command-line interface" +.\" The -*- nroff -*- definitions below are for supplemental macros used +.\" in Tcl/Tk manual entries. +.\" +.\" .AP type name in/out ?indent? +.\" Start paragraph describing an argument to a library procedure. +.\" type is type of argument (int, etc.), in/out is either "in", "out", +.\" or "in/out" to describe whether procedure reads or modifies arg, +.\" and indent is equivalent to second arg of .IP (shouldn't ever be +.\" needed; use .AS below instead) +.\" +.\" .AS ?type? ?name? +.\" Give maximum sizes of arguments for setting tab stops. Type and +.\" name are examples of largest possible arguments that will be passed +.\" to .AP later. If args are omitted, default tab stops are used. +.\" +.\" .BS +.\" Start box enclosure. From here until next .BE, everything will be +.\" enclosed in one large box. +.\" +.\" .BE +.\" End of box enclosure. +.\" +.\" .CS +.\" Begin code excerpt. +.\" +.\" .CE +.\" End code excerpt. +.\" +.\" .VS ?version? ?br? +.\" Begin vertical sidebar, for use in marking newly-changed parts +.\" of man pages. The first argument is ignored and used for recording +.\" the version when the .VS was added, so that the sidebars can be +.\" found and removed when they reach a certain age. If another argument +.\" is present, then a line break is forced before starting the sidebar. +.\" +.\" .VE +.\" End of vertical sidebar. +.\" +.\" .DS +.\" Begin an indented unfilled display. +.\" +.\" .DE +.\" End of indented unfilled display. +.\" +.\" .SO ?manpage? +.\" Start of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". The options follow on successive +.\" lines, in three columns separated by tabs. +.\" +.\" .SE +.\" End of list of standard options for a Tk widget. +.\" +.\" .OP cmdName dbName dbClass +.\" Start of description of a specific option. cmdName gives the +.\" option's name as specified in the class command, dbName gives +.\" the option's name in the option database, and dbClass gives +.\" the option's class in the option database. +.\" +.\" .UL arg1 arg2 +.\" Print arg1 underlined, then print arg2 normally. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b -'\" # Start an argument description +.\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ @@ -78,7 +85,7 @@ .\} .ta \\n()Au \\n()Bu .ie !"\\$3"" \{\ -\&\\$1 \\fI\\$2\\fP (\\$3) +\&\\$1 \\fI\\$2\\fP (\\$3) .\".b .\} .el \{\ @@ -91,7 +98,7 @@ .\} .\} .. -'\" # define tabbing values for .AP +.\" # define tabbing values for .AP .de AS .nr )A 10n .if !"\\$1"" .nr )A \\w'\\$1'u+3n @@ -101,9 +108,9 @@ .nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out -'\" # BS - start boxed text -'\" # ^y = starting y location -'\" # ^b = 1 +.\" # BS - start boxed text +.\" # ^y = starting y location +.\" # ^b = 1 .de BS .br .mk ^y @@ -113,7 +120,7 @@ .if n \l'\\n(.lu\(ul' .if n .fi .. -'\" # BE - end boxed text (draw box now) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 @@ -133,16 +140,16 @@ .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # VS - start vertical sidebar +.\" # ^Y = starting y location +.\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. -'\" # VE - end of vertical sidebar +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ @@ -157,9 +164,9 @@ .\} .nr ^v 0 .. -'\" # Special macro to handle page bottom: finish off current -'\" # box/sidebar if in box/sidebar mode, then invoked standard -'\" # page bottom macro. +.\" # Special macro to handle page bottom: finish off current +.\" # box/sidebar if in box/sidebar mode, then invoked standard +.\" # page bottom macro. .de ^B .ev 2 'ti 0 @@ -186,34 +193,36 @@ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO +'ie '\\$1'' .ds So \\fBoptions\\fR +'el .ds So \\fB\\$1\\fR .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # SE - end of list of standard options .de SE .fi .ft R .LP -See the \\fBoptions\\fR manual entry for details on the standard options. +See the \\*(So manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf @@ -222,47 +231,92 @@ Database Name: \\fB\\$2\\fR Database Class: \\fB\\$3\\fR .fi +.IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. -.TH "nxsh" 1 2.0 nxsh "" +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.QW "" +.. .BS .SH NAME nxsh \- Simple shell containing NSF/NX interpreter .SH SYNOPSIS -\fBnxsh\fR ?\fIfileName\fR? +\fBnxsh\fR ?\fB-c\fR? ?\fIarg1\fR \fIarg2\fR \&.\&.\&.? .sp .BE .SH DESCRIPTION .TP -\fBnxsh\fR ?\fIfileName\fR? -\fBnxsh\fR is a shell-like application that reads NX and Tcl commands from its standard input or from \fIfileName\fR and evaluates them. If invoked without \fIfileName\fR, then it runs in REPL mode, reading commands from standard input and printing command results and error messages to standard output. It runs until the exit command is invoked or until it reaches end-of-file on its standard input. +\fBnxsh\fR ?\fB-c\fR? ?\fIarg1\fR \fIarg2\fR \&.\&.\&.? +\fBnxsh\fR is a shell-like application that reads NX and Tcl +commands from different sources and evaluates them\&. .sp +If invoked without any arguments, \fBnxsh\fR runs in +read-eval-print mode (REPL, interactive) similar to \fBtclsh\fR\&. In +this mode, it reads commands from standard input interactively and +prints command results as well as error messages to standard +output\&. It remains active until the exit command is invoked or until +it reaches end-of-file on its standard input\&. +.sp +If invoked with at least one positional argument \fIarg1\fR, \fBnxsh\fR runs +a NX/Tcl script sourced from a file identified by \fIarg1\fR using \fBsource\fR\&. +.sp +Passing the \fB-c\fR flag makes \fBnxsh\fR accept commands from +the command line provided by \fIarg1\fR\&. If \fIarg1\fR is omitted, +\fBnxsh\fR takes commands from standard input (e\&.g\&., in a pipe)\&. +.sp \fBnxsh\fR can be used like \fBtclsh\fR to make NX scripts directly invokable from the shell, by providing the following first line ("shebang") in the respective script: .CS -#! /usr/bin/env nxsh + + + #! /usr/bin/env nxsh + .CE .IP A (more portable) alternative is: .CS -#! /bin/sh -# the next line restarts using nxsh \\ -exec nxsh "$0" "$@" + + + #! /bin/sh + # the next line restarts using nxsh \\ + exec nxsh "$0" "$@" + .CE .PP .SH COPYRIGHT .nf -Copyright (c) 2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3.0 Austria license (CC BY 3.0 AT). +Copyright (c) 2014 Stefan Sobernig , Gustaf Neumann ; available under the Creative Commons Attribution 3\&.0 Austria license (CC BY 3\&.0 AT)\&. + .fi \ No newline at end of file Index: doc/nxsh.man =================================================================== diff -u -r83b89feaa688228e7f9b25f44c2d02591601665a -r30cf844dee8fba6fb14a020ef9dfab0fd3dfda87 --- doc/nxsh.man (.../nxsh.man) (revision 83b89feaa688228e7f9b25f44c2d02591601665a) +++ doc/nxsh.man (.../nxsh.man) (revision 30cf844dee8fba6fb14a020ef9dfab0fd3dfda87) @@ -11,10 +11,31 @@ [list_begin definitions] -[call [syscmd "nxsh"] [opt [arg fileName]]] +[call [syscmd "nxsh"] [opt [option -c]] [opt "[arg arg1] [arg arg2] ..."]] -[syscmd "nxsh"] is a shell-like application that reads NX and Tcl commands from its standard input or from [arg fileName] and evaluates them. If invoked without [arg fileName], then it runs in REPL mode, reading commands from standard input and printing command results and error messages to standard output. It runs until the exit command is invoked or until it reaches end-of-file on its standard input. +[syscmd "nxsh"] is a shell-like application that reads NX and Tcl +commands from different sources and evaluates them. +[para] + +If invoked without any arguments, [syscmd "nxsh"] runs in +read-eval-print mode (REPL, interactive) similar to [syscmd "tclsh"]. In +this mode, it reads commands from standard input interactively and +prints command results as well as error messages to standard +output. It remains active until the exit command is invoked or until +it reaches end-of-file on its standard input. + +[para] + +If invoked with at least one positional argument [arg arg1], [syscmd "nxsh"] runs +a NX/Tcl script sourced from a file identified by [arg arg1] using [cmd source]. + +[para] + +Passing the [option -c] flag makes [syscmd nxsh] accept commands from +the command line provided by [arg arg1]. If [arg arg1] is omitted, +[syscmd nxsh] takes commands from standard input (e.g., in a pipe). + [para] [syscmd "nxsh"] can be used like [syscmd "tclsh"] to make NX scripts directly invokable from the shell, by providing the following first line ("shebang") in the respective script: