Skip to content
Snippets Groups Projects
Normal view Permalink
NuttShell.html 59.4 KiB
Newer Older
patacongo's avatar
NSH Documentation
patacongo committed
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 
  <tr>
    <td><b><code>uordblks</code></b></td>
    <td>This is the total size of memory occupied by chunks handed out by malloc.</td>
  </tr>
  <tr>
    <td><b><code>fordblks</code></b></td>
    <td>This is the total size of memory occupied by free (not in use) chunks.</td>
  </tr>
</table></ul>

<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add get and put commands to NSH  
patacongo committed
1014 
    <a name="cmdps"><h2>2.14 Show Current Tasks and Threads (ps)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 
  </td>
  </tr>
</table>

<a <p><b>Command Syntax:</b></p>
<ul><pre>
ps
</pre></ul>
<p>
  <b>Synopsis</b>.
  Show the currently active threads and tasks.  For example,
</p>
<ul><pre>
nsh&gt; ps
PID   PRI SCHD TYPE   NP STATE    NAME
    0   0 FIFO TASK      READY    Idle Task()
    1 128 RR   TASK      RUNNING  init()
    2 128 FIFO TASK      WAITSEM  nsh_telnetmain()
    3 100 RR   PTHREAD   WAITSEM  &lt;pthread&gt;(21)
nsh&gt;
</pre></ul>

<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add get and put commands to NSH  
patacongo committed
1040 
    <a name="cmdmkdir"><h2>2.15 Create a Directory (mkdir)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1041 1042 1043 1044 
  </td>
</tr>
</table>
patacongo's avatar
update NSH docs  
patacongo committed
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 
<p><b>Command Syntax:</b></p>
<ul><pre>
mkdir &lt;path&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Create the directory at <code>&lt;path&gt;</code>.
  All components of of <code>&lt;path&gt;</code> except the final directory name must exist on a mounted file
  system; the final directory must not.
</p>
<p>
  <b>Limited to Mounted File Systems</b>.
  Recall that NuttX uses a <a href="NuttxUserGuide.html#FileSystemOverview"><i>pseudo</i> filesystem</a> for its root file
  system.
  The <code>mkdir</code> command can only be used to create directories in volumes set up with the
  <a href="#cmdmount"><code>mount</code></a> command; it cannot be used to create directories in the <i>pseudo</i> filesystem.
</p>
<p><b>Example:</b></p>
<ul><pre>
nsh> mkdir /mnt/fs/tmp
nsh> ls -l /mnt/fs
/mnt/fs:
 drw-rw-rw-       0 TESTDIR/
 drw-rw-rw-       0 TMP/
nsh>
</pre></ul>
patacongo's avatar
NSH Documentation
patacongo committed
1072 1073 1074 
<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add get and put commands to NSH  
patacongo committed
1075 
    <a name="cmdmkfatfs"><h2>2.16 Create a FAT Filesystem (mkfatfs)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1076 1077 1078 1079 
  </td>
</tr>
</table>
patacongo's avatar
update NSH docs  
patacongo committed
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 
<p><b>Command Syntax:</b></p>
<ul><pre>
mkfatfs &lt;path&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Format a fat file system on the block device specified by <code>&lt;path&gt;</code>.
  NSH provides this command to access the <a href="mkfatfs"><code>mkfatfs()</code></a> NuttX API.
  This block device must reside in the NuttX <a href="NuttxUserGuide.html#FileSystemOverview"><i>pseudo</i> filesystem</a> and
  must have been created by some call to <code>register_blockdriver()</code> (see <code>include/nuttx/fs.h</code>).
</p>
patacongo's avatar
NSH Documentation
patacongo committed
1092 1093 1094 
<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add get and put commands to NSH  
patacongo committed
1095 
    <a name="cmdmkfifo"><h2>2.17 Create a FIFO (mkfifo)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1096 1097 1098 1099 
  </td>
</tr>
</table>
patacongo's avatar
update NSH docs  
patacongo committed
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 
<p><b>Command Syntax:</b></p>
<ul><pre>
mkfifo &lt;path&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Creates a FIFO character device anywhere in the pseudo file system, creating
  whatever psuedo directories that may be needed to complete the <code>&lt;path&gt;</code>.
  By convention, however, device drivers are place in the standard <code>/dev</code> directory.
  After it is created, the FIFO device may be used as any other device driver.
  NSH provides this command to access the <a href="NuttxUserGuide.html#mkfifo"><code>mkfifo()</code></a> NuttX API.
</p>
<p><b>Example</b></p>
<ul><pre>
nsh> ls -l /dev
/dev:
 crw-rw-rw-       0 console
 crw-rw-rw-       0 null
 brw-rw-rw-       0 ram0
nsh> mkfifo /dev/fifo
nsh> ls -l /dev
ls -l /dev
/dev:
 crw-rw-rw-       0 console
 crw-rw-rw-       0 fifo
 crw-rw-rw-       0 null
 brw-rw-rw-       0 ram0
nsh>
</pre></ul>
patacongo's avatar
NSH Documentation
patacongo committed
1130 1131 1132 
<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 
    <a name="cmdmkrd"><h2>2.18 Create a RAMDISK (mkrd)</h2></a>
  </td>
