AmigaOS Manual: AmigaDOS Command Examples - Revision history

Janne Peräaho: /* Modifying the Prompt */

2021-01-31T15:17:08Z

Modifying the Prompt

← Older revision		Revision as of 15:17, 31 January 2021
Line 404:		Line 404:
	Figure 8-2 illustrates two ways of modifying the prompt. The first uses escape sequences to produce a boldface, color 2 (white) prompt; see Appendix D for a listing of escape sequences. The second shifts the usual position of the substitution operators, embeds a DATE command using the back apostrophe, and changes the final character to a dollar sign ($).		Figure 8-2 illustrates two ways of modifying the prompt. The first uses escape sequences to produce a boldface, color 2 (white) prompt; see Appendix D for a listing of escape sequences. The second shifts the usual position of the substitution operators, embeds a DATE command using the back apostrophe, and changes the final character to a dollar sign ($).

	[[File:DosFig8-2.png\|~~center~~\|frame\|Sample Uses of PROMPT Command]]		[[File:DosFig8-2.png\|none\|frame\|Sample Uses of PROMPT Command]]

	== Creating a Custom Ram Disk Icon ==		== Creating a Custom Ram Disk Icon ==

Janne Peräaho: /* Creating an Assignment */

2021-01-31T15:16:59Z

Creating an Assignment

← Older revision		Revision as of 15:16, 31 January 2021
Line 267:		Line 267:
	On a floppy-only system, a requester similar to that illustrated in Figure 8-1 usually means that you need to insert the named floppy disk.		On a floppy-only system, a requester similar to that illustrated in Figure 8-1 usually means that you need to insert the named floppy disk.

	[[File:DosFig8-1.png\|~~center~~\|frame\|Command Sample System Requester]]		[[File:DosFig8-1.png\|none\|frame\|Command Sample System Requester]]

	The most likely reason for this requester on a hard disk system, aside from entering a command with a misplaced colon (:), is that an application you are running requires an assignment to be made with the ASSIGN command. This is often done for you by an installation program, but not all applications have an installation program or one that works correctly for all systems.		The most likely reason for this requester on a hard disk system, aside from entering a command with a misplaced colon (:), is that an application you are running requires an assignment to be made with the ASSIGN command. This is often done for you by an installation program, but not all applications have an installation program or one that works correctly for all systems.

Janne Peräaho: /* Stopping a Program */

2020-06-24T02:56:34Z

Stopping a Program

← Older revision		Revision as of 02:56, 24 June 2020
Line 43:		Line 43:
	== Stopping a Program ==		== Stopping a Program ==

			AmigaDOS commands and most Workbench programs started from the Shell can be exited, or stopped if currently running, by pressing <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">Ctrl</kbd> + <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">C</kbd>. This is important in case you need to abort a pattern matching DELETE, or to interrupt a directory listing or other lengthy process. Scripts can be stopped with <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">Ctrl</kbd> + <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">D</kbd>.
	AmigaDOS commands and most Workbench programs started from the Shell can be exited, or stopped if currently running, by pressing Ctrl+C. This is important in case you need to abort a pattern matching DELETE, or to interrupt a directory listing or other lengthy process. Scripts can be stopped with Ctrl+D.

	To stop a command or program that is currently running:		To stop a command or program that is currently running:

	# Make the Shell window from which the command or program was started the current window by clicking in it.		# Make the Shell window from which the command or program was started the current window by clicking in it.
			# Press <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">Ctrl</kbd> + <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">C</kbd>.
	# Press Ctrl+C.

			In some cases you may need to press Return after <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">Ctrl</kbd> + <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">C</kbd> to bring back the Shell prompt.
	In some cases you may need to press Return after Ctrl+C to bring back the Shell prompt.

	To stop a script that is currently running:		To stop a script that is currently running:

	# Make the Shell window from which the script was started the current window by clicking in it.		# Make the Shell window from which the script was started the current window by clicking in it.
			# Press <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">Ctrl</kbd> + <kbd class="keyboard-key nowrap" style="border: 1px solid #aaa; border-radius: 0.2em; box-shadow: 0.1em 0.2em 0.2em #ddd; background-color: #f9f9f9; background-image: -moz-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -o-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: -webkit-linear-gradient(top, #eee, #f9f9f9, #eee); background-image: linear-gradient(to bottom, #eee, #f9f9f9, #eee); padding: 0.1em 0.3em; font-family: inherit; font-size: 0.85em;">D</kbd>.
	# Press Ctrl+D.

	== Changing the Current Directory ==		== Changing the Current Directory ==

Rob Cranley: /* Recursive AmigaDOS Command Scripts */ Fix typo that would prevent example script from working (Z: -> T:)

2019-01-15T10:08:29Z

Recursive AmigaDOS Command Scripts: Fix typo that would prevent example script from working (Z: -> T:)

