rename "zip" functions to "compress" functions. update related docs
This commit is contained in:
@ -4420,15 +4420,16 @@ int lammps_config_has_mpi_support()
|
||||
|
||||
/* ---------------------------------------------------------------------- */
|
||||
|
||||
/** Check if the LAMMPS library supports compressed files via a pipe to gzip
|
||||
/** Check if the LAMMPS library supports reading or writing compressed
|
||||
* files via a pipe to gzip or similar compression programs
|
||||
|
||||
\verbatim embed:rst
|
||||
Several LAMMPS commands (e.g. :doc:`read_data`, :doc:`write_data`,
|
||||
:doc:`dump styles atom, custom, and xyz <dump>`) support reading and
|
||||
writing compressed files via creating a pipe to the ``gzip`` program.
|
||||
This function checks whether this feature was :ref:`enabled at compile
|
||||
time <gzip>`. It does **not** check whether the ``gzip`` itself is
|
||||
installed and usable.
|
||||
time <gzip>`. It does **not** check whether``gzip`` or any other
|
||||
supported compression programs themselves are installed and usable.
|
||||
\endverbatim
|
||||
*
|
||||
* \return 1 if yes, otherwise 0
|
||||
|
||||
Reference in New Issue
Block a user