sampleconfig

README

sampleconfig

Package sampleconfig provides functions that return the contents of sample configuration files for dcrd and dcrctl. This is provided for tools that perform automatic configuration and would like to ensure the generated configuration files not only include the specifically configured values, but also provides samples of other configuration options.

Installation and Updating

This package is part of the github.com/decred/dcrd module. Use the standard go tooling for working with modules to incorporate it.

License

Package sampleconfig is licensed under the copyfree ISC License.

Documentation

Overview

Package sampleconfig provides a single function that returns the contents of the sample configuration file for dcrd. This is provided for tools that perform automatic configuration and would like to ensure the generated configuration file not only includes the specifically configured values, but also provides samples of other configuration options.

Index

• Variables
• func Dcrctl() string
• func Dcrd() string
• func FileContents() string

Variables

var DcrctlSampleConfig = Dcrctl()

DcrctlSampleConfig is a string containing the commented example config for dcrctl.

Deprecated: Use the Dcrctl function instead.

Functions

func Dcrctl

func Dcrctl() string

Dcrctl returns a string containing the commented example config for dcrctl.

func Dcrd

func Dcrd() string

Dcrd returns a string containing the commented example config for dcrd.

func FileContents

func FileContents() string

FileContents returns a string containing the commented example config for dcrd.

Deprecated: Use the Dcrd function instead.