← Older revision		Revision as of 10:08, 15 January 2019
Line 747:		Line 747:
	; files were found, execute the new script and		; files were found, execute the new script and
	; clean up		; clean up
	EXECUTE Z:trf{$$}		EXECUTE T:trf{$$}
	DELETE T:trf{$$}		DELETE T:trf{$$}
	ENDIF		ENDIF

Steven Solie: /* Testing Software Versions */

2014-04-21T19:06:56Z

Testing Software Versions

← Older revision		Revision as of 19:06, 21 April 2014
Line 606:		Line 606:
	You might need to control what a script does depending on which software version a user of the script has. It is easy to test for specific version numbers from a script.		You might need to control what a script does depending on which software version a user of the script has. It is easy to test for specific version numbers from a script.

	To test whether a script is running on an Amiga with Release 2 level system software, preface the version-dependent portion of the script with a sequence similar to this:		To test whether a script is running on an Amiga with Release 4 level system software, preface the version-dependent portion of the script with a sequence similar to this:

	VERSION >NIL: 37		VERSION >NIL: 50
	IF WARN		IF WARN
	ECHO "It's really time to update your system."		ECHO "It's really time to update your system."
	QUIT		QUIT
	ELSE		ELSE
	ECHO "You have Release 2 or better. Good!"		ECHO "You have Release 4 or better. Good!"
	ECHO "Let's continue."		ECHO "Let's continue."
	ENDIF		ENDIF

	Versions below 37 are pre-Release ~~2, version 38 is Release 2~~.1, ~~version~~ 39 is ~~Release~~ 3, ~~version~~ 40 is ~~Release~~ ~~3.1 and version 44 is Release 3.5~~.		Versions below 50 are pre-Release 4. See [[AmigaOS_Versions\|AmigaOS Versions]] for a complete list of release versions.

	== Flushing Unused Fonts and Libraries ==		== Flushing Unused Fonts and Libraries ==

Steven Solie: /* Recursive AmigaDOS Command Scripts */

2014-04-06T21:26:38Z

Recursive AmigaDOS Command Scripts

← Older revision		Revision as of 21:26, 6 April 2014
Line 752:		Line 752:
	;		;
	;list any subdirectories, call RPAT for each one:		;list any subdirectories, call RPAT for each one:
	LIST >T:trd{$$}{RD} "{PATH}" ~~FIRS~~ LFORMAT="RPAT "{COM}" "%p%n" "{OPT}" RD=.{RD}"		LIST >T:trd{$$}{RD} "{PATH}" DIRS LFORMAT="RPAT "{COM}" "%p%n" "{OPT}" RD=.{RD}"
	;the RD argument appends periods to the names of		;the RD argument appends periods to the names of
	;the temporary script files to distinguish each		;the temporary script files to distinguish each

Steven Solie: /* Recursive AmigaDOS Command Scripts */

2014-04-06T21:25:19Z

Recursive AmigaDOS Command Scripts

← Older revision		Revision as of 21:25, 6 April 2014
Line 752:		Line 752:
	;		;
	;list any subdirectories, call RPAT for each one:		;list any subdirectories, call RPAT for each one:
	LIST >T:trd{$$} {RD} "{PATH}" FIRS LFORMAT="RPAT "{COM}" "%p%n" "{OPT}" RD=.{RD}"		LIST >T:trd{$$}{RD} "{PATH}" FIRS LFORMAT="RPAT "{COM}" "%p%n" "{OPT}" RD=.{RD}"
	;the RD argument appends periods to the names of		;the RD argument appends periods to the names of
	;the temporary script files to distinguish each		;the temporary script files to distinguish each
	;level		;level
	;		;
	IF EXISTS T:trd{$$} {RD}		IF EXISTS T:trd{$$}{RD}
	; subdirectories exist, execute new script		; subdirectories exist, execute new script
	; file and clean up		; file and clean up
	EXECUTE T:trd{$$} {RD}		EXECUTE T:trd{$$}{RD}
	DELETE T:trd{$$} {RD}		DELETE T:trd{$$}{RD}
	ENDIF		ENDIF

Steven Solie: /* Advanced Tasks */

2014-01-29T20:32:02Z

Advanced Tasks

Show changes

Steven Solie: /* Generating Scripts with LIST LFORMAT */

2014-01-29T20:14:32Z

Generating Scripts with LIST LFORMAT