</tr>
</table>

<p><b>Command Syntax:</b></p>
<ul><pre>
mkrd [-m &lt;minor&gt;] [-s &lt;sector-size&gt;] &lt;nsectors&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Create a ramdisk consisting of <code>&lt;nsectors&gt;</code>, each of size
  <code>&lt;sector-size&gt;</code> (or 512 bytes if <code>&lt;sector-size&gt;</code> is not specified.
  The ramdisk will be registered as <code>/dev/ram&lt;n&gt;</code> (if <code>&lt;n&gt;</code> is not
  specified, mkrd will attempt to register the ramdisk as <code>/dev/ram0</code>.
</p>
<p><b>Example</b></p>
<ul><pre>
nsh&gt; ls /dev
/dev:
 console
 null
 ttyS0
 ttyS1
nsh&gt; mkrd 1024
nsh&gt; ls /dev
/dev:
 console
 null
 ram0
 ttyS0
 ttyS1
nsh&gt;
</pre></ul>
<p>
  Once the ramdisk has been created, it may be formatted using
  the <code>mkfatfs</code> command and mounted using the <code>mount</code> command.
</p>
<p><b>Example</b></p>
<ul><pre>
nsh&gt; mkrd 1024
nsh&gt; mkfatfs /dev/ram0
nsh&gt; mount -t vfat /dev/ram0 /tmp
nsh&gt; ls /tmp
/tmp:
nsh&gt;
</pre></ul>

<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
    <a name="cmdmount"><h2>2.19 Mount a File System (mount)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1185 1186 1187 1188 
  </td>
</tr>
</table>
patacongo's avatar
update NSH docs  
patacongo committed
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 
<p><b>Command Syntax:</b></p>
<ul><pre>
mount -t &lt;fstype&gt; &lt;block-device&gt; <code>&lt;dir-path&gt;</code>
</pre></ul>
<p>
  <b>Synopsis</b>.
  The 'm  ount' command mounts a file system in the NuttX psuedo
  filesystem.  'mount' performs a three way associating, binding:
</p>
<ol>
  <li><b>File system.</b>
    The '-t <code>&lt;fstype&gt;</code>' option identifies the type of
    file system that has been formatted on the <code>&lt;block-device&gt;</code>.
    As of this writing, <code>vfat</code> is the only supported value for <code>&lt;fstype&gt;</code>
  </li>
  <li><b>Block Device.</b>
    The <code>&lt;block-device&gt;</code> argument is the full or relative
    path to a block driver inode in the <a href="NuttxUserGuide.html#FileSystemOverview"><i>pseudo</i> filesystem</a>.
    By convention, this is a name under the <code>/dev</code> sub-directory.
    This <code>&lt;block-device&gt;</code>  must have been previously formatted with the same file system
    type as specified by <code>&lt;fstype&gt;</code>
  </li>
  <li><b>Mount Point.</b>
    The mount point, <code>&lt;dir-path&gt;</code>, is the location in the
    <a href="NuttxUserGuide.html#FileSystemOverview"><i>pseudo</i> filesystem</a> where the mounted volume will appear.
    This mount point can only reside in the NuttX <a href="NuttxUserGuide.html#FileSystemOverview"><i>pseudo</i> filesystem</a>.
    By convention, this mount point is a subdirectory under <code>/mnt</code>.
    The mount command will create whatever psuedo directories that may be needed to complete the
    full path but the full path must not already exist.
  </li>
</ol>
<p>
  After the the volume has been mounted in the NuttX
  <a href="NuttxUserGuide.html#FileSystemOverview"><i>pseudo</i> filesystem</a>,
  it may be access in the same way as other objects in thefile system.
</p>
<p><b>Example</b></p>
<ul><pre>
nsh> ls -l /dev
/dev:
 crw-rw-rw-       0 console
 crw-rw-rw-       0 null
 brw-rw-rw-       0 ram0
nsh> ls /mnt
nsh: ls: no such directory: /mnt
nsh> mount -t vfat /dev/ram0 /mnt/fs
nsh> ls -l /mnt/fs/testdir
/mnt/fs/testdir:
 -rw-rw-rw-      15 TESTFILE.TXT
nsh> echo "This is a test" >/mnt/fs/testdir/example.txt
nsh> ls -l /mnt/fs/testdir
/mnt/fs/testdir:
-rw-rw-rw-      15 TESTFILE.TXT
 -rw-rw-rw-      16 EXAMPLE.TXT
nsh> cat /mnt/fs/testdir/example.txt
This is a test
nsh>
</pre></ul>
patacongo's avatar
NSH Documentation
patacongo committed
1248 1249 1250 
<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1251 
    <a name="cmdping"><h2>2.20 Check Network Peer (ping)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 
  </td>
  </tr>
</table>

<a <p><b>Command Syntax:</b></p>
<ul><pre>
ping [-c &lt;count&gt;] [-i &lt;interval&gt;] &lt;ip-address&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Test the network communication with a remote peer.  Example,
</p>
<ul><pre>
nsh&gt; 10.0.0.1
PING 10.0.0.1 56 bytes of data
56 bytes from 10.0.0.1: icmp_seq=1 time=0 ms
56 bytes from 10.0.0.1: icmp_seq=2 time=0 ms
56 bytes from 10.0.0.1: icmp_seq=3 time=0 ms
56 bytes from 10.0.0.1: icmp_seq=4 time=0 ms
56 bytes from 10.0.0.1: icmp_seq=5 time=0 ms
56 bytes from 10.0.0.1: icmp_seq=6 time=0 ms
56 bytes from 10.0.0.1: icmp_seq=7 time=0 ms
56 bytes from 10.0.0.1: icmp_seq=8 time=0 ms
56 bytes from 10.0.0.1: icmp_seq=9 time=0 ms
56 bytes from 10.0.0.1: icmp_seq=10 time=0 ms
10 packets transmitted, 10 received, 0% packet loss, time 10190 ms
nsh&gt;
</pre></ul>

<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1284 
    <a name="cmdput"><h2>2.21 Send File Via TFTP (put)</h2></a>
patacongo's avatar
Add get and put commands to NSH  
patacongo committed
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 
  </td>
  </tr>
</table>

<a <p><b>Command Syntax:</b></p>
<ul><pre>
put [-b|-n] [-f &lt;remote-path&gt;] -h &lt;ip-address&gt; &lt;local-path&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Copy the file at <code>&lt;local-address&gt;</code> to the host whose IP address is
  identified by <code>&lt;ip-address&gt;</code>.
</p>
<p><b>Other options:</b></p>
<ul><table>
  <tr>
    <td><b><code>-f &lt;remote-path&gt;</code></b></td>
    <td>
      The file will be saved relative with the same name on the host
      unless <code>&lt;remote-path&gt;</code> is provided.
    </td>
  </tr>
  <tr>
    <td><b><code>-b|-n</code></b></td>
    <td>
      Selects either binary (&quot;octect&quot;) or test (&quot;netascii&quot;) transfer
      mode.  Default: text.
    </td>
  </tr>
</table></ul>

<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1319 
    <a name="cmdpwd"><h2>2.22 Show Current Working Directory (pwd)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 
  </td>
  </tr>
</table>

<a <p><b>Command Syntax:</b></p>
<ul><pre>
pwd
</pre></ul>
<p>
  <b>Synopsis</b>.
  Show the current working directory.
</p>
<ul><pre>
nsh&gt; cd /dev
nsh&gt; pwd
/dev
nsh&gt;
</pre></ul>

<p>Same as <code><a href="#cmdecho">echo</a> <a href="#environvars">$PWD</a></code>.</p>
<ul><pre>
nsh&gt; echo $PWD
/dev
nsh&gt;
</pre></ul>

<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1349 
    <a name="cmdrm"><h2>2.23 Remove a File (rm)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1350 1351 1352 1353 
  </td>
</tr>
</table>
patacongo's avatar
update NSH docs  
patacongo committed
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 
<a <p><b>Command Syntax:</b></p>
<ul><pre>
rm &lt;file-path&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Remove the specified <code>&lt;file-path&gt;</code> name from the mounted file system.
  Recall that NuttX uses a <a href="NuttxUserGuide.html#FileSystemOverview"><i>pseudo</i> filesystem</a> for its root file
  system.
  The <code>rm</code> command can only be used to remove (unlink) files in volumes set up with the
  <a href="#cmdmount"><code>mount</code></a> command;
  it cannot be used to remove names in the <i>pseudo</i> filesystem.
</p>
<p><b>Example:</b></p>
<ul><pre>
nsh> ls /mnt/fs/testdir
/mnt/fs/testdir:
 TESTFILE.TXT
 EXAMPLE.TXT
nsh> rm /mnt/fs/testdir/example.txt
nsh> ls /mnt/fs/testdir
/mnt/fs/testdir:
 TESTFILE.TXT
nsh>
</pre></ul>
patacongo's avatar
NSH Documentation
patacongo committed
1380 1381 1382 
<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1383 
    <a name="cmdrmdir"><h2>2.24 Remove a Directory (rmdir)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1384 1385 1386 1387 
  </td>
</tr>
</table>
patacongo's avatar
update NSH docs  
patacongo committed
1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 
<a <p><b>Command Syntax:</b></p>
<ul><pre>
rmdir &lt;dir-path&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Remove the specified <code>&lt;dir-path&gt;</code> directory from the mounted file system.
  Recall that NuttX uses a <a href="NuttxUserGuide.html#FileSystemOverview"><i>pseudo</i> filesystem</a> for its root file
  system.
  The <code>rmdir</code> command can only be used to remove directories from volumes set up with the
  <a href="#cmdmount"><code>mount</code></a> command;
  it cannot be used to remove directories from the <i>pseudo</i> filesystem.
</p>
<p><b>Example:</b></p>
<ul><pre>
nsh> mkdir /mnt/fs/tmp
nsh> ls -l /mnt/fs
/mnt/fs:
 drw-rw-rw-       0 TESTDIR/
 drw-rw-rw-       0 TMP/
nsh> rmdir /mnt/fs/tmp
nsh> ls -l /mnt/fs
/mnt/fs:
 drw-rw-rw-       0 TESTDIR/
nsh>
</pre></ul>
patacongo's avatar
NSH Documentation
patacongo committed
1415 1416 1417 
<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1418 
    <a name="cmdset"><h2>2.25 Set an Environment Variable (set)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 
  </td>
  </tr>
</table>

<a <p><b>Command Syntax:</b></p>
<ul><pre>
set &lt;name&gt; &lt;value&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Set the environment variable <code>&lt;name&gt;</code> to the string <code>&lt;value&gt;</code>.
  For example,
</p>
<ul><pre>
nsh&gt; echo $foobar

nsh&gt; set foobar foovalue
nsh&gt; echo $foobar
foovalue
nsh&gt;
</pre></ul>

<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1444 
    <a name="cmdsh"><h2>2.26 Execute an NSH Script (sh)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 
  </td>
  </tr>
</table>

<a <p><b>Command Syntax:</b></p>
<ul><pre>
sh &lt;script-path&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Execute the sequence of NSH commands in the file referred
  to by <code>&lt;script-path&gt;.
</p>

<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1462 
    <a name="cmdsleep"><h2>2.27 Wait for Seconds (sleep)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 
  </td>
  </tr>
</table>

<a <p><b>Command Syntax:</b></p>
<ul><pre>
sleep &lt;sec&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Pause execution (sleep) for <code>&lt;sec&gt;</code> seconds.
</p>

<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1479 
    <a name="cmdunmount"><h2>2.28 Unmount a File System (umount)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1480 1481 1482 1483 
  </td>
</tr>
</table>
patacongo's avatar
update NSH docs  
patacongo committed
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 
<a <p><b>Command Syntax:</b></p>
<ul><pre>
umount &lt;dir-path&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Un-mount the file system at mount point <code>&lt;dir-path&gt;</code>.
  The <code>umount</code> command can only be used to un-mount volumes previously mounted using
  <a href="#cmdmount"><code>mount</code></a> command.
</p>
<p><b>Example:</b></p>
<ul><pre>
nsh> ls /mnt/fs
/mnt/fs:
 TESTDIR/
nsh> umount /mnt/fs
nsh> ls /mnt/fs
/mnt/fs:
nsh: ls: no such directory: /mnt/fs
nsh>
</pre></ul>
patacongo's avatar
NSH Documentation
patacongo committed
1506 1507 1508 
<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1509 
    <a name="cmdunset"><h2>2.29 Unset an Environment Variable (unset)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 
  </td>
  </tr>
</table>

<a <p><b>Command Syntax:</b></p>
<ul><pre>
unset &lt;name&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Remove the value associated with the environment variable
  <code>&lt;name&gt;.  Example:
</p>
<ul><pre>
nsh&gt; echo $foobar
foovalue
nsh&gt; unset foobar
nsh&gt; echo $foobar

nsh&gt;
</pre></ul>

<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1535 
    <a name="cmdusleep"><h2>2.30 Wait for Microseconds (usleep)</h2></a>
patacongo's avatar
NSH Documentation
patacongo committed
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 
  </td>
  </tr>
</table>

<a <p><b>Command Syntax:</b></p>
<ul><pre>
usleep &lt;usec&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Pause execution (sleep) of <code>&lt;usec&gt;</code> microseconds.
</p>
patacongo's avatar
Add NSH xd command  
patacongo committed
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 
<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
    <a name="cmdxd"><h2>2.31 Hexadecimal dump (xd)</h2></a>
  </td>
  </tr>
</table>

<a <p><b>Command Syntax:</b></p>
<ul><pre>
xd &lt;hex-address&gt; &lt;byte-count&gt;
</pre></ul>
<p>
  <b>Synopsis</b>.
  Dump <code>&lt;byte-count&gt;</code> bytes of data from address <code>&lt;hex-address&gt;</code>.
</p>
<p><b>Example:</b></p>
<ul><pre>
nsh> xd 410e0 512
Hex dump:
0000: 00 00 00 00 9c 9d 03 00 00 00 00 01 11 01 10 06 ................
0010: 12 01 11 01 25 08 13 0b 03 08 1b 08 00 00 02 24 ....%..........$
...
01f0: 08 3a 0b 3b 0b 49 13 00 00 04 13 01 01 13 03 08 .:.;.I..........
nsh>
</pre></ul>
patacongo's avatar
NSH Documentation
patacongo committed
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 
<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
    <a name="configuration"><h1>3.0 Configuration Settings</h1></a>
  </td>
  </tr>
</table>

<p>
  The availability of the above commands depends upon features that
  may or may not be enabled in the NuttX configuration file.  The 
  following <a href="#cmddependencies">table</a> indicates the dependency of each command on NuttX
  configuration settings.  General configuration settings are discussed
  in the <a href="NuttxPortingGuide.html">NuttX Porting Guide.</a>
  Configuration settings specific to NSH as discussed at the <a href="#nshconfiguration">bottom</a> of this document.
</p>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1593 1594 1595 1596 1597 1598 1599 
<p>
  Note that in addition to general NuttX configuation settings, each NSH command can be
  individually disabled via the settings in the rightmost column.
  All of these settings make the configuration of NSH potentially complex but also allow it to
  squeeze into very small memory footprints.
</p>
patacongo's avatar
NSH Documentation
patacongo committed
1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 
<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
    <a name="cmddependencies"><h2>3.1 Command Dependencies on Configuration Settings</h2></a>
  </td>
  </tr>
</table>

<center><p>Table. Command Dependencies on Configuration Settings</p>
<table width="100%">
  <tr bgcolor="#e4e4e4">
    <th align="left" width="25%">Command</th>
    <th align="left">Depends on Configuration</th>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1613 
    <th align="left">Can Be Disabled with</th>
patacongo's avatar
NSH Documentation
patacongo committed
1614 1615 1616 1617 
  </tr>
  <tr>
    <td><b><code>[</code></b></td>
    <td>!<code>CONFIG_EXAMPLES_NSH_DISABLESCRIPT</code></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1618 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_TEST</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1619 1620 1621 1622 
  </tr>
  <tr>
    <td><b><code>cat</code></b></td>
    <td><code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0</td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1623 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_CAT</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1624 1625 1626 
  </tr>
  <tr>
    <td><b><code>cd</code></b></td>
patacongo's avatar
ROMFS filesystem support  
patacongo committed
1627 
    <td>!<code>CONFIG_DISABLE_ENVIRON</code> &amp;&amp; <code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0</td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1628 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_CD</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1629 1630 1631 1632 
  </tr>
  <tr>
    <td><b><code>cp</code></b></td>
    <td><code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0</td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1633 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_CP</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1634 1635 1636 1637 
  </tr>
  <tr>
    <td><b><code>echo</code></b></td>
    <td><br></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1638 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_ECHO</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1639 1640 1641 1642 
  </tr>
  <tr>
    <td><b><code>exec</code></b></td>
    <td><br></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1643 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_EXEC</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1644 1645 1646 1647 
  </tr>
  <tr>
    <td><b><code>exit</code></b></td>
    <td><br></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1648 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_EXIT</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1649 
  </tr>
patacongo's avatar
Add get and put commands to NSH  
patacongo committed
1650 1651 
  <tr>
    <td><b><code>get</code></b></td>
patacongo's avatar
TFTP needs larger MSS  
patacongo committed
1652 
    <td><code>CONFIG_NET</code> &amp;&amp; <code>CONFIG_NET_UDP</code> &amp;&amp;
patacongo's avatar
TFTP Get integration  
patacongo committed
1653 
        <code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0 &amp;&amp; <code>CONFIG_NET_BUFSIZE</code> &gt;= 558<sup>1</sup></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1654 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_GET</code></td>
patacongo's avatar
Add get and put commands to NSH  
patacongo committed
1655 
  </tr>
patacongo's avatar
NSH Documentation
patacongo committed
1656 1657 1658 
  <tr>
    <td><b><code>help</code></b></td>
    <td><br></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1659 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_HELP</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1660 1661 1662 1663 
  </tr>
  <tr>
    <td><b><code>ifconfig</code></b></td>
    <td><code>CONFIG_NET</code></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1664 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_IFCONFIG</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1665 1666 1667 1668 
  </tr>
  <tr>
    <td><b><code>ls</code></b></td>
    <td><code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0</td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1669 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_LS</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1670 1671 1672 1673 
  </tr>
  <tr>
    <td><b><code>mb,mh,mw</code></b></td>
    <td><br></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1674 1675 1676 1677 1678 
    <td>
      <code>CONFIG_EXAMPLES_NSH_DISABLE_MB</code>,<br>
      <code>CONFIG_EXAMPLES_NSH_DISABLE_MH</code>,<br>
      <code>CONFIG_EXAMPLES_NSH_DISABLE_MW</code>
    </td>
patacongo's avatar
NSH Documentation
patacongo committed
1679 1680 1681 1682 
  </tr>
  <tr>
    <td><b><code>mem</code></b></td>
    <td><br></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1683 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_MEM</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1684 1685 1686 
  </tr>
  <tr>
    <td><b><code>mkdir</code></b></td>
patacongo's avatar
ROMFS filesystem support  
patacongo committed
1687 
    <td>!<code>CONFIG_DISABLE_MOUNTPOINT</code> &amp;&amp; <code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0 &amp;&amp; <code>CONFIG_FS_WRITABLE</code><sup>4</sup></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1688 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_MKDIR</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1689 1690 1691 
  </tr>
  <tr>
    <td><b><code>mkfatfs</code></b></td>
patacongo's avatar
ROMFS filesystem support  
patacongo committed
1692 
    <td>!<code>CONFIG_DISABLE_MOUNTPOINT</code> &amp;&amp; <code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0 &amp;&amp; <code>CONFIG_FS_FAT</code></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1693 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_MKFATFS</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1694 1695 1696 
  </tr>
  <tr>
    <td><b><code>mkfifo</code></b></td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1697 
    <td><code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0</td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1698 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_MKFIFO</code></td>
patacongo's avatar
Add NSH command to create RAMDISK  
patacongo committed
1699 1700 1701 
  </tr>
  <tr>
    <td><b><code>mkrd</code></b></td>
patacongo's avatar
ROMFS filesystem support  
patacongo committed
1702 
    <td>!<code>CONFIG_DISABLE_MOUNTPOINT</code> &amp;&amp; <code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0 &amp;&amp; <code>CONFIG_FS_WRITABLE</code><sup>4</sup></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1703 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_MKRD</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1704 1705 1706 
  </tr>
  <tr>
    <td><b><code>mount</code></b></td>
patacongo's avatar
ROMFS filesystem support  
patacongo committed
1707 
    <td>!<code>CONFIG_DISABLE_MOUNTPOINT</code> &amp;&amp; <code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0 &amp;&amp; <code>CONFIG_FS_READABLE</code><sup>3</sup></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1708 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_MOUNT</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1709 1710 1711 
  </tr>
  <tr>
    <td><b><code>ping</code></b></td>
patacongo's avatar
TFTP needs larger MSS  
patacongo committed
1712 1713 1714 
    <td><code>CONFIG_NET</code> &amp;&amp; <code>CONFIG_NET_ICMP</code> &amp;&amp;
        <code>CONFIG_NET_ICMP_PING</code>  &amp;&amp; !<code>CONFIG_DISABLE_CLOCK</code> &amp;&amp;
        !<code>CONFIG_DISABLE_SIGNALS</code></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1715 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_PING</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1716 1717 1718 1719 
  </tr>
  <tr>
    <td><b><code>ps</code></b></td>
    <td><br></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1720 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_PS</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1721 
  </tr>
patacongo's avatar
Add get and put commands to NSH  
patacongo committed
1722 1723 
  <tr>
    <td><b><code>put</code></b></td>
patacongo's avatar
TFTP needs larger MSS  
patacongo committed
1724 
    <td><code>CONFIG_NET</code> &amp;&amp; <code>CONFIG_NET_UDP</code> &amp;&amp;
patacongo's avatar
TFTP put notes  
patacongo committed
1725 
    <code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0 &amp;&amp; <code>CONFIG_NET_BUFSIZE</code> &gt;= 558<sup>1,2</sup></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1726 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_PUT</code></td>
patacongo's avatar
Add get and put commands to NSH  
patacongo committed
1727 
  </tr>
patacongo's avatar
NSH Documentation
patacongo committed
1728 1729 1730 
  <tr>
    <td><b><code>pwd</code></b></td>
    <td>!<code>CONFIG_DISABLE_ENVIRON</code> &amp;&amp; <code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0</td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1731 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_PWD</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1732 1733 1734 
  </tr>
  <tr>
    <td><b><code>rm</code></b></td>
patacongo's avatar
ROMFS filesystem support  
patacongo committed
1735 
    <td>!<code>CONFIG_DISABLE_MOUNTPOINT</code> &amp;&amp; <code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0 &amp;&amp; <code>CONFIG_FS_WRITABLE</code><sup>4</sup></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1736 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_RM</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1737 1738 1739 
  </tr>
  <tr>
    <td><b><code>rmdir</code></b></td>
patacongo's avatar
ROMFS filesystem support  
patacongo committed
1740 
    <td>!<code>CONFIG_DISABLE_MOUNTPOINT</code> &amp;&amp; <code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0 &amp;&amp; <code>CONFIG_FS_WRITABLE</code><sup>4</sup></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1741 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_RMDIR</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1742 1743 1744 1745 
  </tr>
  <tr>
    <td><b><code>set</code></b></td>
    <td>!<code>CONFIG_DISABLE_ENVIRON</code></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1746 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_SET</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1747 1748 1749 1750 
  </tr>
  <tr>
    <td><b><code>sh</code></b></td>
    <td><code>CONFIG_NFILE_DESCRIPTORS &gt; 0 &amp;&amp; <code>CONFIG_NFILE_STREAMS &gt; 0 &amp;&amp; !<code>CONFIG_EXAMPLES_NSH_DISABLESCRIPT</code></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1751 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_SH</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1752 1753 1754 1755 
  </tr>
  <tr>
    <td><b><code>sleep</code></b></td>
    <td>!<code>CONFIG_DISABLE_SIGNALS</code></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1756 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_SLEEP</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1757 1758 1759 1760 
  </tr>
  <tr>
    <td><b><code>test</code></b></td>
    <td>!<code>CONFIG_EXAMPLES_NSH_DISABLESCRIPT</code></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1761 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_TEST</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1762 1763 1764 
  </tr>
  <tr>
    <td><b><code>umount</code></b></td>
patacongo's avatar
ROMFS filesystem support  
patacongo committed
1765 
    <td>!<code>CONFIG_DISABLE_MOUNTPOINT</code> &amp;&amp; <code>CONFIG_NFILE_DESCRIPTORS</code> &gt; 0 &amp;&amp; <code>CONFIG_FS_READABLE</code><sup>3</sup></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1766 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_UMOUNT</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1767 1768 1769 1770 
  </tr>
  <tr>
    <td><b><code>unset</code></b></td>
    <td>!<code>CONFIG_DISABLE_ENVIRON</code></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1771 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_UNSET</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1772 1773 1774 1775 
  </tr>
  <tr>
    <td><b><code>usleep</code></b></td>
    <td>!<code>CONFIG_DISABLE_SIGNALS</code></td>
patacongo's avatar
Allow each NSH command to be disabled  
patacongo committed
1776 1777 1778 1779 1780 1781 
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_USLEEP</code></td>
  </tr>
  <tr>
    <td><b><code>xd</code></b></td>
    <td><br></td>
    <td><code>CONFIG_EXAMPLES_NSH_DISABLE_XD</code></td>
patacongo's avatar
NSH Documentation
patacongo committed
1782 1783 1784 
  </tr>
</table></center>
patacongo's avatar
TFTP put notes  
patacongo committed
1785 
<p><sup>1</sup><small>
patacongo's avatar
ROMFS filesystem support  
patacongo committed
1786 1787 
  Because of hardware padding, the actual required packet size may be larger</small><br>
  <sup>2</sup><small>
patacongo's avatar
TFTP put notes  
patacongo committed
1788 
  Special TFTP server start-up optionss will probably be required to permit
patacongo's avatar
ROMFS filesystem support  
patacongo committed
1789 1790 1791 1792 1793 1794 1795 1796 1797 
  creation of files for the correct operation of the <code>put</code> command.</small><br>
  <sup>3</sup><small>
  <code>CONFIG_FS_READABLE</code> is not a user configuration but is set automatically
  if any readable filesystem is selected.  At present, this is either <code>CONFIG_FS_FAT</code>
  or <code>CONFIG_FS_ROMFS</code>.</small><br>
  <sup>4</sup><small>
  <code>CONFIG_FS_WRITABLE</code> is not a user configuration but is set automatically
  if any writable filesystem is selected.  At present, this is only <code>CONFIG_FS_FAT</code>.</small><br>
</p>
patacongo's avatar
TFTP Get integration  
patacongo committed
1798
patacongo's avatar
NSH Documentation
patacongo committed
1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 
<table width ="100%">
  <tr bgcolor="#e4e4e4">
  <td>
    <a name="nshconfiguration"><h2>3.2  NSH-Specific Configuration Settings</h2></a>
  </td>
  </tr>
</table>

<p>
  The behavior of NSH can be modified with the following settings in
  the <code>configs/&lt;board-name&gt;/defconfig</code> file:
</p>

<center><table width="100%">
  <tr bgcolor="#e4e4e4">
    <th align="left" width="25%">Configuration</th>
    <th align="left">Description</th>
  </tr>
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1818 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_FILEIOSIZE</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1819 1820 
    <td>
      Size of a static I/O buffer used for file access (ignored if
patacongo's avatar
Add /etc via ROMFS and /tmp via FAT FS to NSH  
patacongo committed
1821 
      there is no filesystem). Default is 1024.
patacongo's avatar
NSH Documentation
patacongo committed
1822 1823 1824 
    </td>
  </tr>
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1825 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_STRERROR</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1826 1827 1828 1829 1830 1831 
    <td>
      strerror(errno) makes more readable output but strerror() is
      very large and will not be used unless this setting is <i>y</i>
    </td>
  </tr>
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1832 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_LINELEN</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1833 1834 1835 1836 1837 1838 
    <td>
      The maximum length of one command line and of one output line.
      Default: 80
    </td>
  </tr>
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1839 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_STACKSIZE</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1840 1841 1842 1843 1844 1845 1846 
    <td>
      The stack size to use when spawning new threads or tasks.  Such
      new threads are generated when a command is executed in background
      or as new TELNET connections are established.
    </td>
  </tr>
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1847 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_NESTDEPTH</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1848 1849 1850 1851 1852 1853 
    <td>
      The maximum number of nested <a href="#conditional"><code>if-then[-else]-fi</code></a> sequences that
      are permissable.  Default: 3
    </td>
  </tr>
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1854 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_DISABLESCRIPT</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1855 1856 1857 1858 1859 1860 1861 1862 
    <td>
      This can be set to <i>y</i> to suppress support for scripting.  This
      setting disables the <a href="#cmdsh"><code>sh</code></a>, <a href="#cmdtest"><code>test</code></a>, and <a href="#cmtest"><code>[</code></a> commands and the
      <a href="#conditional"><code>if-then[-else]-fi</code></a> construct.  This would only be set on systems
      where a minimal footprint is a necessity and scripting is not.
    </td>
  </tr>
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1863 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_DISABLEBG</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1864 1865 1866 1867 1868 1869 1870 
    <td>
      This can be set to <i>y</i> to suppress support for background
      commands.  This setting disables the <a href="#cmdoverview"><code>nice</code></a> command prefix and
      the <a href="#cmdoverview"><code>&amp;</code></a> command suffix.  This would only be set on systems
      where a minimal footprint is a necessity and background command execution is not.
    </td>
  </tr>
patacongo's avatar
Add NXP LPC214x-specific NSH support  
patacongo committed
1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 
  <tr>
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_MMCSDMINOR</code></b></td>
    <td>
      If the architecture supports an MMC/SD slot and if the NSH
      architecture specific logic is present, this option will provide
      the MMC/SD minor number, i.e., the MMC/SD block driver will
      be registered as <code>/dev/mmcsd</code><i>N</i> where <i>N</i> is the minor number.
      Default is zero.
    </td>
  </tr>
patacongo's avatar
Add /etc via ROMFS and /tmp via FAT FS to NSH  
patacongo committed
1881 1882 1883 1884 1885 1886 1887 1888 1889 
  <tr>
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_ROMFSETC</code></b></td>
    <td>
      Mount a ROMFS filesystem at <code>/etc</code> and provide a startup script
      at <code>/etc/init.d/rcS</code>.  The default startup script will mount
      a FAT FS RAMDISK at <code>/tmp</code> but the logic is
      <a href="#startupscript">easily extensible</a>.
    </td>
  </tr>
patacongo's avatar
NSH Documentation
patacongo committed
1890 
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1891 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_CONSOLE</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1892 1893 1894 1895 1896 1897 
    <td>
      If <code>CONFIG_EXAMPLES_NSH_CONSOLE</code>is set to <i>y</i>, then a serial
      console front-end is selected.
    </td>
  </tr>
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1898 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_TELNET</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1899 1900 1901 1902 1903 1904 1905 
    <td>
      If <code>CONFIG_EXAMPLES_NSH_TELNET</code> is set to <i>y</i>, then a TELENET
      server front-end is selected.  When this option is provided,
      you may log into NuttX remotely using telnet in order to
      access NSH.
    </td>
  </tr>
patacongo's avatar
update NSH docs  
patacongo committed
1906 
</table></center>
patacongo's avatar
NSH Documentation
patacongo committed
1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 

<p>
  One or both of <code>CONFIG_EXAMPLES_NSH_CONSOLE</code> and <code>CONFIG_EXAMPLES_NSH_TELNET</code>
  must be defined.  If <code>CONFIG_EXAMPLES_NSH_TELNET</code> is selected, then there some
  other configuration settings that apply:
</p>

<center><table width="100%">
  <tr bgcolor="#e4e4e4">
    <th align="left" width="25%">Configuration</th>
    <th align="left">Description</th>
  </tr>
patacongo's avatar
Add /etc via ROMFS and /tmp via FAT FS to NSH  
patacongo committed
1919 
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1920 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_IOBUFFER_SIZE</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1921 1922 1923 1924 1925 1926 
    <td>
      Determines the size of the I/O buffer to use for sending/
      receiving TELNET commands/reponses
    </td>
  </tr>
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1927 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_DHCPC</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1928 1929 1930 1931 1932 
    <td>
      Obtain the the IP address via DHCP.
    </td>
  </tr>
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1933 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_IPADDR</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1934 1935 1936 1937 1938 1939 
    <td>
      If <code>CONFIG_EXAMPLES_NSH_DHCPC</code> is NOT set, then the static IP
      address must be provided.
    </td>
  </tr>
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1940 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_DRIPADDR</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1941 1942 1943 1944 1945 
    <td>
      Default router IP address
    </td>
  </tr>
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1946 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_NETMASK</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1947 1948 1949 1950 1951 
    <td>
      Network mask
    </td>
  </tr>
  <tr>
patacongo's avatar
update NSH docs  
patacongo committed
1952 
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_NOMAC</code></b></td>
patacongo's avatar
NSH Documentation
patacongo committed
1953 1954 1955 1956 1957 
    <td>
      Set if your ethernet hardware has no built-in MAC address.
      If set, a bogus MAC will be assigned.
    </td>
  </tr>
patacongo's avatar
update NSH docs  
patacongo committed
1958 1959 
</table></center>
patacongo's avatar
Add /etc via ROMFS and /tmp via FAT FS to NSH  
patacongo committed
1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 
<p>
  If <code>CONFIG_EXAMPLES_NSH_ROMFSETC</code> is selected, then the following additional
  configuration setting apply:
</p>

<center><table width="100%">
  <tr bgcolor="#e4e4e4">
    <th align="left" width="25%">Configuration</th>
    <th align="left">Description</th>
  </tr>
  <tr>
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_ROMFSMOUNTPT</code></b></td>
    <td>
      The default mountpoint for the ROMFS volume is <code>&quot;/etc&quot;</code>, but that
      can be changed with this setting.  This must be a absolute path
      beginning with '<code>/</code>' and enclosed in quotes.
    </td>
  </tr>
  <tr>
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_INITSCRIPT</code></b></td>
    <td>
      This is the relative path to the startup script within the mountpoint.
      The default is <code>&quot;init.d/rcS&quot;</code>.  This is a relative path and must not
      start with '<code>/</code>' but must be enclosed in quotes.
    </td>
  </tr>
  <tr>
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_ROMFSDEVNO</code></b></td>
    <td>
      This is the minor number of the ROMFS block device.  The default is
      '<code>0</code>' corresponding to <code>/dev/ram0</code>.
    </td>
  </tr>
  <tr>
    <td valign="top"><b><code>CONFIG_EXAMPLES_NSH_ROMFSSECTSIZE</code></b></td>
    <td>
      This is the sector size to use with the ROMFS volume.  Since the
      default volume is very small, this defaults to 64 but should be
      increased if the ROMFS volume were to be become large.  Any value
      selected must be a power of 2.
    </td>
Show full blame