You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`-n, --nonewline`| Supress printing of the newline character |
17
17
18
-
###Description
18
+
## Description
19
19
20
-
This command echos the args to the current output stream. This is normally stdout but can be set to a variety of channels. If an arg is `--nonewline` then no newline is printed at the end of the printed strings. Otherwise a newline is printed after printing all the given args. Echo is the easiest way to add user comments or identification strings in a log file.
20
+
This command echos the args to the current output stream. This is normally
21
+
stdout but can be set to a variety of channels. If an arg is `--nonewline` then
22
+
no newline is printed at the end of the printed strings. Otherwise a newline is
23
+
printed after printing all the given args. Echo is the easiest way to add user
24
+
comments or identification strings in a log file.
21
25
22
-
###Example
26
+
## Example
23
27
24
28
This example will add these comments to the screen and any open log file.
This command logs a single command. It is almost equivalent to opening a log using [clog](./cmd_clog.md), running the command, then closing the log, the only difference is that input isn't recorded.
58
+
This command logs a single command. It is almost equivalent to opening a log
59
+
using [clog](./cmd_output.md#default-aliases), running the command, then closing
60
+
the log, the only difference is that input isn't recorded.
57
61
58
-
Running this command while a log is open is an error. There is currently not support for multiple logs in the command line interface, and this would be an instance of multiple logs.
62
+
Running this command while a log is open is an error. There is currently not
63
+
support for multiple logs in the command line interface, and this would be an
64
+
instance of multiple logs.
59
65
60
66
This command echoes output both to the screen and to a file, just like clog.
|`filename`| The file to log the results of the command to |
67
-
|`command`| The command to log |
68
-
|`args`| Arguments for command |
74
+
|`command`| The command to log |
75
+
|`args`| Arguments for command |
69
76
70
-
###output log
77
+
## output log
71
78
72
-
The `output log` command allows users to save all user-interface input and output to a file. When Soar is logging to a file, everything typed by the user and everything printed by Soar is written to the file (in addition to the screen).
79
+
The `output log` command allows users to save all user-interface input and
80
+
output to a file. When Soar is logging to a file, everything typed by the user
81
+
and everything printed by Soar is written to the file (in addition to the
82
+
screen).
73
83
74
-
Invoke `output log` with no arguments to query the current logging status. Pass a filename to start logging to that file (relative to the command line interface's home directory). Use the `close` option to stop logging.
84
+
Invoke `output log` with no arguments to query the current logging status. Pass
85
+
a filename to start logging to that file (relative to the command line
86
+
interface's home directory). Use the `close` option to stop logging.
75
87
76
-
####Usage
88
+
### Usage
77
89
78
-
```
90
+
```bash
79
91
output log [-A] filename
80
92
output log --add string
81
93
output log --close
82
94
```
83
95
84
-
####Options:
96
+
### Options
85
97
86
-
|**Option**|**Description**|
87
-
|:-----------|:----------------|
88
-
|`filename`| Open filename and begin logging. |
89
-
|`-c, --close`| Stop logging, close the file. |
90
-
|`-a, --add string`| Add the given string to the open log file. |
91
-
|`-A, --append`| Opens existing log file named `filename` and logging is added at the end of the file. |
|`-a, --add string`| Add the given string to the open log file. |
103
+
|`-A, --append`| Opens existing log file named `filename` and logging is added at the end of the file. |
92
104
93
-
####Examples
105
+
### Examples
94
106
95
107
To initiate logging and place the record in foo.log:
96
108
97
-
```
109
+
```bash
98
110
output log foo.log
99
111
```
100
112
101
113
To append log data to an existing foo.log file:
102
114
103
-
```
115
+
```bash
104
116
output log -A foo.log
105
117
```
106
118
107
119
To terminate logging and close the open log file:
108
120
109
-
```
121
+
```bash
110
122
output log -c
111
123
```
112
124
113
-
####Known Issues with log
125
+
### Known Issues with log
114
126
115
127
Does not log everything when structured output is selected.
116
128
117
-
###General Output Settings
129
+
## General Output Settings
118
130
119
-
Invoke a sub-command with no arguments to query the current setting. Partial commands are accepted.
131
+
Invoke a sub-command with no arguments to query the current setting. Partial
132
+
commands are accepted.
120
133
121
-
|**Option**|**Valid Values**|**Default**|
122
-
|:-----------|:-----------------|:------------|
123
-
|`echo-commands`| yes or no | off |
124
-
|`print-depth`| >= 1 | 1 |
125
-
|`verbose`| yes or no | no |
126
-
|`warnings`| yes or no | yes |
134
+
|**Option**|**Valid Values**|**Default**|
135
+
|:--------------| :--------------- |:----------|
136
+
|`echo-commands`| yes or no | off|
137
+
|`print-depth`| >= 1 | 1|
138
+
|`verbose`| yes or no | no|
139
+
|`warnings`| yes or no | yes|
127
140
128
-
####output agent-logs
141
+
## output agent-logs
129
142
130
-
A Soar agent has 100 log channels available. By default, all are turned on. The `log` RHS-function allows printing as with the `write` function, but limits output to only the specified log channel.
143
+
A Soar agent has 100 log channels available. By default, all are turned on. The
144
+
`log` RHS-function allows printing as with the `write` function, but limits
145
+
output to only the specified log channel.
131
146
132
-
####output echo-commands
147
+
## output echo-commands
133
148
134
-
`output echo-commands` will echo typed commands to other connected debuggers. Otherwise, the output is displayed without the initiating command, and this can be confusing.
149
+
`output echo-commands` will echo typed commands to other connected debuggers.
150
+
Otherwise, the output is displayed without the initiating command, and this can
151
+
be confusing.
135
152
136
-
####output print-depth
153
+
## output print-depth
137
154
138
-
The `print-depth` command reflects the default depth used when working memory elements are printed (using the [print](./cmd_print.md)). The default value is 1. This default depth can be overridden on any particular call to the [print](./cmd_print.md) command by explicitly using the `--depth` flag, e.g. `print --depth 10 args`.
155
+
The `print-depth` command reflects the default depth used when working memory
156
+
elements are printed (using the [print](./cmd_print.md)). The default value is
139
157
140
-
By default, the [print](./cmd_print.md) command prints _objects_ in working memory, not just the individual working memory element. To limit the output to individual working memory elements, the `--internal` flag must also be specified in the [print](./cmd_print.md) command. Thus when the print depth is `0`, by default Soar prints the entire object, which is the same behavior as when the print depth is `1`. But if `--internal` is also specified, then a depth of `0` prints just the individual WME, while a depth of `1` prints all WMEs which share that same identifier. This is true when printing timetags, identifiers or WME patterns.
158
+
1. This default depth can be overridden on any particular call to the
159
+
[print](./cmd_print.md) command by explicitly using the `--depth` flag, e.g.
160
+
`print --depth 10 args`.
141
161
142
-
When the depth is greater than `1`, the identifier links from the specified WME's will be followed, so that additional substructure is printed. For example, a depth of `2` means that the object specified by the identifier, wme-pattern, or timetag will be printed, along with all other objects whose identifiers appear as values of the first object. This may result in multiple copies of the same object being printed out. If `--internal` is also specified, then individuals WMEs and their timetags will be printed instead of the full objects.
162
+
By default, the [print](./cmd_print.md) command prints _objects_ in working
163
+
memory, not just the individual working memory element. To limit the output to
164
+
individual working memory elements, the `--internal` flag must also be specified
165
+
in the [print](./cmd_print.md) command. Thus when the print depth is `0`, by
166
+
default Soar prints the entire object, which is the same behavior as when the
167
+
print depth is `1`. But if `--internal` is also specified, then a depth of `0`
168
+
prints just the individual WME, while a depth of `1` prints all WMEs which share
169
+
that same identifier. This is true when printing timetags, identifiers or WME
170
+
patterns.
143
171
144
-
#### output verbose
172
+
When the depth is greater than `1`, the identifier links from the specified
173
+
WME's will be followed, so that additional substructure is printed. For example,
174
+
a depth of `2` means that the object specified by the identifier, wme-pattern,
175
+
or timetag will be printed, along with all other objects whose identifiers
176
+
appear as values of the first object. This may result in multiple copies of the
177
+
same object being printed out. If `--internal` is also specified, then
178
+
individuals WMEs and their timetags will be printed instead of the full objects.
145
179
146
-
The `verbose` command enables tracing of a number of low-level Soar execution details during a run. The details printed by `verbose` are usually only valuable to developers debugging Soar implementation details.
180
+
## output verbose
147
181
148
-
#### output warnings
182
+
The `verbose` command enables tracing of a number of low-level Soar execution
183
+
details during a run. The details printed by `verbose` are usually only valuable
184
+
to developers debugging Soar implementation details.
149
185
150
-
The `warnings` command enables and disables the printing of warning messages. At startup, warnings are initially enabled. If warnings are disabled using this command, then some warnings may still be printed, since some are considered too important to ignore.
186
+
## output warnings
151
187
152
-
The warnings that are printed apply to the syntax of the productions, to notify the user when they are not in the correct syntax. When a lefthand side error is discovered (such as conditions that are not linked to a common state or impasse object), the production is generally loaded into production memory anyway, although this production may never match or may seriously slow down the matching process. In this case, a warning would be printed only if warnings were `on`. Righthand side errors, such as preferences that are not linked to the state, usually result in the production not being loaded, and a warning regardless of the warnings setting.
188
+
The `warnings` command enables and disables the printing of warning messages. At
189
+
startup, warnings are initially enabled. If warnings are disabled using this
190
+
command, then some warnings may still be printed, since some are considered too
191
+
important to ignore.
153
192
154
-
### Default Aliases
155
-
```
193
+
The warnings that are printed apply to the syntax of the productions, to notify
194
+
the user when they are not in the correct syntax. When a lefthand side error is
195
+
discovered (such as conditions that are not linked to a common state or impasse
196
+
object), the production is generally loaded into production memory anyway,
197
+
although this production may never match or may seriously slow down the matching
198
+
process. In this case, a warning would be printed only if warnings were `on`.
199
+
Righthand side errors, such as preferences that are not linked to the state,
200
+
usually result in the production not being loaded, and a warning regardless of
0 commit comments