:orphan: # PetscHelpPrintf Prints help messages. ## Synopsis ``` #include PetscErrorCode (*PetscHelpPrintf)(MPI_Comm comm, const char format[],args); ``` Not Collective, only applies on MPI rank 0; No Fortran Support ## Input Parameters - ***comm -*** the MPI communicator over which the help message is printed - ***format -*** the usual printf() format string - ***args -*** arguments to be printed ## Note You can change how help messages are printed by replacing the function pointer with a function that does not simply write to stdout. To use, write your own function, for example, ```none PetscErrorCode mypetschelpprintf(MPI_Comm comm,const char format[],....) { PetscFunctionReturn(PETSC_SUCCESS); } ``` then do the assignment ```none PetscHelpPrintf = mypetschelpprintf; ``` You can do the assignment before `PetscInitialize()`. The default routine used is called `PetscHelpPrintfDefault()`. ## See Also `PetscFPrintf()`, `PetscSynchronizedPrintf()`, `PetscErrorPrintf()`, `PetscHelpPrintfDefault()` ## Level developer ## Location include/petscsys.h --- [Edit on GitLab](https://gitlab.com/petsc/petsc/-/edit/release/include/petscsys.h) [Index of all Sys routines](index.md) [Table of Contents for all manual pages](/manualpages/index.md) [Index of all manual pages](/manualpages/singleindex.md)