File: XTree:\Tips&Tricks\Command Line Options |Bottom_of_page


 

COMMAND LINE OPTIONS
====================

 
   
 
 
 
 

XTREEPRO/GOLD COMMAND LINE OPTIONS
----------------------------------

 
 

SYNTAX:
-------

 

- for XTreePro versions:

XTPRO.COM drive: /options

 

- for XTreeProGold and XTreeGold 2.0 versions:

XTGOLD.COM drive: /options

 

- for XTreeGold 2.50 to 3.0x versions:

XTGOLD.COM drive:\path filespec /options

"filespec" is a valid XTree file-specification, e.g. *.txt
(for drive:\path options see |Appendix i.)

 

NOTE:
- The settings determined by command line switches override the settings specified by the environment variable and by the configuration function (XTPROCFG resp. ALT-F10).
- The settings determined by the environment variable override the settings specified by the the configuration function (XTPROCFG resp. ALT-F10).
- Extra non-valid characters are ignored.


 
 

Argument
Function
Applies to
 
 
 
 
i. Display switches

 
 
 
 
/1
One column file display
XTP,XTPG,XTG
/2
Two column file display
XTP,XTPG,XTG
/3
Three column file display
XTP,XTPG,XTG
/43
43/50 line mode on
XTPG,XTG
/43-
43/50 line mode off
XTPG,XTG
/A
Tree cursor is anchored
XTP,XTPG,XTG
/A-
Tree cursor is moving (default)
XTP,XTPG,XTG
/C
Use a space as file/extension separator
XTP,XTPG,XTG
/C.
Use a period as file/extension separator (default)
XTP,XTPG,XTG
/DC
Composite CRT or Monochrome display
XTP,XTPG,XTG
/DD
CGA, EGA, or VGA color display
XTP,XTPG,XTG
/DN
No CRT snow, default=retrace wait (display is flicker-free)
XTP,XTPG,XTG
/DS
Snow on CRT (display is not flicker-free)
XTP,XTPG,XTG
/T
Scroll "bar and thumbs" are "arrows and lines"
XTPG,XTG
/XB
DOS cursor is a block
XTG
/XL
Lower case tree and file displays
XTG
/XM
Additionally display number of available (conventional RAM-) memory blocks (is being decreased by 1 for each file or directory logged)
XTP,XTPG,XTG
/Y
Disable restoration of the CRT blinking attribute
XTPG131+,XTG
/ZB
Skips displaying the box characters for the main screen. Only looks correct if you have different highlight/lowlight background colors configured.
XTG25+
/ZP
Progress bar time display. This command line switch enables time displays on the progress bar. When activated, two times are displayed. The first is the time in Minutes:Seconds that the function has taken so far. The second time is an estimate of time remaining based on the percentage complete and the accumulated time. This second time is only displayed after 10 seconds have gone by, or the operation is 50% complete, whichever comes first.
XTG3
 
 
 
 
ii. Log switches

 
 
 
 
/F#
Files/directory capacity (Maximum number of files/directories to be logged. Valid range is 100 to 65535)
XTP
/L1
Log 1st level only
XTG
/LF
Log method set to "full disk"
XTG3
/LQ
Quick log method (default)
XTP,XTPG,XTG
/LS
Standard log method
XTP,XTPG,XTG
/LT
Log tree only
XTG
/ZL
LogSpec command line switch enables "LogSpec" feature. Whenever a log command is executed, files that DO NOT match the filespec are NOT LOGGED when the feature is enabled via the command line switch. This lets you do things like:
  XTGOLD n: s: p: *.doc *.txt readme.* /LF /ZL
to log every doc, text, and readme file in every directory on drives N, S and P.

XTG3
 
 
 
 
iii. Print switches

 
 
 
 
/P#
Print specified lines-per-page (0..255)
XTP,XTPG,XTG
/PM
Printer 7 bit masking
XTP,XTPG,XTG
/PP
Print to printer
XTP,XTPG,XTG
/PS
Redirect the Print output to STDOUT (usually the screen (Same as the "Print to: CON" option in XTG3))
XTP,XTPG,
XTG20,XTG25

/PS>filename
Redirect the Print output to the specified file (Same as the "Print to: TEMPFILE" option in XTG3)
XTP,XTPG,
XTG20,XTG25

 
 
 
 
iv. File sort switches

 
 
 
 
