Files
lammps/doc/rst/include.rst
Richard Berger 574e4067dc Add documentation files in RST format
This is the first step for moving the documentation format from *.txt to the
*.rst format.

In the last years we've been automatically converting txt files from Steve's
markup into RST to generate the documentation pages via Sphinx. The decision
has now been made to fully migrate to RST and avoid the conversion in the
future.

This will enable us to fully use RST and Sphinx to improve the documentation.

For the intermediate period, while there are still pending PRs with
documentation changes, we will keep both source files and update the RST files
accordingly.
2019-08-22 14:11:32 -06:00

53 lines
928 B
ReStructuredText

.. index:: include
include command
===============
Syntax
""""""
.. parsed-literal::
include file
* file = filename of new input script to switch to
Examples
""""""""
.. parsed-literal::
include newfile
include in.run2
Description
"""""""""""
This command opens a new input script file and begins reading LAMMPS
commands from that file. When the new file is finished, the original
file is returned to. Include files can be nested as deeply as
desired. If input script A includes script B, and B includes A, then
LAMMPS could run for a long time.
If the filename is a variable (see the :doc:`variable <variable>`
command), different processor partitions can run different input
scripts.
Restrictions
""""""""""""
none
Related commands
""""""""""""""""
:doc:`variable <variable>`, :doc:`jump <jump>`
**Default:** none
.. _lws: http://lammps.sandia.gov
.. _ld: Manual.html
.. _lc: Commands_all.html