File: ssh_path.Rd

package info (click to toggle)
r-cran-git2r 0.31.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 2,288 kB
  • sloc: ansic: 8,283; sh: 4,116; makefile: 4
file content (34 lines) | stat: -rw-r--r-- 854 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/credential.R
\name{ssh_path}
\alias{ssh_path}
\title{Compose usual path to ssh keys}
\usage{
ssh_path(file = "")
}
\arguments{
\item{file}{basename of file for which path is requested}
}
\value{
Full path to the file
}
\description{
This function provides a consistent means across OS-types to access the
\code{.ssh} directory.
}
\details{
On Windows-based systems,
\code{path.expand("~")} returns \code{"C:/Users/username/Documents"},
whereas the usual path to the \code{.ssh} directory is
\code{"C:/Users/username"}.

On other operating systems, \code{path.expand("~")} returns the usual path
to the \code{.ssh} directory.

Calling \code{ssh_path()} with no arguments will return the usual path to
the \code{.ssh} directory.
}
\examples{
ssh_path()
ssh_path("is_rsa.pub")
}