← Older revision		Revision as of 20:14, 29 January 2014
Line 530:		Line 530:

	See the "Recursive AmigaDOS Command Script" example for a more advanced use of LIST LFORMAT.		See the "Recursive AmigaDOS Command Script" example for a more advanced use of LIST LFORMAT.

			== Customizing LIST Output ==

			You can also use LFORMAT to customize the output of LIST for special purposes. Save the line as an alias to make it easier to use in the future.

			To create an alias for LIST that displays information only on files created since the date you enter, with the date first and protection bits and time omitted:

			1> ALIAS lsince LIST FILES SINCE [] LFORMAT="%D%-25N %L"

			If the current directory is S:, the output of lsince 01-sep-92 would be similar to this:

			19-Oct-92 PCD 715
			30-Nov-92 Startup-sequence 1360
			Friday Shell-startup 671
			Yesterday User-startup 609

			== Using ICONX to Run Scripts ==

			If you prefer to work with the mouse whenever possible or you are setting up an Amiga for a Workbench-only user, ICONX is useful. Using C:ICONX as the Default Tool of a project icon lets you run a script (or a command that lacks a Workbench interface) from the icon. It lets you start the script by opening the icon, as if the script were a standard Workbench tool.

			There are also advantages to starting programs this way for the advanced user, including scripting preparatory steps (such as loading special Preferences presets) before launching a program and allowing the program's task priority to be changed easily. The following example demonstrates these techniques.

			To start an application called OldApp from an ICONX icon, first loading a special Preferences font preset, and adjusting the application's task priority, create this script for the icon:

			CD SYS:
			Prefs/Font FROM SYS:Prefs/Presets/defscrn.pre USE
			CHANGETASKPRI -1
			OldApp

			== Preventing Displayable Output From Scripts ==

			In scripts, you often want to execute a command without the command displaying its usual Shell output. This can prevent an unnecessary series of messages or keep an output window from opening at an inopportune time.

			To prevent all console output, redirect command output to a dummy destination with the >NIL: argument:

			1> DELETE >NIL: T:Tempfile

			The >NIL: argument prevents the printing of the message T:Tempfile Deleted , or any error messages.

			To prevent console output except for error messages, use the QUIET option with those commands that support it:

			1> DELETE T:Tempfile QUIET

			The T:Tempfile Deleted message is not printed; however, if T:Tempfile does not exist, the No file to delete message appears.

			== Entering and Testing ARexx Macros ==

			To make entering and testing ARexx macros simpler:

			Enter the following AmigaDOS script and save it as S:Edrx:

			.KEY mac
			ED REXX:<mac>.rexx
			PROTECT S:<mac>.rexx +S-E
			RX REXX:<mac>

			Use this script when experimenting with ARexx macros. Enter Edrx followed bythe name of the macro. Edrx invokes the editor without you having to type in the .rexx extension and directly calls the ARexx interpreter RX with your macro as an argument when you exit.

			== Sorting and Joining Files ==

			If you regularly capture a list of new files each time you log on to a telecommunications service, you might want to add them to a list of existing files and sort all the entries by date. Each file name has the same prefix and a suffix that reflects the date, such as NewFiles.921009 for the list of files on October 9, 1992.

			To create a single list of the files, sorted by date, use a pattern matching JOIN and SORT:

			JOIN NewFiles.#? TO RAM.Temp.joined
			SORT RAM:Temp.joined TO NewFiles.sorted
			DELETE RAM:Temp.joined

			= Advanced Tasks =

			The following examples illustrate advanced tasks for users who are quite familiar with AmigaDOS.

Steven Solie: /* Modifying the Prompt */

2014-01-29T20:11:19Z

Modifying the Prompt

