summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/expanduser.yml
blob: 2aff468777ae701c035f356a626551f0097bc42d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
DOCUMENTATION:
  name: basename
  author: ansible core team
  version_added: "1.5"
  short_description: Returns a path with C(~) translation.
  description:
    - Translates C(~) in a path to the proper user's home directory.
  options:
    _input:
      description: A string that contains a path.
      type: path
      required: true
EXAMPLES: |

  # To get '/home/myuser/stuff.txt' from '~/stuff.txt'.
  {{ mypath | expanduser }}

RETURN:
  _value:
    description: The translated path.
    type: path