/OA
Sort ascending
XTPG,XTG
/OD
Sort descending
XTPG,XTG
/SD
Sort by date
XTP,XTPG,XTG
/SE
Sort by extension
XTP,XTPG,XTG
/SS
Sort by size
XTP,XTPG,XTG
/SU
Unsorted display
XTP,XTPG,XTG
/XC
Skip automatic sort by path
XTP,XTPG
/XC
Skip Alt-Copy sort by path
XTG
/XP
Default sort by path in Branch/Showall/Global-view
XTP,XTPG,XTG

 
 
 
v. Behaviour switches

 
 
 
 
/E
Ignore missing overlay error messages
XTPG,XTG
/K
or /K+

Keep Filespec when performing another log command (Normally Filespec is set back to *.* on re-log)
XTP
/K-
Do not keep Filespec when performing another log command (Set Filespec back to *.* on re-log)
XTP
/Q
Quiet on, no beeps on errors
XTP,XTPG,XTG
/Q-
Quiet off, beeps on errors
XTP,XTPG,XTG
/R
XTree focuses on root directory after startup (applies to the first logged drive)
XTP,XTPG,XTG
/W
Skip small file window when Enter is pressed
XTP,XTPG,XTG
/WB
Skip small file window when Enter is pressed
XTP,XTPG,XTG
/WS
Goto small file window when Enter is pressed
XTP,XTPG,XTG
/XA
Start with Application menu first
XTG
/XE
Skip editor dialog from the file display
XTP,XTPG,XTG
/XK
Shell first switch (start with eXecute window)
XTG
/XQ
Don't prompt for quit
XTP,XTPG,XTG
/XS
Display real root of SUBSTituted drives (a must if you use SUBST)
XTP,XTPG,XTG
/XT
XTreePro compatible keyboard layout
XTG
/XU
Undo the /XT switch
XTG
/XX
Same as /XCEMPQS
XTP
/XJ
Same as /Z/2/A/C/K/PS/Q/W/XCEMPS
XTP
/Z
Restore factory default settings
XTP,XTPG,XTG
/Z.
Tells XTreeGold to pass file names without extensions to the user's editor with a period after the name. ie: "FILENAME."
XTG3
/ZF
Activates the last Filespec in the history instead of coming up with "*.*". This overrides all other command line file specs.
XTG25+
/ZT
Logs the last Treespec in the history. This overrides all other command line logging options.
XTG25+
 
 
 
 
vi. Path switches

 
 
 
 
/Hpath
Specify XTree(Pro)Gold path
XTP,XTPG,
XTG20,XTG25

/Upath
Specify user data file directory
XTPG,XTG
/Vfilename
Load static logged volume vm file (|see below)
XTPG14,XTG
 
 
 
 
vii. Special purpose switches

 
 
 
 
/ZS
Runs the XTreeGold program file XTG.EXE without the loader program XTGOLD.COM
Usage: XTG.EXE {drive:\path} {filespec} /ZS {/options}

XTG25+
 
 
 
 
 
 
 
Appendix i. Drive:\path options

 
drive:
XTreeGold logs to the specified drive, rather than the current one (e.g. "XTGOLD D:" logs to drive "D")
XTG25+
drive:.
OR drive:\

XTreeGold logs only the root directory of the specified drive, regardless the configured logging method
XTG25+
drive:\path
XTreeGold logs only the specified directory of the specified drive, regardless the configured logging method
XTG25+
\
XTreeGold logs only the root directory of the current drive, regardless the configured logging method
XTG25+
\path
XTreeGold logs only the specified directory of the current drive, regardless the configured logging method
XTG25+
.
XTreeGold focuses on the current directory after startup, even if "Initial highlighted directory = Root" is set in the ALT-F10 configuration program
XTG25+
..
XTreeGold focuses after startup on the parent directory of the current one
XTG25+
...
XTreeGold focuses after startup on the parent directory of the parent directory of the current one
NOTE: This behaviour is corresponding to the DOS "cd" command, so you can go up one additional directory level with each additional period. For example, "XTGOLD ...." will go up three levels in the directory tree from the current one. You can also move to a sibling directory, i.e. one that branches from the same parent directory as the current subdirectory (e.g. "XTGOLD ..\newdir" will focus on the directory "newdir" below the parent one of the current directory).

XTG25+
 
 
 
 
Appendix ii. Environment variables

 
 
SYNTAX:
  SET variable=value
  To reset, type: SET variable=
  (with nothing after the equal sign)

 
 
 
 
Variable
Function
Applies to
 
 
 
xtpro
Set command line switches (as listed above) for general use
XTP
xtgold
Set command line switches (as listed above) for general use
XTPG,XTG
xteditor
Specify text editor
XTPG,XTG
xtgtemp
Specify temporary directory used by XTG on archiving operations
XTG

 

