KanaLock

0.1.0

en-US/KanaLock.dll-Help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" schema="maml" xmlns="http://msh">

  <command:command>

    <command:details>

      <command:name>Disable-KanaLock</command:name>

      <maml:description>

        <maml:para>Turns kana lock off.</maml:para>

      </maml:description>

      <command:verb>Disable</command:verb>

      <command:noun>KanaLock</command:noun>

    </command:details>

    <maml:description>

      <maml:para>Sends one kana key press when kana lock is on; does nothing when it is already off.

A 101-key keyboard has no kana key, so kana lock cannot be cleared by hand there.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Disable-KanaLock</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters />

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>You can't pipe objects to this cmdlet.</maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>This cmdlet returns no output.</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>The state read and changed is that of the interactive desktop. Behaviour in session 0 (services, scheduled tasks, CI runners) is unspecified.</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>--------- Example 1: Turn kana lock off ---------</maml:title>

        <maml:introduction>

          <maml:para>```powershell

Disable-KanaLock

Get-KanaLock

```</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>`Get-KanaLock` then returns `$false`.</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version</maml:linkText>

        <maml:uri>https://github.com/ShortArrow/KanaLock/blob/main/docs/cmdlets/KanaLock/Disable-KanaLock.md</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Get-KanaLock</maml:linkText>

        <maml:uri>Get-KanaLock.md</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Enable-KanaLock</maml:linkText>

        <maml:uri>Enable-KanaLock.md</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

  <command:command>

    <command:details>

      <command:name>Enable-KanaLock</command:name>

      <maml:description>

        <maml:para>Turns kana lock on.</maml:para>

      </maml:description>

      <command:verb>Enable</command:verb>

      <command:noun>KanaLock</command:noun>

    </command:details>

    <maml:description>

      <maml:para>Sends one kana key press when kana lock is off; does nothing when it is already on.

Use it to reproduce the half-width kana symptom on demand, for example to check that `Disable-KanaLock` clears it.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Enable-KanaLock</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters />

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>You can't pipe objects to this cmdlet.</maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>This cmdlet returns no output.</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>The state read and changed is that of the interactive desktop. Behaviour in session 0 (services, scheduled tasks, CI runners) is unspecified.</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>--------- Example 1: Turn kana lock on ---------</maml:title>

        <maml:introduction>

          <maml:para>```powershell

Enable-KanaLock

Get-KanaLock

```</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>`Get-KanaLock` then returns `$true`.</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version</maml:linkText>

        <maml:uri>https://github.com/ShortArrow/KanaLock/blob/main/docs/cmdlets/KanaLock/Enable-KanaLock.md</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Get-KanaLock</maml:linkText>

        <maml:uri>Get-KanaLock.md</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Disable-KanaLock</maml:linkText>

        <maml:uri>Disable-KanaLock.md</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

  <command:command>

    <command:details>

      <command:name>Get-KanaLock</command:name>

      <maml:description>

        <maml:para>Returns whether kana lock is on.</maml:para>

      </maml:description>

      <command:verb>Get</command:verb>

      <command:noun>KanaLock</command:noun>

    </command:details>

    <maml:description>

      <maml:para>With kana lock (VK_KANA) on, a field that turns the IME off, such as a password field or pinentry's passphrase prompt, receives letters as half-width kana: `test` arrives as `ｶｲﾄｶ`. The IME indicator still shows half-width alphanumeric.

`Get-KanaLock` returns `$true` when kana lock is on and `$false` when it is off.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-KanaLock</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters />

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>You can't pipe objects to this cmdlet.</maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Boolean</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>`$true` when kana lock is on; otherwise `$false`.</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>The state read and changed is that of the interactive desktop. Behaviour in session 0 (services, scheduled tasks, CI runners) is unspecified.</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>--------- Example 1: Check the state ---------</maml:title>

        <maml:introduction>

          <maml:para>```powershell

Get-KanaLock

```</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>Returns `$true` or `$false`.</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

      <command:example>

        <maml:title>--------- Example 2: Warn from a profile ---------</maml:title>

        <maml:introduction>

          <maml:para>```powershell

if (Get-KanaLock) { Write-Warning 'kana lock is on; run Disable-KanaLock' }

```</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>Warns at shell start before a passphrase is mistyped.</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version</maml:linkText>

        <maml:uri>https://github.com/ShortArrow/KanaLock/blob/main/docs/cmdlets/KanaLock/Get-KanaLock.md</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Enable-KanaLock</maml:linkText>

        <maml:uri>Enable-KanaLock.md</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Disable-KanaLock</maml:linkText>

        <maml:uri>Disable-KanaLock.md</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>