// Copyright (c) 2019, Intel Corporation.
// SPDX-License-Identifier: BSD-3-Clause

ifdef::manpage[]
ipmctl-show-preferences(1)
==========================
endif::manpage[]

NAME
----
ipmctl-show-preferences - Displays a list of the PMem module software user preferences

SYNOPSIS
--------
[listing]
ipmctl show [OPTIONS] -preferences

DESCRIPTION
-----------
Displays a list of the PMem module software user preferences and their current values.

OPTIONS
-------
-h::
-help::
  Displays help for the command.

-ddrt::
  Used to specify DDRT as the desired transport protocol for the current invocation of ipmctl.

-smbus::
  Used to specify SMBUS as the desired transport protocol for the current invocation of ipmctl.

NOTE: The -ddrt and -smbus options are mutually exclusive and may not be used together.

ifdef::os_build[]
-o (text|nvmxml)::
-output (text|nvmxml)::
  Changes the output format. One of: "text" (default) or "nvmxml".
endif::os_build[]

EXAMPLES
--------
Displays the current values for all the user preferences.
[listing]
ipmctl show -preferences

RETURN DATA
-----------
CLI_DEFAULT_DIMM_ID::
  The default display of PMem module identifiers. One of:
  - UID: Use the DimmUID attribute as defined in the command Show Device.
  - HANDLE: Use the DimmHandle attribute as defined in the command Show Device.
    This is the default.

CLI_DEFAULT_SIZE::
  The default display of capacities in the CLI. One of:
  - AUTO: Automatically choose the best format for each capacity in binary
    multiples of bytes (i.e., B, MiB, GiB or TiB). This is the default.
  - AUTO_10: AUTO_10: Automatically choose the best format for each capacity in
    decimal multiples of bytes (i.e., B, MB, GB or TB).
  - B: Displays all capacities in bytes.
  - MB: Displays all capacities in megabytes.
  - MiB: Displays all capacities in mebibytes.
  - GB: Displays all capacities in gigabytes.
  - GiB: Displays all capacities in gibibytes.
  - TB: Displays all capacities in terabytes.
  - TiB: Displays all capacities in tebibytes.

APPDIRECT_SETTINGS::
  The interleave settings to use when creating App Direct capacity in the
  format: (IMCSize_ChannelSize). The default is "RECOMMENDED" which uses the
  BIOS recommended App Direct settings returned by the command Show System
  Capabilities.

ifdef::os_build[]
DBG_LOG_LEVEL::
  Whether debug logging is enabled in the PMem module host software. These logs
  pertain to the operation of the command-line tool only and do not reflect any
  logging functionality of the PMem module. One of:
  - 0: Logging is disabled. This is the default.
  - 1: Log Errors.
  - 2: Log Warnings, Errors.
  - 3: Log Informational, Warnings, Errors.
  - 4: Log Verbose, Informational, Warnings, Errors.
endif::os_build[]