EXAMPLES:
---------
 

XTGOLD.COM \DIR1 A: /2


- Log the directory "dir1" on the current drive
- Log the entire drive A:
- Use two column file display

 
XTGOLD.COM A: C: *.EXE *.COM /SS

- Log drives A: and C:
- Set filespec to *.EXE *.COM
- Sort files by size

 
SET XTGOLD=
SET XTGOLD=/A/PM
SET XTGTEMP=C:\WINDOWS\TEMP
XTGOLD.COM /UC:\XTGOLD\USERS\FIRST

- Reset all previous setting of the XTGOLD variable
- Always use an anchored tree cursor
- Always use 7bit print masking
- Set XTreeGold's temporary directory to C:\WINDOWS\TEMP
- Run XTreeGold and use the settings of "XTGOLD.CFG"
  from directory "C:\XTGOLD\USERS\FIRST"
  for the current session

 
 
 
 

More about the /V command line switch:
--------------------------------------

The /V command line option (/Vd:\path\filename) is not documented. This switch facilitates logging the tree and files of large static disk volumes such as removable cartridges and CD-ROMS.

Whenever you quit XTreeGold via the Alt+'Z'ip-to-DOS command, the currently logged directory and file information is always saved in a special file called "XTGOLD.TMP". Whenever XTreeGold starts it looks for XTGOLD.TMP, uses the information to provide for an instant startup, and then deletes the XTGOLD.TMP file.

The /V option tells XTreeGold to read the initial startup information from a different file, overriding the default XTGOLD.TMP. You create this startup file by having previously quit via Alt+Zip-to-DOS, and then renaming the XTGOLD.TMP file to some other file name (i.e. the name you will be specifying with the /V option). /V does NOT change the name of the file written to when quitting via Alt+Zip-to-DOS (this is always XTGOLD.TMP), only the name of the file read at startup.

As an example, let's say Gold is installed in directory C:\XTGOLD, and you have a CD-ROM drive "R:". The following batch file could be used to whenever you need to access the tree and files that are on the CD-ROM:

REM Start of Batch-file
REM .
REM Run XTreeGold, telling it to use CDROM.DAT for the startup data.
REM If XTreeGold cannot find this file, drive R: will be logged as normal.
C:\XTGOLD\XTGOLD R: /VC:\XTGOLD\CDROM.DAT
REM .
REM If the file XTGOLD.TMP was NOT created, then we must have used
REM the standard Quit command to exit XTreeGold, and we are done.
IF NOT EXIST C:\XTGOLD\XTGOLD.TMP GOTO DONE
REM .
REM We come here if we used Alt+Zip-to-DOS to exit XTreeGold.
REM Delete the CDROM.DAT file, because we are going to re-create it.
IF EXIST C:\XTGOLD\CDROM.DAT DEL C:\XTGOLD\CDROM.DAT
REM .
REM Change the name of the XTGOLD.TMP file (just created via
REM the Alt+Zip-to-DOS) to CDROM.DAT.
REN C:\XTGOLD\XTGOLD.TMP CDROM.DAT
REM .
REM (:DONE) this is where "GOTO DONE" comes
:DONE
REM .
REM End of Batch-file

The first time you run the batch file, Gold will not find CDROM.DAT and will fully log drive R: as normal. Exit Gold with Alt+Zip-to- DOS right away. This will create XTGOLD.TMP which will contain a directory of the logged volume. The batch file saves XTGOLD.TMP as the file CDROM.DAT. Now, whenever you run the batch file again, CDROM.DAT will be used as the startup file and you will have instant logging!
 
 
 

Abbreviations:
--------------
 
XTP      XTreePro (versions 0.x to 1.1)
XTPG     XTreeProGold (versions 1.0 to 1.4x)
XTPG131+  XTreeProGold versions 1.31 to 1.4x
XTPG14   XTreeProGold version 1.4x
XTG      XTreeGold (versions 2.0 to 3.0x)
XTG20    XTreeGold version 2.0
XTG25    XTreeGold version 2.5x
XTG25+   XTreeGold versions 2.50 to 3.0x
XTG3     XTreeGold version 3.0 or 3.01
 
(It may be helpful to have a look to the version history also) 
 
 
 
 
 
 


XTREE 2 COMMAND LINE OPTIONS
----------------------------

 

Configuring XTree 2 through the command line works somewhat different: it is exclusively configured by environment variables, which can be set for every XTree session with the DOS SET=... command, or just for a single XTree session.
 

SYNTAX:
-------

SET XTREE=option(s)

 (for every XTree session)

