Webgenz
  Product Overview News & Events Support

 

Command Line


Webgenz CMS can be called using a command line interface as described below.

Syntax:

     webgenz /project=project_file /mode=mode /window=window_state /document-root=document_root /modified-only=modified_only /command=command
     

where:

  • "project_file" is the path name of any Webgenz CMS Project file.
    This parameter is required.

  • "mode" is "1" or "2"
    1 means "automatically generate the project when Webgenz CMS starts"
    2 means "automatically generate the project when Webgenz CMS starts and exit Webgenz CMS when the generation is complete"
    This parameter is required.

  • "window_state" is "0" or "1"
    0 displays the Webgenz CMS window in a normal state
    1 displays the Webgenz CMS window in a minimized state
    This parameter is optional and will default to "0".

  • "document_root" is the root path to which Documents will be generated.
    This parameter is optional and will default to the Document Root Path specified for the Project.
    Note: if this parameter is used, it will override the Document Root Path specified for the Project just during the one-time generation triggered from the command line.

  • "modified_only" is "0" or "1"
    0 generates all Documents
    1 generates only modified Documents
    This parameter is optional and will default to the Generate Modified Documents Only setting in Webgenz CMS.
    Note: if this parameter is used, it will override the Generate Modified Documents Only setting just during the one-time generation triggered from the command line.

  • "command" is the name of a program to execute after the project is automatically generated. This can be used to string batch files together (i.e. call Webgenz CMS from one batch file and then have Webgenz CMS call the next batch file).
    This parameter is optional.

Examples:

     c:\webgenz.exe /project=c:\test.web /mode=2 /window=1 /command=c:\go.bat
     
     c:\webgenz.exe /project=c:\test2.web /mode=1 /window=0 /document-root=c:\site\public_html\ /modified-only=0
     

Notes:

  • Using the command line interface you can call Webgenz CMS from a batch file (for example, a build script). However, the generation of the Webgenz project may occur in a manner which is asynchronous to the batch file. In other words, the Webgenz CMS program is launched, but the batch file may keep executing. If this is undesirable, you can use the "command" option on the Webgenz CMS command line (as described above) to string batch files together.
Copyright 1997-2003. All rights reserved. Webgenz is a trademark. Last updated: Monday, March 08, 2004