- Timestamp:
- 11/18/14 13:05:15 (9 years ago)
- Branches:
- 4.11, 5, master
- Children:
- 8dbc612
- Parents:
- 478455e0
- git-author:
- Sebastian Huber <sebastian.huber@…> (11/18/14 13:05:15)
- git-committer:
- Sebastian Huber <sebastian.huber@…> (11/20/14 09:30:26)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/shell/general.t
r478455e0 r3fe5d01 14 14 @item @code{help} - Print command help 15 15 @item @code{alias} - Add alias for an existing command 16 @item @code{cmdls} - List commands 17 @item @code{cmdchown} - Change user or owner of commands 18 @item @code{cmdchmod} - Change mode of commands 16 19 @item @code{date} - Print or set current date and time 17 20 @item @code{echo} - Produce message in a shell script … … 197 200 @c 198 201 @page 202 @subsection cmdls - List commands 203 204 @pgindex cmdls 205 206 @subheading SYNOPSYS: 207 208 @example 209 cmdls COMMAND... 210 @end example 211 212 @subheading DESCRIPTION: 213 214 This command lists the visible commands of the command set. 215 216 @subheading EXIT STATUS: 217 218 This command returns 0 on success and non-zero if an error is encountered. 219 220 @subheading NOTES: 221 222 The current user must have read permission to list a command. 223 224 @subheading EXAMPLES: 225 226 The following is an example of how to use @code{cmdls}: 227 228 @example 229 SHLL [/] # cmdls help shutdown 230 r-xr-xr-x 0 0 help 231 r-x------ 0 0 shutdown 232 @end example 233 234 @subheading CONFIGURATION: 235 236 @findex CONFIGURE_SHELL_NO_COMMAND_CMDLS 237 @findex CONFIGURE_SHELL_COMMAND_CMDLS 238 239 This command is included in the default shell command set. 240 When building a custom command set, define 241 @code{CONFIGURE_SHELL_COMMAND_CMDLS} to have this 242 command included. 243 244 This command can be excluded from the shell command set by 245 defining @code{CONFIGURE_SHELL_NO_COMMAND_CMDLS} when all 246 shell commands have been configured. 247 248 @subheading PROGRAMMING INFORMATION: 249 250 The configuration structure for the @code{cmdls} has the 251 following prototype: 252 253 @example 254 extern rtems_shell_cmd_t rtems_shell_CMDLS_Command; 255 @end example 256 257 @c 258 @c 259 @c 260 @page 261 @subsection cmdchown - Change user or owner of commands 262 263 @pgindex cmdchown 264 265 @subheading SYNOPSYS: 266 267 @example 268 cmdchown [OWNER][:[GROUP]] COMMAND... 269 @end example 270 271 @subheading DESCRIPTION: 272 273 This command changes the user or owner of a command. 274 275 @subheading EXIT STATUS: 276 277 This command returns 0 on success and non-zero if an error is encountered. 278 279 @subheading NOTES: 280 281 The current user must have an UID of zero or be the command owner to change the 282 owner or group. 283 284 @subheading EXAMPLES: 285 286 The following is an example of how to use @code{cmdchown}: 287 288 @example 289 [/] # cmdls help 290 r-xr-xr-x 0 0 help 291 [/] # cmdchown 1:1 help 292 [/] # cmdls help 293 r--r--r-- 1 1 help 294 @end example 295 296 @subheading CONFIGURATION: 297 298 @findex CONFIGURE_SHELL_NO_COMMAND_CMDCHOWN 299 @findex CONFIGURE_SHELL_COMMAND_CMDCHOWN 300 301 This command is included in the default shell command set. 302 When building a custom command set, define 303 @code{CONFIGURE_SHELL_COMMAND_CMDCHOWN} to have this 304 command included. 305 306 This command can be excluded from the shell command set by 307 defining @code{CONFIGURE_SHELL_NO_COMMAND_CMDCHOWN} when all 308 shell commands have been configured. 309 310 @subheading PROGRAMMING INFORMATION: 311 312 The configuration structure for the @code{cmdchown} has the 313 following prototype: 314 315 @example 316 extern rtems_shell_cmd_t rtems_shell_CMDCHOWN_Command; 317 @end example 318 319 @c 320 @c 321 @c 322 @page 323 @subsection cmdchmod - Change mode of commands 324 325 @pgindex cmdchmod 326 327 @subheading SYNOPSYS: 328 329 @example 330 cmdchmod OCTAL-MODE COMMAND... 331 @end example 332 333 @subheading DESCRIPTION: 334 335 This command changes the mode of a command. 336 337 @subheading EXIT STATUS: 338 339 This command returns 0 on success and non-zero if an error is encountered. 340 341 @subheading NOTES: 342 343 The current user must have an UID of zero or be the command owner to change the 344 mode. 345 346 @subheading EXAMPLES: 347 348 The following is an example of how to use @code{cmdchmod}: 349 350 @example 351 [/] # cmdls help 352 r-xr-xr-x 0 0 help 353 [/] # cmdchmod 544 help 354 [/] # cmdls help 355 r-xr--r-- 0 0 help 356 @end example 357 358 @subheading CONFIGURATION: 359 360 @findex CONFIGURE_SHELL_NO_COMMAND_CMDCHMOD 361 @findex CONFIGURE_SHELL_COMMAND_CMDCHMOD 362 363 This command is included in the default shell command set. 364 When building a custom command set, define 365 @code{CONFIGURE_SHELL_COMMAND_CMDCHMOD} to have this 366 command included. 367 368 This command can be excluded from the shell command set by 369 defining @code{CONFIGURE_SHELL_NO_COMMAND_CMDCHMOD} when all 370 shell commands have been configured. 371 372 @subheading PROGRAMMING INFORMATION: 373 374 The configuration structure for the @code{cmdchmod} has the 375 following prototype: 376 377 @example 378 extern rtems_shell_cmd_t rtems_shell_CMDCHMOD_Command; 379 @end example 380 381 @c 382 @c 383 @c 384 @page 199 385 @subsection date - print or set current date and time 200 386
Note: See TracChangeset
for help on using the changeset viewer.