To reset, type: SET variable= (with nothing after the equal sign)

 or

XTREE drive: XTREE=option(s)

 (just for the current XTree session)
 

- drive: specifies the drive letter which XTree logs at startup

- option(s): specifies one or several options; each option is a single character. You may enter as many option characters as you like in a "XTREE=" entry. If no character is entered for a particular option, XTREE will assume the default setting of the option.


 
 

Option
Function
 
 
 "." 
Don't use period as file name separator, rather a blank
 "1" 
One column file display
 "2" 
Two column file display
 "3" 
Three column file display
 
 
 "N" 
Sort by name first, extension second
 "E" 
Sort by extension first, name second
 
 
 "B" 
Block cursor (default)
 "C" 
Color system underscore cursor
 "M" 
Monochrome system underscore cursor
 
 
 "K" 
Keep Filespec when performing another log command (Normally Filespec is set back to *.* on re-log)
 
 
 "L" 
Running XTREE on a Local Area Network system (disables XTREE's disk access optimization and insures that XTREE's memory image of the disk information is up to date.
 
 
 "P" 
Redirect the Print output to STDOUT (usually the screen) (Caution: If you redirect STDOUT to a disk file, don't use the eXecute function. You won't see the DOS prompts)

 

EXAMPLES:
---------
 

XTREE D: XTREE=.2CE


- Log to drive D: at startup
- Use color underscore cursor
- Sort files by Extension
- Use the two column file display
- Use a space instead of a period
- All other options use their default settings

 
SET XTREE=P3K

- Print to STDOUT
- Use the three column display
- Keep the Filespec on re-log

 
 
 
 
 

ZTREEWIN COMMAND LINE OPTIONS
-----------------------------

 

SYNTAX:
-------

ZTWIN.BAT drive\path filespec /options

(for drive:\path options see |Appendix)
 

NOTE:
- The settings determined by command line switches override the settings made by the configuration function.
- Reverse order or drive letter followed by a colon is equally valid.


 
 

Argument
Function
 
 
/2
25 line video mode
/3
34 line video mode
/4
43 line video mode
/5
50 line video mode
/6
60 line video mode
/?
Display available command line switches
/API
Use API copy function instead of internal
/DEB
Debug mode (for testing purposes, no particular function behind it)
/Eeditor
Specify editor (enter full path of editor right after /E)
/L1
Log 1st level only
/LF
Log method set to "full disk"
/LT
Log tree only
/M
Disable mouse support (ZTW 1.32i and later versions)
/NC
Prevents new console (for telnet use)
/O
Disable OEM conversion of file/pathnames (ZTW 1.40h and later versions)
/OD
Sort descending
/SD
Sort by date
/SE
Sort by extension
/SS
Sort by size
/SU
Unsorted display
/Vviewer
Specify viewer (enter full path of viewer right after /V)
/XT
XTreePro compatible keyboard layout (+/-)
/Y
Prevents screen restore (for shortcut)
/ZF
Activates the last Filespec in the history instead of starting with "*.*"
/ZP
Progress bar time display. This command line switch enables time displays on the progress bar. When activated, two times are displayed. The first is the time in Minutes:Seconds that the function has taken so far. The second time is an estimate of time remaining based on the percentage complete and the accumulated time.
/ZT
Logs the last Treespec in the history
 
 
 
Appendix: drive:\path options
 
 
drive
OR drive:

ZTree logs to the specified drive, rather than the current one (e.g. "ZTWIN D" logs to drive "D")
drive.
OR drive:.
OR drive\
OR drive:\

ZTree logs only the root directory of the specified drive, regardless the configured logging method
drive\path
OR drive:\path

ZTree logs only the specified directory of the specified drive, regardless the configured logging method
\
ZTree logs only the root directory of the current drive, regardless the configured logging method
\path
ZTree logs only the specified directory of the current drive, regardless the configured logging method

 

EXAMPLES:
---------
 

ZTWIN.BAT /5 /XT C D E F


- Startup in 50 line mode
- Use +/- keys for drive toggle
- Log drives C, D, E & F

 
 
 
 
---<>---
 
 
 
 
 

Any comments, questions, suggestions, new recipes,
    anything missing or anything not working as described on your system ?
        ---> Then please post your message to the XTree Forum

 
 
 


Last updated 08-21-05
---
XTree and XTreeGold are registered trademarks of Symantec Inc.
Windows and Windows95 are registered trademarks of Microsoft Corporation.

FILE COMMANDS:  Directory_view Previous_file     Next_file small_Font   /Help |Top_of_page