docs: add explanations of OB_RANDOM_SEED environment variable

openbabel · Sep 28, 2022 · 5a038b9 · 5a038b9
1 parent 23f42ff
commit 5a038b9
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/doc/obabel.1 b/doc/obabel.1
@@ -520,6 +520,13 @@ For further specific information and options, use
 .Fl H Ar format-type ,
 e.g.,
 .Fl Hcml
+.Sh ENVIRONMENT
+.Bl -tag -width flag
+.It Ev OB_RANDOM_SEED
+Seed for pseudo random number generator; random seed is used if unset or null.
+This feature is effective if Open Babel is built with \fI-DOB_USE_OBRANDOMMT\fP cpreprocessor flag
+(will be automatically enabled when version 4 is released).
+.El
 .Sh EXAMPLES
 Standard conversion:
 .Dl "obabel ethanol.xyz \-Oethanol.pdb"

diff --git a/doc/obdistgen.1 b/doc/obdistgen.1
@@ -9,6 +9,13 @@
 .Ar filename
 .Sh DESCRIPTION
 Generates SDFs with distance geometry.
+.Sh ENVIRONMENT
+.Bl -tag -width flag
+.It Ev OB_RANDOM_SEED
+Seed for pseudo random number generator; random seed is used if unset or null.
+This feature is effective if Open Babel is built with \fI-DOB_USE_OBRANDOMMT\fP cpreprocessor flag
+(will be automatically enabled when version 4 is released).
+.El
 .Sh EXAMPLES
 .Dl "obdistgen molecule.smi > molecule.sdf"
 .Pp

diff --git a/doc/obgen.1 b/doc/obgen.1
@@ -24,6 +24,13 @@ will give all options including the available forcefields.
 .It Fl ff Ar forcefield
 Select the forcefield
 .El
+.Sh ENVIRONMENT
+.Bl -tag -width flag
+.It Ev OB_RANDOM_SEED
+Seed for pseudo random number generator; random seed is used if unset or null.
+This feature is effective if Open Babel is built with \fI-DOB_USE_OBRANDOMMT\fP cpreprocessor flag
+(will be automatically enabled when version 4 is released).
+.El
 .Sh EXAMPLES
 .Pp
 View the possible options, including available forcefields:

diff --git a/doc/obrotamer.1 b/doc/obrotamer.1
@@ -17,6 +17,13 @@ rotamers are not conformers -- that is,
 does not perform geometry optimization after generating the rotamer
 structure. The obminimize tool can do geometry optimization using
 molecular mechanics.
+.Sh ENVIRONMENT
+.Bl -tag -width flag
+.It Ev OB_RANDOM_SEED
+Seed for pseudo random number generator; random seed is used if unset or null.
+This feature is effective if Open Babel is built with \fI-DOB_USE_OBRANDOMMT\fP cpreprocessor flag
+(will be automatically enabled when version 4 is released).
+.El
 .Sh EXAMPLES
 .Dl "obrotamer baseconformer.sdf > rotamer1.sdf"
 .Pp