---
name: "sparkformat"
section: "1"
platform: "linux"
package: "spark"
version: "2012.0.deb-11+b2"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/sparkformat"
---

# sparkformat(1)

pretty-prints SPARK annotations

## NAME

sparkformat - pretty-prints SPARK annotations

## SYNOPSIS

**sparkformat**  \[OPTIONS\] \[ FILE\_LIST or @METAFILE  \]

## DESCRIPTION

This manual page only summarises the **sparkformat** command-line flags, please refer to the full SPARKFormat manual for further information.

## OPTIONS

These options do not quite follow the usual GNU command line syntax. All options start with a single dash instead of the usual two and they can also be abbreviated, as long as the abbreviation is unique. For example FC**-expand**F\[0\] can be abbreviated to FC**-expa**F\[0\] but not FC**-exp**F\[0\] as this clashes with FC**-export\_indent**F\[0\].

- FC**-help**F\[0\]

  Display command-line help.

- FC**-version**F\[0\]

  Display version information.

- FC**-add\_modes**F\[0\], FC**-noadd\_modes**F\[0\]

  Add modes to unmoded global variables. By default we do not do this.

- FC**-annotation\_character=**F\[0\]*CHAR*

  Select alternative annotation character. The default is '#'.

- FC**-compress**F\[0\], FC**-expand**F\[0\]

  Comress or expand the dependency relations. The default is to compress.

- FC**-default\_function\_modes=**F\[0\]*MODE*

  When used in conjunction with FC**-add\_modes**F\[0\], force global variables of functions to the specified default function mode. The available default function modes are 'in\_mode' and 'unmoded', and may be abbreviated to 'i' and 'u' respectively.

- FC**-export\_indent=**F\[0\]*MODE*, FC**-global\_indent=**F\[0\]*MODE*, FC**-import\_indent=**F\[0\]*MODE*, FC**-inherit\_indent=**F\[0\]*MODE*, FC**-initialization\_indent=**F\[0\]*MODE*, FC**-own\_indent=**F\[0\]*MODE*, FC**-separator\_indent=**F\[0\]*MODE*, FC**-properties\_indent=**F\[0\]*MODE*

  Specifies the degree of indentation from '--#' or keeps them inline (the default). MODE can be either a number or 'inline'.

## SEE ALSO

[spark(1)](/spark/1.md), [sparksimp(1)](/sparksimp/1.md), [spadesimp(1)](/spadesimp/1.md), [zombiescope(1)](/zombiescope/1.md), [victor(1)](/victor/1.md), [pogs(1)](/pogs/1.md)

[sparkmake(1)](/sparkmake/1.md)

## AUTHOR

This manual page was written by Florian Schanda \<FCflorian.schanda@altran-praxis.comF\[0\]\> for the *Debian GNU/Linux* system (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts.