Struct ManpagesConfig 

pub struct ManpagesConfig {
    pub generate: Option<String>,
    pub from_build_out: Option<String>,
    pub copy: Option<String>,
    pub dst: Option<String>,
}

Man-page generation for an archive entry.

Same three mutually-exclusive modes as CompletionsConfig, minus the per-shell shells axis (man pages are shell-agnostic).

YAML examples:

manpages:
  generate: "{{ ArtifactPath }} --man"     # mode A
  dst: "man/man1/"
# mode B: from_build_out: "**/out/{{ Binary }}.1"
# mode C: copy: "man/*.1"

Fields

generate: Option<String>

Mode A: command run once on the host-native binary; stdout is captured into a single man file under dst named <binary>.1.

from_build_out: Option<String>

Mode B: per-target glob harvesting man files a build.rs wrote into the crate’s OUT_DIR (e.g. "**/out/{{ Binary }}.1").

copy: Option<String>

Mode C: glob/path of committed man files to copy verbatim.

dst: Option<String>

Destination directory inside the archive (and dist staging tree) for the generated man files. Defaults to "man/man1/".

Implementations

impl ManpagesConfig

pub const DEFAULT_DST: &'static str = "man/man1/"

Default destination directory inside the archive.

pub fn mode(&self) -> GenMode<'_>

Resolve which generation mode (if any) this block selects.

pub fn resolved_dst(&self) -> &str

Resolve the destination directory, falling back to Self::DEFAULT_DST.

Trait Implementations

impl Clone for ManpagesConfig

fn clone(&self) -> ManpagesConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ManpagesConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ManpagesConfig

fn default() -> ManpagesConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ManpagesConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ManpagesConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ManpagesConfig

fn eq(&self, other: &ManpagesConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ManpagesConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ManpagesConfig