← Older revision		Revision as of 20:11, 29 January 2014
Line 405:		Line 405:

	[[File:DosFig8-2.png\|center\|frame\|Sample Uses of PROMPT Command]]		[[File:DosFig8-2.png\|center\|frame\|Sample Uses of PROMPT Command]]

			== Creating a Custom Ram Disk Icon ==

			To have a custom icon for the Ram Disk, you need to place a COPY statement in User-startup. First, create the icon in IconEdit. Make sure it is a Disk type icon, then save it on your boot disk as DEVS:Ramdisk.info.

			{{Note\|This example uses the DEVS: directory, but it does not matter where you store this icon. It is not visible, even in Show All Files mode, because Disk icons are visible only in the Workbench window.}}

			To make your custom Ram Disk icon appear in the Workbench window, enter this line in the S:User-startup file, save the changed file, and reboot:

			COPY DEVS:Ramdisk.info TO RAM:disk.info

			If you also want to rename Ram Disk, include a RELABEL statement in User-startup after the COPY statement, such as:

			RELABEL RAM:ramname

			== Deleting Files with Icons ==

			To delete a file that has an icon and the file's.info file with a single command:

			1. Create and save the following script as S:Delinf:

			.KEY file/A
			DELETE <file> <file>.info QUIET

			2. Enter EXECUTE Delinf with the name of the file as its argument.

			== Testing Commands ==

			It is sometimes necessary to test the results of certain commands before using them on actual files. This is particularly true when using complex pattern matching with potentially destructive commands, such as DELETE, or escape sequences, with which it can be difficult to predict the outcome. There are various ways of testing commands that are quick and safe.

			To test a potentially destructive pattern matching command:

			# Enter a non-destructive command such as LIST containing the pattern. For example,<br/>LIST ~ (#?.info\|#?.c\| [0-9]#?)
			# Check the output to see whether the intended files were matched.
			# Modify the pattern if necessary and repeat the command until the command lists only the desired files.
			# Enter the intended command, using the same pattern.

			To test the effects of escape sequences:

			# Enter an ECHO command containing the escape sequences and an example word. For example,<br/>ECHO "E[1mBOLDE[Om"
			# Check to see whether the output is as intended.
			# Modify the escape sequences if necessary and repeat the command until the desired result appears.
			# Use the escape sequences in the intended command, such as PROMPT.

			To clear the window and reset all escape sequence modes to the defaults, enter:

			Esc,c,Return

			You must use a lower case c. After the window is cleared and reset, the Shell displays a harmless :Unknown command message on the window's top line.

			To create a test file in the Ram Disk, enter:

			1> ECHO "This is only a test" TO RAM:foo

			This provides a small, expendable file on which to test other commands. It is best to create such files in RAM:, to avoid cluttering your disks with small, useless files. Traditionally, files like this are named "foo" or "bar."

			To test commands safely on actual files, copy the files to a directory in the Ram Disk and test with those files:

			1> COPY Work:MyFiles/#? TO RAM:Testdir

			== Creating a Script to Move Files ==

			AmigaDOS does have a Move command which normally should be used to move files. There are two other ways of moving a file with AmigaDOS: a RENAME command or a combination of COPY and DELETE commands.

			Using RENAME to move a file is possible only when moving the file to a destination on the same volume. Attempting to rename across devices causes an error. The copy-and-delete method works in any situation, but is cumbersome.

			To create a Move command that lets you move a file within or across devices with a single command, create a script with the following commands:

			1> RUN ED S:Move+
			PROTECT S:Move swrd

			Enter these commands in the ED window:

			.KEY source/A, to/A
			.BRA {
			.KET }
			FAILAT 21
			RENAME >NIL: {source} TO {to}
			IF WARN
			COPY {source} TO {to}
			IF WARN
			ECHO "The file {source} could not be moved."
			QUIT 20
			ENDIF
			DELETE {source} QUIET
			ENDIF
			ECHO {source} "has been moved to" {to}

			Save the script and exit ED. The s protection bit is automatically set after you exit.

			Use this script the same as you would use a command. Enter MOVE followed by two arguments: the current path of the file to move and the path to the desired location.

			== Deleting with Interactive DIR ==

			The DIR command has an interactive mode that pauses after each file or directory it lists and allows you to enter one of several simple commands. One option is to delete the item, which can be useful in certain situations.

			For example, if you accidentally name a file #? (the wildcard combination that matches anything), attempting to delete it through normal methods is inadvisable. This is because DELETE #? Deletes everything in the directory, including any other valuable files that are there.

			The interactive DIR can solve this problem and be used as a general-purpose query/delete tool. This is helpful when you have a large directory containing many items to delete, but the file names do not have enough in common to make a pattern matching DELETE practical.

			To delete various files on a disk called Debris safely with an interactive DIR, enter:

			1> DIR Debris: INTER

			DIR lists the names of the files in Debris alphabetically one by one, each followed by a question mark prompt. Press Return to go to the next file or E to enter a directory. When the name of an unwanted file appears, enter DEL to delete the file. Enter Q to leave the interactive DIR.

			== Generating Scripts with LIST LFORMAT ==

			One of the prime uses of the LIST command's LFORMAT option is for automatically creating scripts used to process a series of files. You can produce a raw script using a LIST statement with LFORMAT, a TO argument to redirect the LIST output to a file, and pattern matching. You can then view the script and edit it manually if necessary before executing it.

			To create a script that renames all the files in the current directory, adds the extension .IFF to their present file names, and places them in a directory called Paintfiles in the Work partition:

			1> LIST #? TO T:renamer LFORMAT="RENAME %P%N TO Work:Paintfiles/%N.IFF"

			Enter ED T:renamer to check the script, which should resemble the following. If the match pattern lists files that you did not want processed or your LFORMAT string does not work as expected, you can edit the script or modify and reenter the command.

			RENAME Paint:Vince TO Work:Paintfiles/Vince.IFF
			RENAME Paint:Henro TO Work:Paintfiles/Henri.IFF
			RENAME Paint:Paul TO Work:Paintfiles/Paul.IFF
			RENAME Paint:Pablo TO Work:Paintfiles/Pablo.IFF
			RENAME Paint:Andy TO Work:Paintfiles/Andy.IFF

			When the script is correct, leave ED and enter EXECUTE T:renamer .

			See the "Recursive AmigaDOS Command Script" example for a more advanced use of LIST LFORMAT.