# popy doc

For convenient access to PoPy’s documentation, Open a PoPy Command Prompt and type:-

    popy doc

This opens the main_index HTML documentation page.

## Examples

You can access the online documentation as follows (default is locally installed .html files):-

    popy doc -o

Alternatively you can open documentation for a specific tool (e.g., popy run) with the -t or –tool option:-

    popy doc --tool run

You can also open documentation for specific Script File Formats (e.g., a Fit Script) with the -s or –script option:-

    popy doc --script fit

## Command line options

    usage: popy_doc [-h] [--online]
                    [--script {none,tut,gen,fit,comp,sim,tutsum,gensum,fitsum,mtut,mgen,mfit,mcomp,msim,grph,vpc,table,val,merge}]
                    [--tool {none,activate,deactivate,info,create,edit,run,check,format,doc,env}]

    Opens PoPy html documentation in web browser.

    options:
      -h, --help            show this help message and exit
      --online              Optionally access online documentation instead of
                            local.
      --script {none,tut,gen,fit,comp,sim,tutsum,gensum,fitsum,mtut,mgen,mfit,mcomp,msim,grph,vpc,table,val,merge}
                            Optionally open documentation for a specific script
                            type.
      --tool {none,activate,deactivate,info,create,edit,run,check,format,doc,env}
                            Optionally open documentation for a specific PoPy tool